💥 Drop deprecated hexa*

[dubzzz]

Description

The arbitraries hexa and hexaString have been marked for deprecation since version 3.22.0.

They are now being fully dropped.

If you still want to rely on something behaving this way we recommend you to use the following constructs:

const items = '0123456789abcdef';
function hexa(): fc.Arbitrary<string> {
  return fc.integer({ min: 0, max: 15 }).map(n => items[n]);
}
function hexaString(constraints: fc.StringConstraints = {}): fc.Arbitrary<string> {
  return fc.string({ ...constraints, unit: hexa() });
}

Or even more accurate

function hexa(): fc.Arbitrary<string> {
  return fc.integer({ min: 0, max: 15 }).map(
    (n) => items[n],
    (c) => {
      if (typeof c !== 'string') {
        throw new Error('Not a string');
      }
      const index = items.indexOf(c);
      if (index === -1) {
        throw new Error('Unknown "char"');
      }
      return index;
    },
  );
}

// Or shorter

function hexa(): fc.Arbitrary<string> {
  return fc.integer({ min: 0, max: 15 }).map(
    (n) => items[n],
    (c) => items.indexOf(c),
  );
}

Checklist — Don'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 arbitraries

[changeset-bot]

🦋 Changeset detected

Latest commit: effa0f3

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

[pkg-pr-new]

Open in Stackblitz • @fast-check/examples

@fast-check/ava

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

fast-check

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

@fast-check/expect-type

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

@fast-check/jest

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

@fast-check/poisoning

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

@fast-check/packaged

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

@fast-check/vitest

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

@fast-check/worker

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

commit: effa0f3

[github-actions]

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

[github-actions]

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

[codecov]

Codecov Report

Attention: Patch coverage is 88.23529% with 2 lines in your changes missing coverage. Please review.

Project coverage is 94.78%. Comparing base (8c3a9bb) to head (effa0f3).

Files with missing lines	Patch %	Lines
packages/fast-check/src/arbitrary/ipV6.ts	88.23%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5644      +/-   ##
==========================================
- Coverage   94.81%   94.78%   -0.03%     
==========================================
  Files         230      228       -2     
  Lines        9989     9979      -10     
  Branches     2803     2798       -5     
==========================================
- Hits         9471     9459      -12     
- Misses        518      520       +2     

Flag	Coverage Δ
unit-tests	94.78% <88.23%> (-0.03%)	⬇️
unit-tests-18.x-Linux	94.78% <88.23%> (-0.03%)	⬇️
unit-tests-20.x-Linux	94.78% <88.23%> (+0.02%)	⬆️
unit-tests-22.x-Linux	94.78% <88.23%> (-0.03%)	⬇️
unit-tests-latest-Linux	94.73% <88.23%> (-0.08%)	⬇️

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.