Skip to content

Commit

Permalink
🗑️ Deprecate uuidV in favor of uuid (#5189)
Browse files Browse the repository at this point in the history
**Description**

Deprecating `uuidV` in favor of `uuid`. No need to have both now that
`uuid` also offers ways to customize the generated versions (see #5188).

<!-- Please provide a short description and potentially linked issues
justifying the need for this PR -->

<!-- * Your PR is fixing a bug or regression? Check for existing issues
related to this bug and link them -->
<!-- * Your PR is adding a new feature? Make sure there is a related
issue or discussion attached to it -->

<!-- You can provide any additional context to help into understanding
what's this PR is attempting to solve: reproduction of a bug, code
snippets... -->

**Checklist** — _Don't delete this checklist and make sure you do the
following before opening the PR_

- [x] The name of my PR follows [gitmoji](https://gitmoji.dev/)
specification
- [x] My PR references one of several related issues (if any)
- [x] New features or breaking changes must come with an associated
Issue or Discussion
- [x] My PR does not add any new dependency without an associated Issue
or Discussion
- [x] My PR includes bumps details, please run `yarn bump` and flag the
impacts properly
- [x] My PR adds relevant tests and they would have failed without my PR
(when applicable)

<!-- More about contributing at
https://github.com/dubzzz/fast-check/blob/main/CONTRIBUTING.md -->

**Advanced**

<!-- How to fill the advanced section is detailed below! -->

- [x] Category: Deprecate code
- [x] Impacts: Will be dropped on next major

<!-- [Category] Please use one of the categories below, it will help us
into better understanding the urgency of the PR -->
<!-- * ✨ Introduce new features -->
<!-- * 📝 Add or update documentation -->
<!-- * ✅ Add or update tests -->
<!-- * 🐛 Fix a bug -->
<!-- * 🏷️ Add or update types -->
<!-- * ⚡️ Improve performance -->
<!-- * _Other(s):_ ... -->

<!-- [Impacts] Please provide a comma separated list of the potential
impacts that might be introduced by this change -->
<!-- * Generated values: Can your change impact any of the existing
generators in terms of generated values, if so which ones? when? -->
<!-- * Shrink values: Can your change impact any of the existing
generators in terms of shrink values, if so which ones? when? -->
<!-- * Performance: Can it require some typings changes on user side?
Please give more details -->
<!-- * Typings: Is there a potential performance impact? In which cases?
-->
  • Loading branch information
dubzzz authored Aug 6, 2024
1 parent 868f9b1 commit 9538ee1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 1 deletion.
8 changes: 8 additions & 0 deletions .yarn/versions/4e97eaaf.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
releases:
fast-check: minor

declined:
- "@fast-check/ava"
- "@fast-check/jest"
- "@fast-check/vitest"
- "@fast-check/worker"
1 change: 1 addition & 0 deletions packages/fast-check/src/arbitrary/uuidV.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { paddedEightsToUuidMapper, paddedEightsToUuidUnmapper } from './_interna
*
* No mixed case, only lower case digits (0-9a-f)
*
* @deprecated Prefer using {@link uuid}
* @remarks Since 1.17.0
* @public
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ UUID values for a specific UUID version (only 1 to 15) only digits in 0-9a-f.

**Signatures:**

- `fc.uuidV(version)`
- `fc.uuidV(version)`_deprecated since v3.21.0 ([#5103](https://github.com/dubzzz/fast-check/issues/5103))_

**with:**

Expand Down

0 comments on commit 9538ee1

Please sign in to comment.