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

✨ Add option to generate unicode values in object #5010

Merged
merged 3 commits into from
May 22, 2024

Conversation

dubzzz
Copy link
Owner

@dubzzz dubzzz commented May 22, 2024

Description

Recent bugs found in Vitest around badly formed snapshot names would have benefit from having a built-in way to switch on unicode generation on object and anything.

The proposed PR adds a new flag onto them. It allows users to force generation of unicode strings as keys and values of the instances produced by these two helpers. The flag is called withUnicodeString.

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: ✨ Introduce new features
  • Impacts: N.A.

Copy link

codesandbox-ci bot commented May 22, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Copy link
Contributor

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

Copy link

codecov bot commented May 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.87%. Comparing base (927e173) to head (c9915d1).
Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5010   +/-   ##
=======================================
  Coverage   96.87%   96.87%           
=======================================
  Files         213      213           
  Lines       16296    16311   +15     
  Branches     2667     2668    +1     
=======================================
+ Hits        15787    15802   +15     
  Misses        509      509           
Flag Coverage Δ
unit-tests 96.87% <100.00%> (+<0.01%) ⬆️
unit-tests-18.x-Linux 96.87% <100.00%> (+<0.01%) ⬆️
unit-tests-20.x-Linux 96.87% <100.00%> (+<0.01%) ⬆️
unit-tests-22.x-Linux 96.87% <100.00%> (+<0.01%) ⬆️
unit-tests-latest-Linux 96.87% <100.00%> (+<0.01%) ⬆️

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.

@dubzzz dubzzz merged commit 50394c8 into main May 22, 2024
76 checks passed
@dubzzz dubzzz deleted the genrate-unicode-from-objects branch May 22, 2024 18:22
dubzzz added a commit that referenced this pull request May 22, 2024
**Description**

Same idea as for #5010 but extended to `json` and `jsonValue`.

With this new flag, we also deprecate unicode versions as they don't
need to live on their own anymore. As such they can just be replaced by
the default version. The flag is by default to true but will be moved to
false in v4.

<!-- Please provide a short description and potentially linked issues
hustifying 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: ✨ Introduce new features
- [x] Impacts: Deprecate arbitraries

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