Update dependency ts-pattern to ^5.6.0 #10

renovate · 2023-12-19T05:25:59Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
ts-pattern	`^5.0.5` -> `^5.6.0`

Release Notes

gvergnaud/ts-pattern (ts-pattern)

`v5.6.0`

Compare Source

This release contains two changes:

Typecheck pattern when using isMatching with 2 parameter.

It used to be possible to pass a pattern than could never match to isMatching. The new version checks that the provide pattern does match the value in second parameter:

type Pizza = { type: 'pizza'; topping: string };
type Sandwich = { type: 'sandwich'; condiments: string[] };
type Food = Pizza | Sandwich;

const fn = (food: Pizza | Sandwich) => {
    if (isMatching({ type: 'oops' }, food)) {
        //                  👆 used to type-check, now doesn't!
    }
}

Do not use `P.infer` as an inference point

When using P.infer<Pattern> to type a function argument, like in the following example:

const getWithDefault = <T extends P.Pattern>(
  input: unknown,
  pattern: T,
  defaultValue: P.infer<T> //  👈
): P.infer<T> =>
  isMatching(pattern, input) ? input : defaultValue

TypeScript could get confused and find type errors in the wrong spot:

const res = getWithDefault(null, { x: P.string }, 'oops') 
//                                     👆           👆 type error should be here
//                                 but it's here 😬

This new version fixes this problem.

The main thing — Faster type checking 🚀

This release brings a significant perf improvement to exhaustiveness checking, which led to a ~16% decrease in the time to type-check the full test suite of TS-Pattern:

Category	Before	After	Evolution (%)
Instantiations	6,735,991	4,562,378	-32.33%
Memory used	732,233K	746,454K	1.95%
Assignability cache size	209,959	205,926	-1.92%
Identity cache size	28,093	28,250	0.56%
Check time	5.78s	4.83s	-16.44%

What's Changed

build(deps-dev): bump braces from 3.0.2 to 3.0.3 by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/273
build(deps-dev): bump webpack from 5.91.0 to 5.94.0 in /examples/gif-fetcher by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/276
build(deps): bump serve-static and express in /examples/gif-fetcher by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/283
perf: improve type checking performance of BuildMany by @gvergnaud in https://github.com/gvergnaud/ts-pattern/pull/286
Fixes type InvertPatternForExcludeInternal to work with readonly array by @changwoolab in https://github.com/gvergnaud/ts-pattern/pull/284

New Contributors

@changwoolab made their first contribution in https://github.com/gvergnaud/ts-pattern/pull/284

Full Changelog: gvergnaud/ts-pattern@v5.3.1...v5.4.0

`v5.3.1`

Compare Source

Pattern-matching on symbol keys

Symbols used to be ignored in object patterns. They are now taken into account:

const symbolA = Symbol('symbol-a');
const symbolB = Symbol('symbol-b');

const obj = { [symbolA]: { [symbolB]: 'foo' } };
    
if (isMatching({ [symbolA]: { [symbolB]: 'bar' } }, obj)) {
   //  👆 Used to return true, now returns false!
   
   //  Since TS-Pattern wasn't reading symbols, this pattern used to be equivalent
   //  to the `{}` pattern that matches any value except null and undefined.
}

`.exhaustive` now throws a custom error

People have expressed the need to differentiate runtime errors that .exhaustive() might throw when the input is of an unexpected type from other runtime errors that could have happened in the same match expression. It's now possible with err instanceof NonExhaustiveError:

import { match, P, NonExhaustiveError }  from 'ts-pattern';

const fn = (input: string | number) => {
  return match(input)
    .with(P.string, () => "string!")
    .with(P.number, () => "number!")
    .exhaustive()
}

try {
  fn(null as string) // 👈 💥 
} catch (e) {
  if (e instanceof NonExhaustiveError) {
    // The input was invalid
  } else {
    // something else happened
  }
}

What's Changed

build(deps-dev): bump braces from 3.0.2 to 3.0.3 in /examples/gif-fetcher by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/262
feat: throw custom ExhaustiveError when no matched pattern by @adamhamlin in https://github.com/gvergnaud/ts-pattern/pull/270
Symbols as keys by @Ayc0 in https://github.com/gvergnaud/ts-pattern/pull/272

New Contributors

@adamhamlin made their first contribution in https://github.com/gvergnaud/ts-pattern/pull/270
@Ayc0 made their first contribution in https://github.com/gvergnaud/ts-pattern/pull/272

Full Changelog: gvergnaud/ts-pattern@v5.2.0...v5.3.1

`v5.3.0`

Compare Source

`v5.2.0`

Compare Source

The main thing

new `P.string.length(n)` pattern

P.string.length(len) matches strings with exactly len characters.

