Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

💥 Drop deprecated unicodeJson* arbitraries #5613

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

💥 Drop deprecated unicodeJson* arbitraries #5613

wants to merge 2 commits into from

Conversation

dubzzz
Copy link
Owner

@dubzzz dubzzz commented Jan 14, 2025

Description

💥 Breaking change

These arbitraries have been marked as deprecated in version 3.19.0 of fast-check. As such since version 3.19.0, the recommanded alternatives are:

  • unicodeJson() -> json()
  • unicodeJsonValue() -> jsonValue()

Note: That PR depends on the fact that we already made unicode values the default for json and jsonValue. It depends on #5030.

ChecklistDon't delete this checklist and make sure you do the following before opening the PR

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

Advanced

  • Category: 💥 Breaking change
  • Impacts: Dropped arbitrary

**Description**

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

**💥 Breaking change**

These arbitraries have been marked as deprecated in version 3.19.0 of
fast-check. As such since version 3.19.0, the recommanded alternatives
are:

- `unicodeJson()` -> `json()`
- `unicodeJsonValue()` -> `jsonValue()`

Note: That PR depends on the fact that we already made unicode values
the default for `json` and `jsonValue`. It depends on
#5030.

<!-- * 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: 💥 Breaking change
- [x] Impacts: Dropped arbitrary

<!-- [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?
-->
Copy link

changeset-bot bot commented Jan 14, 2025

🦋 Changeset detected

Latest commit: 93773a8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages
Name Type
fast-check Major
@fast-check/ava Patch
@fast-check/jest Patch
@fast-check/vitest Patch
@fast-check/worker Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

pkg-pr-new bot commented Jan 14, 2025

Open in Stackblitz@fast-check/examples

@fast-check/ava

npm i https://pkg.pr.new/@fast-check/ava@5613

@fast-check/expect-type

npm i https://pkg.pr.new/@fast-check/expect-type@5613

fast-check

npm i https://pkg.pr.new/fast-check@5613

@fast-check/jest

npm i https://pkg.pr.new/@fast-check/jest@5613

@fast-check/packaged

npm i https://pkg.pr.new/@fast-check/packaged@5613

@fast-check/poisoning

npm i https://pkg.pr.new/@fast-check/poisoning@5613

@fast-check/vitest

npm i https://pkg.pr.new/@fast-check/vitest@5613

@fast-check/worker

npm i https://pkg.pr.new/@fast-check/worker@5613

commit: 93773a8

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.82%. Comparing base (40a23e1) to head (93773a8).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5613      +/-   ##
==========================================
+ Coverage   94.77%   94.82%   +0.04%     
==========================================
  Files         235      233       -2     
  Lines       10034    10025       -9     
  Branches     2825     2825              
==========================================
- Hits         9510     9506       -4     
+ Misses        524      519       -5     
Flag Coverage Δ
unit-tests 94.82% <ø> (+0.04%) ⬆️
unit-tests-18.x-Linux 94.80% <ø> (+0.02%) ⬆️
unit-tests-20.x-Linux 94.80% <ø> (+0.02%) ⬆️
unit-tests-22.x-Linux 94.82% <ø> (+0.04%) ⬆️
unit-tests-latest-Linux 94.80% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

👋 A preview of the new documentation is available at: http://6786c73d60e039ebac2eb42b--dubzzz-fast-check.netlify.app

@dubzzz dubzzz changed the title 💥 Drop deprecated unicodeJson* arbitraries (#5029) 💥 Drop deprecated unicodeJson* arbitraries Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant