chore(deps): update dependency expect-type to ^0.19.0 #58
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
renovate
bot
changed the title
renovate
bot
changed the title
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/expect-type-0.x
branch
from
b741efa
to
fc56820
Compare
renovate
bot
force-pushed
the
renovate/expect-type-0.x
branch
2 times, most recently
from
0f8e72a
to
4e8e5e0
Compare
renovate
bot
changed the title
renovate
bot
force-pushed
the
renovate/expect-type-0.x
branch
from
4e8e5e0
to
5a064c5
Compare
renovate
bot
force-pushed
the
renovate/expect-type-0.x
branch
from
5a064c5
to
71ecacd
Compare
renovate
bot
changed the title
⚠ Artifact update problemRenovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is. ♻ Renovate will retry this branch, including artifacts, only when one of the following happens:
The artifact failure details are included below: File name: pnpm-lock.yaml |
renovate
bot
force-pushed
the
renovate/expect-type-0.x
branch
from
71ecacd
to
b60696f
Compare
renovate
bot
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^0.14.2->^0.19.0Release Notes
mmkal/expect-type (expect-type)
v0.19.0Compare Source
What's Changed
.omit()to work similarly toOmitby @aryaemami59 in https://github.com/mmkal/expect-type/pull/54testimport inREADME.mdby @aryaemami59 in https://github.com/mmkal/expect-type/pull/65Full Changelog: mmkal/expect-type@0.18.0...0.19.0
v0.18.0Compare Source
What's Changed
.pickand.omitby @aryaemami59 in https://github.com/mmkal/expect-type/pull/51New Contributors
Full Changelog: mmkal/expect-type@v0.17.3...0.18.0
v0.17.3Compare Source
907b8aav0.17.2Compare Source
4b38117Diff(truncated - scroll right!):
test('toEqualTypeOf with tuples', () => { const assertion = `expectTypeOf<[[number], [1], []]>().toEqualTypeOf<[[number], [2], []]>()` expect(tsErrors(assertion)).toMatchInlineSnapshot(` - "test/test.ts:999:999 - error TS2344: Type '[[number], [2], []]' does not satisfy the constraint '{ [x: number]: { [x: number]: number; [iterator]: (() => IterableIterator<1>) | (() => IterableIterator<number>) | (() => IterableIterator<never>); [unscopables]: (() => { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }) | (() => { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }) | (() => { copyWithin: boolean; entries: boolean; fill: boolean; find: boolean; findIndex: boolean; keys: boolean; values: boolean; }); length: 0 | 1; toString: ... truncated!!!!'. - Types of property 'sort' are incompatible. - Type '(compareFn?: ((a: [] | [number] | [2], b: [] | [number] | [2]) => number) | undefined) => [[number], [2], []]' is not assignable to type '\\"Expected: function, Actual: function\\"'. + "test/test.ts:999:999 - error TS2344: Type '[[number], [2], []]' does not satisfy the constraint '{ 0: { 0: number; }; 1: { 0: \\"Expected: literal number: 2, Actual: literal number: 1\\"; }; 2: {}; }'. + The types of '1[0]' are incompatible between these types. + Type '2' is not assignable to type '\\"Expected: literal number: 2, Actual: literal number: 1\\"'. 999 expectTypeOf<[[number], [1], []]>().toEqualTypeOf<[[number], [2], []]>() ~~~~~~~~~~~~~~~~~~~" `) })v0.17.1Compare Source
.notand.brandedtogethercf38918(this was actually documented in the v0.17.0 release but really it was only pushed here)
v0.17.0Compare Source
#16 went in to - hopefully - significantly improve the error messages produce on failing assertions. Here's an example of how vitest's failing tests were improved:
Before:
After:
Docs copied from the readme about how to interpret these error messages
Error messages
When types don't match,
.toEqualTypeOfand.toMatchTypeOfuse a special helper type to produce error messages that are as actionable as possible. But there's a bit of an nuance to understanding them. Since the assertions are written "fluently", the failure should be on the "expected" type, not the "actual" type (expect<Actual>().toEqualTypeOf<Expected>()). This means that type errors can be a little confusing - so this library produces aMismatchInfotype to try to make explicit what the expectation is. For example:Is an assertion that will fail, since
{a: 1}has type{a: number}and not{a: string}. The error message in this case will read something like this:Note that the type constraint reported is a human-readable messaging specifying both the "expected" and "actual" types. Rather than taking the sentence
Types of property 'a' are incompatible // Type 'string' is not assignable to type "Expected: string, Actual: number"literally - just look at the property name ('a') and the message:Expected: string, Actual: number. This will tell you what's wrong, in most cases. Extremely complex types will of course be more effort to debug, and may require some experimentation. Please raise an issue if the error messages are actually misleading.The
toBe...methods (liketoBeString,toBeNumber,toBeVoidetc.) fail by resolving to a non-callable type when theActualtype under test doesn't match up. For example, the failure for an assertion likeexpectTypeOf(1).toBeString()will look something like this:The
This expression is not callablepart isn't all that helpful - the meaningful error is the next line,Type 'ExpectString<number> has no call signatures. This essentially means you passed a number but asserted it should be a string.If TypeScript added support for "throw" types these error messagess could be improved. Until then they will take a certain amount of squinting.
Concrete "expected" objects vs typeargs
Error messages for an assertion like this:
Will be less helpful than for an assertion like this:
This is because the TypeScript compiler needs to infer the typearg for the
.toEqualTypeOf({a: ''})style, and this library can only mark it as a failure by comparing it against a genericMismatchtype. So, where possible, use a typearg rather than a concrete type for.toEqualTypeOfandtoMatchTypeOf. If it's much more convenient to compare two concrete types, you can usetypeof:Kinda-breaking changes: essentially none, but technically,
.brandedno longer returns a "full"ExpectTypeOfinstance at compile-time. Previously you could do this:Now that won't work (and it was always slightly nonsensical), so you'd have to use
// @​ts-expect-errorinstead ofnotif you have a negated case where you needbranded:What's Changed
New Contributors
Full Changelog: mmkal/expect-type@v0.16.0...v0.17.0
v0.16.0Compare Source
What's Changed
thisparameters by @mmkal and @papb in https://github.com/mmkal/expect-type/pull/15Equalto use the equality check fromReadonlyEquivalentexclusively by @trevorade in https://github.com/mmkal/expect-type/pull/21Note that #21 has affected behavior for intersection types, which can result in (arguably) false errors:
Full Changelog: mmkal/expect-type@v0.15.0...v16.0.0
v0.15.0Compare Source
What's Changed
New Contributors
Full Changelog: mmkal/expect-type@v0.14.2...v0.15.0
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.