const fn = (input: string) =>
  match(input)
    .with(P.string.length(2), () => '🎉')
    .otherwise(() => '❌');

console.log(fn('ok')); // logs '🎉'

What's Changed

docs: fix typo in P.when patterns code example by @grigorischristainas in https://github.com/gvergnaud/ts-pattern/pull/260
feat: Added P.string.length by @JUSTIVE in https://github.com/gvergnaud/ts-pattern/pull/257

New Contributors

@grigorischristainas made their first contribution in https://github.com/gvergnaud/ts-pattern/pull/260

Full Changelog: gvergnaud/ts-pattern@v5.1.2...v5.2.0

`v5.1.2`

Compare Source

The main thing

When combining P.nonNullable and P.nullish, you should get an exhaustive pattern matching expression, but the following case was incorrectly considered non-exhaustive:

declare const input: {
  nested: string | number | null | undefined;
};

const res = match(input)
  .with({ nested: P.nonNullable }, (x) => {/* ... */})
  .with({ nested: P.nullish }, (x) => {/* ... */})
  // should type-check
  .exhaustive();

This is fixed now.

What's Changed

build(deps): bump postcss and react-scripts in /examples/gif-fetcher by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/243
build(deps): bump loader-utils and react-scripts in /examples/gif-fetcher by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/242
build(deps): bump jsdom and react-scripts in /examples/gif-fetcher by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/241
build(deps): bump tough-cookie and react-scripts in /examples/gif-fetcher by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/240
build(deps): bump shell-quote and react-scripts in /examples/gif-fetcher by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/239
chore: add P.map specific jsdoc for P.map by @momentiris in https://github.com/gvergnaud/ts-pattern/pull/245
build(deps-dev): bump ejs from 3.1.9 to 3.1.10 in /examples/gif-fetcher by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/249
build(deps-dev): bump ejs from 3.1.9 to 3.1.10 by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/248
fix: exhaustive checking with nested P.nonNullable patterns by @gvergnaud in https://github.com/gvergnaud/ts-pattern/pull/252

New Contributors

@momentiris made their first contribution in https://github.com/gvergnaud/ts-pattern/pull/245

Full Changelog: gvergnaud/ts-pattern@v5.1.1...v5.1.2

`v5.1.1`

Compare Source

What's Changed

Fix(P.nonNullable): narrowing of unions of objects by @gvergnaud in https://github.com/gvergnaud/ts-pattern/pull/237

Full Changelog: gvergnaud/ts-pattern@v5.1.0...v5.1.1

`v5.1.0`

Compare Source

New features

`P.nonNullable` wildcard

Add a new P.nonNullable pattern that will match any value except null or undefined.

import { match, P } from 'ts-pattern';

const input = null;

const output = match<number | null | undefined>(input)
  .with(P.nonNullable, () => 'it is a number!')
  .otherwise(() => 'it is either null or undefined!');

console.log(output);
// => 'it is either null or undefined!'

Closes #60 #154 #190 and will be a work-around for #143.

What's Changed

feat: Add P.nonNullable patterns by @gvergnaud in https://github.com/gvergnaud/ts-pattern/pull/229

Full Changelog: gvergnaud/ts-pattern@v5.0.8...v5.1.0

`v5.0.8`

Compare Source

The main thing

This release includes type narrowing improvement to isMatching when used in its curried form:

type Pizza = { type: 'pizza', topping: string };
type Sandwich = { type: 'sandwich', condiments: string[] }
type Food =  Pizza | Sandwich;

declare const food: Food

const isPizza = isMatching({ type: 'pizza' })

if (isPizza(food)) {
  x  // Used to  infer `food` as `Food`, no infers `Pizza`
}

This also improves type checking performance for complex patterns and fixes a small bug in the ES5 build of TS-Pattern.

What's Changed

perf: support exhaustive match on larger unions by @gvergnaud in https://github.com/gvergnaud/ts-pattern/pull/214
fix: make isMatching(p) infer the pattern as a const type parameter by @gvergnaud in https://github.com/gvergnaud/ts-pattern/pull/221
fix: Make sure regeneratorRuntime isn't included in the cjs build by @gvergnaud in https://github.com/gvergnaud/ts-pattern/pull/224

Full Changelog: gvergnaud/ts-pattern@v5.0.6...v5.0.8

`v5.0.7`

Compare Source

`v5.0.6`

Compare Source

Close issue issues

Exhaustive matching fix for read only arrays https://github.com/gvergnaud/ts-pattern/issues/206
Fix incorrect JS docs https://github.com/gvergnaud/ts-pattern/issues/196

What's Changed

Update README.md by @ndstephens in https://github.com/gvergnaud/ts-pattern/pull/161
docs: add install instructions for bun and pnpm by @colinhacks in https://github.com/gvergnaud/ts-pattern/pull/186
build(deps-dev): bump postcss from 8.4.23 to 8.4.31 by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/199
build(deps-dev): bump @babel/traverse from 7.21.5 to 7.23.2 by @dependabot in https://github.com/gvergnaud/ts-pattern/pull/200
fix(readonly): exhaustive matching on readonly array by @gvergnaud in https://github.com/gvergnaud/ts-pattern/pull/207

New Contributors

@ndstephens made their first contribution in https://github.com/gvergnaud/ts-pattern/pull/161
@colinhacks made their first contribution in https://github.com/gvergnaud/ts-pattern/pull/186

Full Changelog: gvergnaud/ts-pattern@v5.0.5...v5.0.6

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

renovate bot force-pushed the renovate/ts-pattern-5.x branch from a760f12 to c3eee92 Compare February 16, 2024 05:40

renovate bot changed the title ~~Update dependency ts-pattern to ^5.0.6~~ Update dependency ts-pattern to ^5.0.8 Feb 16, 2024

renovate bot force-pushed the renovate/ts-pattern-5.x branch from c3eee92 to a700f73 Compare April 1, 2024 08:35

renovate bot changed the title ~~Update dependency ts-pattern to ^5.0.8~~ Update dependency ts-pattern to ^5.1.0 Apr 1, 2024

renovate bot force-pushed the renovate/ts-pattern-5.x branch from a700f73 to 86e65eb Compare April 7, 2024 05:55

renovate bot changed the title ~~Update dependency ts-pattern to ^5.1.0~~ Update dependency ts-pattern to ^5.1.1 Apr 7, 2024

renovate bot force-pushed the renovate/ts-pattern-5.x branch from 86e65eb to a8fffa6 Compare May 24, 2024 05:34

renovate bot changed the title ~~Update dependency ts-pattern to ^5.1.1~~ Update dependency ts-pattern to ^5.1.2 May 24, 2024

renovate bot force-pushed the renovate/ts-pattern-5.x branch from a8fffa6 to 8c92173 Compare June 13, 2024 23:43

renovate bot changed the title ~~Update dependency ts-pattern to ^5.1.2~~ Update dependency ts-pattern to ^5.2.0 Jun 13, 2024

renovate bot force-pushed the renovate/ts-pattern-5.x branch from 8c92173 to 7fc90f2 Compare August 12, 2024 02:45

renovate bot changed the title ~~Update dependency ts-pattern to ^5.2.0~~ Update dependency ts-pattern to ^5.3.1 Aug 12, 2024

renovate bot force-pushed the renovate/ts-pattern-5.x branch from 7fc90f2 to 3788189 Compare September 26, 2024 02:50

renovate bot changed the title ~~Update dependency ts-pattern to ^5.3.1~~ Update dependency ts-pattern to ^5.4.0 Sep 26, 2024

renovate bot force-pushed the renovate/ts-pattern-5.x branch from 3788189 to a292701 Compare October 15, 2024 05:47

renovate bot changed the title ~~Update dependency ts-pattern to ^5.4.0~~ Update dependency ts-pattern to ^5.5.0 Oct 15, 2024

Update dependency ts-pattern to ^5.6.0

be0177e

renovate bot force-pushed the renovate/ts-pattern-5.x branch from a292701 to be0177e Compare December 16, 2024 02:09

renovate bot changed the title ~~Update dependency ts-pattern to ^5.5.0~~ Update dependency ts-pattern to ^5.6.0 Dec 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dependency ts-pattern to ^5.6.0 #10

Update dependency ts-pattern to ^5.6.0 #10

renovate bot commented Dec 19, 2023 •

edited

Loading

Update dependency ts-pattern to ^5.6.0 #10

Are you sure you want to change the base?

Update dependency ts-pattern to ^5.6.0 #10

Conversation

renovate bot commented Dec 19, 2023 • edited Loading

Release Notes

Typecheck pattern when using isMatching with 2 parameter.

Do not use P.infer as an inference point

What's Changed

What's Changed

New Contributors

The main thing — Faster type checking 🚀

What's Changed

New Contributors

Pattern-matching on symbol keys

.exhaustive now throws a custom error

What's Changed

New Contributors

The main thing

new P.string.length(n) pattern

What's Changed

New Contributors

The main thing

What's Changed

New Contributors

What's Changed

New features

P.nonNullable wildcard

What's Changed

The main thing

What's Changed

Close issue issues

What's Changed

New Contributors

Configuration

renovate bot commented Dec 19, 2023 •

edited

Loading

Do not use `P.infer` as an inference point

`.exhaustive` now throws a custom error

new `P.string.length(n)` pattern

`P.nonNullable` wildcard