-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Make assert
, truthy
and falsy
typeguards
#3233
Conversation
Neat! @sindresorhus you OK reviewing? |
types/assertions.d.cts
Outdated
@@ -192,7 +194,7 @@ export type FalsyAssertion = { | |||
* Assert that `actual` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy), returning a boolean | |||
* indicating whether the assertion passed. | |||
*/ | |||
(actual: any, message?: string): boolean; | |||
<T>(actual: T, message?: string): actual is T extends Falsy ? T :never; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think never
is correct here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we can use anything besides never
there and have it work correctly. The only things that typescript doesn't complain about using there are never
and any
or a subset of the T
type. If you make it any
then falsy(true)
thinks it's falsy.
This is also the exact opposite condition I setup in truthy
and assert
:
actual is Exclude<T,Falsy>
where Exclude is Exclude<T,U> = T extends U ? never : T
becomes actual is T extends Falsy ? never : T
which is the opposite condition of the falsy
assertion.
I included the test-types with both the if
case and the else
case so you can see the types as they work. For further showcasing of the types, I setup a quick Playground example if you want to try changing what the assertions are.
Playing around with it, the current conditions don't work well for number and string primitives. Typescript seems to not recognize that 0
is a subset of number unless you use an as const
expression with it. Similar results for an empty string (''
) but even more wacky as ''
will make typescript think it is truthy
with a value of ''
, but '' as const
makes typescript recognize it as falsy. Typescript also doesn't separate out 0
or ''
from their primitive values.
So far, I think I'm having the most accurate approach using (playground link)
function falsy<T>(actual: T): actual is T extends Exclude<T, Falsy>? never : T {
return !actual;
};
function truthy<T>(actual: T): actual is Exclude<T, Falsy> {
return !!actual;
};
In which case the only remaining issue is that for a type of number
or string
, typescript doesn't think that they could ever be falsy.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we can use anything besides never there and have it work correctly.
You're right. I read the signature incorrectly.
So far, I think I'm having the most accurate approach using (playground link)
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With your suggestion of multiple overloads, that partially works, but runs into an issue where union types would fall back to the base behavior of the generic rather than the behavior of the overload.
I think I've cracked it for falsy, but I can't get the same to work for truthy as Typescript has no way to just invert a type. playground - As you can see from the screenshot, falsy works great, but truthy is missing 0
in the else
clause, and I don't think there's really anything we can do about it...
type FalsyValue = false | 0 | 0n | '' | null | undefined;
type Falsy<T> = T extends Exclude<T, FalsyValue> ? (T extends number | string | bigint ? T & FalsyValue : never) : T;
function falsy<T>(actual: T): actual is Falsy<T> {
return !actual;
};
function truthy<T>(actual: T): actual is T extends Falsy<T> ? never : T {
return !!actual;
};
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but truthy is missing 0 in the else clause, and I don't think there's really anything we can do about it...
I would mention this in the doc comments.
types/assertions.d.cts
Outdated
@@ -192,7 +194,7 @@ export type FalsyAssertion = { | |||
* Assert that `actual` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy), returning a boolean | |||
* indicating whether the assertion passed. | |||
*/ | |||
(actual: any, message?: string): boolean; | |||
<T>(actual: T, message?: string): actual is T extends Falsy ? T :never; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it work to have specific overloads?
<T>(actual: T, message?: string): actual is T extends Falsy ? T :never; | |
(actual: 0): true; | |
(actual: ''): true; | |
<T>(actual: T, message?: string): actual is T extends Falsy ? T :never; |
types/assertions.d.cts
Outdated
@@ -192,7 +194,7 @@ export type FalsyAssertion = { | |||
* Assert that `actual` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy), returning a boolean | |||
* indicating whether the assertion passed. | |||
*/ | |||
(actual: any, message?: string): boolean; | |||
<T>(actual: T, message?: string): actual is T extends Falsy ? T :never; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we can use anything besides never there and have it work correctly.
You're right. I read the signature incorrectly.
So far, I think I'm having the most accurate approach using (playground link)
👍
types/assertions.d.cts
Outdated
@@ -192,7 +194,7 @@ export type FalsyAssertion = { | |||
* Assert that `actual` is [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy), returning a boolean | |||
* indicating whether the assertion passed. | |||
*/ | |||
(actual: any, message?: string): boolean; | |||
<T>(actual: T, message?: string): actual is T extends Falsy ? T :never; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<T>(actual: T, message?: string): actual is T extends Falsy ? T :never; | |
<T>(actual: T, message?: string): actual is T extends Falsy ? T : never; |
Add a note mentioning the issues with the types for truthy
I gave it my best shot for a reasonably concise note about the type issue for truthy/assert. The nice thing about the issues being where they are is that if they are reaching that issue, then that means the test failed anyway... 🙃 |
Co-authored-by: Sindre Sorhus <[email protected]>
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ava](https://avajs.dev) ([source](https://github.com/avajs/ava)) | [`^5.3.1` -> `^6.0.0`](https://renovatebot.com/diffs/npm/ava/5.3.1/6.0.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/ava/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/ava/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/ava/5.3.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ava/5.3.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`v6.0.0`](https://github.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://github.com/avajs/ava/compare/v5.3.1...v6.0.0) #### Breaking Changes - AVA now requires Node.js versions 18.18, 20.8 or 21. Versions 14 and 16 are no longer supported. [#​3251](https://github.com/avajs/ava/issues/3251) [#​3216](https://github.com/avajs/ava/issues/3216) - When tests finish, worker threads or child processes are no longer exited through `proces.exit()`. If your test file does not exit on its own, the test run will time out. [#​3260](https://github.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://github.com/avajs/ava/issues/3218): - Watch mode can no longer be started via the `ava.config.*` or `package.json` configuration. - The `ignoredByWatcher` configuration has moved to the `watchMode` object, under the `ignoreChanges` key. - Watch mode now uses the built-in [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. This is supported on Linux in Node.js 20 or newer, and MacOS and Windows in Node.js 18 as well. There are [caveats](https://nodejs.org/api/fs.html#caveats) to keep in mind. - Failed assertions now throw, meaning that any subsequent code is not executed. This also impacts the type definitions. [#​3246](https://github.com/avajs/ava/issues/3246) - [Only native errors](https://nodejs.org/api/util.html#utiltypesisnativeerrorvalue) are now considered errors by the `t.throws()` and `t.throwsAsync()` assertions. [`Object.create(Error.prototype)` is **not** a native error](Object.create\(Error.prototype\)). [#​3229](https://github.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://github.com/avajs/ava/issues/3184): - If such modules export a default function, this function is now invoked. - Local files are loaded through `@ava/typescript` if necessary. #### Improvements ##### Rewritten watcher The watcher has been rewritten. It’s now built on [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. [`@vercel/nft`](https://github.com/vercel/nft) is used to perform static dependency analysis, supporting ESM and CJS imports for JavaScript & TypeScript source files. This is a huge improvement over the previous runtime tracking of CJS imports, which did not support ESM. Integration with [`@ava/typescript`](https://github.com/avajs/typescript) has been improved. The watcher can now detect a change to a TypeScript source file, then wait for the corresponding build output to change before re-running tests. The ignoredByWatcher configuration has moved to the watchMode object, under the ignoreChanges key. See [#​3218](https://github.com/avajs/ava/issues/3218) and [#​3257](https://github.com/avajs/ava/issues/3257). ##### Failed assertions now throw Assertions now throw a `TestFailure` error when they fail. This error is not exported or documented and should not be used or thrown manually. You cannot catch this error in order to recover from a failure, use `t.try()` instead. All assertions except for `t.throws()` and `t.throwsAsync()` now return `true` when they pass. This is useful for some of the assertions in TypeScript where they can be used as a type guard. Committing a failed `t.try()` result now also throws. See [#​3246](https://github.com/avajs/ava/issues/3246). ##### `t.throws()` and `t.throwsAsync()` can now expect any error By default, the thrown error (or rejection reason) must be a native error. You can change the assertion to expect any kind of error by setting `any: true` in the expectation object: ```js t.throws(() => { throw 'error' }, {any: true}) ``` See [#​3245](https://github.com/avajs/ava/issues/3245) by [@​adiSuper94](https://github.com/adiSuper94). ##### The `require` configuration is now more powerful It now loads ES modules. Local files are loaded through `@ava/typescript` if necessary, so you can also write these in TypeScript. If there is a default export function, it is invoked after loading. The function is awaited so it can do asynchronous setup before further modules are loaded. Arguments from the configuration can be passed to the function (as a \[[structured clone](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)]\(https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)). See [#​3184](https://github.com/avajs/ava/issues/3184) by [@​sculpt0r](https://github.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://github.com/avajs/ava/issues/3247) by [@​codetheweb](https://github.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://github.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://github.com/avajs/ava/issues/3220) #### New Contributors - [@​sculpt0r](https://github.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://github.com/avajs/ava/pull/3184) - [@​ZachHaber](https://github.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://github.com/avajs/ava/pull/3233) - [@​adiSuper94](https://github.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://github.com/avajs/ava/pull/3245) - [@​bricker](https://github.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://github.com/avajs/ava/pull/3250) **Full Changelog**: avajs/ava@v5.3.1...v6.0.0 </details> --- ### 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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/toeverything/AFFiNE). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44MS4zIiwidXBkYXRlZEluVmVyIjoiMzcuODEuMyIsInRhcmdldEJyYW5jaCI6ImNhbmFyeSJ9-->
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ava](https://avajs.dev) ([source](https://github.com/avajs/ava)) | [`^5.3.1` -> `^6.0.0`](https://renovatebot.com/diffs/npm/ava/5.3.1/6.0.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/ava/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/ava/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/ava/5.3.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ava/5.3.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`v6.0.0`](https://github.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://github.com/avajs/ava/compare/v5.3.1...v6.0.0) #### Breaking Changes - AVA now requires Node.js versions 18.18, 20.8 or 21. Versions 14 and 16 are no longer supported. [#​3251](https://github.com/avajs/ava/issues/3251) [#​3216](https://github.com/avajs/ava/issues/3216) - When tests finish, worker threads or child processes are no longer exited through `proces.exit()`. If your test file does not exit on its own, the test run will time out. [#​3260](https://github.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://github.com/avajs/ava/issues/3218): - Watch mode can no longer be started via the `ava.config.*` or `package.json` configuration. - The `ignoredByWatcher` configuration has moved to the `watchMode` object, under the `ignoreChanges` key. - Watch mode now uses the built-in [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. This is supported on Linux in Node.js 20 or newer, and MacOS and Windows in Node.js 18 as well. There are [caveats](https://nodejs.org/api/fs.html#caveats) to keep in mind. - Failed assertions now throw, meaning that any subsequent code is not executed. This also impacts the type definitions. [#​3246](https://github.com/avajs/ava/issues/3246) - [Only native errors](https://nodejs.org/api/util.html#utiltypesisnativeerrorvalue) are now considered errors by the `t.throws()` and `t.throwsAsync()` assertions. [`Object.create(Error.prototype)` is **not** a native error](Object.create\(Error.prototype\)). [#​3229](https://github.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://github.com/avajs/ava/issues/3184): - If such modules export a default function, this function is now invoked. - Local files are loaded through `@ava/typescript` if necessary. #### Improvements ##### Rewritten watcher The watcher has been rewritten. It’s now built on [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. [`@vercel/nft`](https://github.com/vercel/nft) is used to perform static dependency analysis, supporting ESM and CJS imports for JavaScript & TypeScript source files. This is a huge improvement over the previous runtime tracking of CJS imports, which did not support ESM. Integration with [`@ava/typescript`](https://github.com/avajs/typescript) has been improved. The watcher can now detect a change to a TypeScript source file, then wait for the corresponding build output to change before re-running tests. The ignoredByWatcher configuration has moved to the watchMode object, under the ignoreChanges key. See [#​3218](https://github.com/avajs/ava/issues/3218) and [#​3257](https://github.com/avajs/ava/issues/3257). ##### Failed assertions now throw Assertions now throw a `TestFailure` error when they fail. This error is not exported or documented and should not be used or thrown manually. You cannot catch this error in order to recover from a failure, use `t.try()` instead. All assertions except for `t.throws()` and `t.throwsAsync()` now return `true` when they pass. This is useful for some of the assertions in TypeScript where they can be used as a type guard. Committing a failed `t.try()` result now also throws. See [#​3246](https://github.com/avajs/ava/issues/3246). ##### `t.throws()` and `t.throwsAsync()` can now expect any error By default, the thrown error (or rejection reason) must be a native error. You can change the assertion to expect any kind of error by setting `any: true` in the expectation object: ```js t.throws(() => { throw 'error' }, {any: true}) ``` See [#​3245](https://github.com/avajs/ava/issues/3245) by [@​adiSuper94](https://github.com/adiSuper94). ##### The `require` configuration is now more powerful It now loads ES modules. Local files are loaded through `@ava/typescript` if necessary, so you can also write these in TypeScript. If there is a default export function, it is invoked after loading. The function is awaited so it can do asynchronous setup before further modules are loaded. Arguments from the configuration can be passed to the function (as a \[[structured clone](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)]\(https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)). See [#​3184](https://github.com/avajs/ava/issues/3184) by [@​sculpt0r](https://github.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://github.com/avajs/ava/issues/3247) by [@​codetheweb](https://github.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://github.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://github.com/avajs/ava/issues/3220) #### New Contributors - [@​sculpt0r](https://github.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://github.com/avajs/ava/pull/3184) - [@​ZachHaber](https://github.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://github.com/avajs/ava/pull/3233) - [@​adiSuper94](https://github.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://github.com/avajs/ava/pull/3245) - [@​bricker](https://github.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://github.com/avajs/ava/pull/3250) **Full Changelog**: avajs/ava@v5.3.1...v6.0.0 </details> --- ### 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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/toeverything/AFFiNE). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44MS4zIiwidXBkYXRlZEluVmVyIjoiMzcuODEuMyIsInRhcmdldEJyYW5jaCI6ImNhbmFyeSJ9-->
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ava](https://avajs.dev) ([source](https://github.com/avajs/ava)) | [`^5.0.0` -> `^6.0.0`](https://renovatebot.com/diffs/npm/ava/5.0.1/6.0.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/ava/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/ava/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/ava/5.0.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ava/5.0.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`v6.0.0`](https://github.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://github.com/avajs/ava/compare/v5.3.1...v6.0.0) #### Breaking Changes - AVA now requires Node.js versions 18.18, 20.8 or 21. Versions 14 and 16 are no longer supported. [#​3251](https://github.com/avajs/ava/issues/3251) [#​3216](https://github.com/avajs/ava/issues/3216) - When tests finish, worker threads or child processes are no longer exited through `proces.exit()`. If your test file does not exit on its own, the test run will time out. [#​3260](https://github.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://github.com/avajs/ava/issues/3218): - Watch mode can no longer be started via the `ava.config.*` or `package.json` configuration. - The `ignoredByWatcher` configuration has moved to the `watchMode` object, under the `ignoreChanges` key. - Watch mode now uses the built-in [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. This is supported on Linux in Node.js 20 or newer, and MacOS and Windows in Node.js 18 as well. There are [caveats](https://nodejs.org/api/fs.html#caveats) to keep in mind. - Failed assertions now throw, meaning that any subsequent code is not executed. This also impacts the type definitions. [#​3246](https://github.com/avajs/ava/issues/3246) - [Only native errors](https://nodejs.org/api/util.html#utiltypesisnativeerrorvalue) are now considered errors by the `t.throws()` and `t.throwsAsync()` assertions. [`Object.create(Error.prototype)` is **not** a native error](Object.create\(Error.prototype\)). [#​3229](https://github.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://github.com/avajs/ava/issues/3184): - If such modules export a default function, this function is now invoked. - Local files are loaded through `@ava/typescript` if necessary. #### Improvements ##### Rewritten watcher The watcher has been rewritten. It’s now built on [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. [`@vercel/nft`](https://github.com/vercel/nft) is used to perform static dependency analysis, supporting ESM and CJS imports for JavaScript & TypeScript source files. This is a huge improvement over the previous runtime tracking of CJS imports, which did not support ESM. Integration with [`@ava/typescript`](https://github.com/avajs/typescript) has been improved. The watcher can now detect a change to a TypeScript source file, then wait for the corresponding build output to change before re-running tests. The ignoredByWatcher configuration has moved to the watchMode object, under the ignoreChanges key. See [#​3218](https://github.com/avajs/ava/issues/3218) and [#​3257](https://github.com/avajs/ava/issues/3257). ##### Failed assertions now throw Assertions now throw a `TestFailure` error when they fail. This error is not exported or documented and should not be used or thrown manually. You cannot catch this error in order to recover from a failure, use `t.try()` instead. All assertions except for `t.throws()` and `t.throwsAsync()` now return `true` when they pass. This is useful for some of the assertions in TypeScript where they can be used as a type guard. Committing a failed `t.try()` result now also throws. See [#​3246](https://github.com/avajs/ava/issues/3246). ##### `t.throws()` and `t.throwsAsync()` can now expect any error By default, the thrown error (or rejection reason) must be a native error. You can change the assertion to expect any kind of error by setting `any: true` in the expectation object: ```js t.throws(() => { throw 'error' }, {any: true}) ``` See [#​3245](https://github.com/avajs/ava/issues/3245) by [@​adiSuper94](https://github.com/adiSuper94). ##### The `require` configuration is now more powerful It now loads ES modules. Local files are loaded through `@ava/typescript` if necessary, so you can also write these in TypeScript. If there is a default export function, it is invoked after loading. The function is awaited so it can do asynchronous setup before further modules are loaded. Arguments from the configuration can be passed to the function (as a \[[structured clone](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)]\(https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)). See [#​3184](https://github.com/avajs/ava/issues/3184) by [@​sculpt0r](https://github.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://github.com/avajs/ava/issues/3247) by [@​codetheweb](https://github.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://github.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://github.com/avajs/ava/issues/3220) #### New Contributors - [@​sculpt0r](https://github.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://github.com/avajs/ava/pull/3184) - [@​ZachHaber](https://github.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://github.com/avajs/ava/pull/3233) - [@​adiSuper94](https://github.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://github.com/avajs/ava/pull/3245) - [@​bricker](https://github.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://github.com/avajs/ava/pull/3250) **Full Changelog**: avajs/ava@v5.3.1...v6.0.0 ### [`v5.3.1`](https://github.com/avajs/ava/releases/tag/v5.3.1) [Compare Source](https://github.com/avajs/ava/compare/v5.3.0...v5.3.1) #### What's Changed - Update `t.like()` to support Symbol keys and ignore non-enumerable properties by [@​gibson042](https://github.com/gibson042) in [https://github.com/avajs/ava/pull/3209](https://github.com/avajs/ava/pull/3209) - Fix circular selector detection in `t.like()` by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3212](https://github.com/avajs/ava/pull/3212) **Full Changelog**: avajs/ava@v5.3.0...v5.3.1 ### [`v5.3.0`](https://github.com/avajs/ava/releases/tag/v5.3.0) [Compare Source](https://github.com/avajs/ava/compare/v5.2.0...v5.3.0) #### What's Changed - Support arrays in `t.like()` assertions by [@​tommy-mitchell](https://github.com/tommy-mitchell) in [https://github.com/avajs/ava/pull/3185](https://github.com/avajs/ava/pull/3185) - Recognize typical assertion errors (`expect` and `assert`) and use their formatting by [@​Irvenae](https://github.com/Irvenae) in [https://github.com/avajs/ava/pull/3187](https://github.com/avajs/ava/pull/3187) #### New Contributors - [@​MartynasZilinskas](https://github.com/MartynasZilinskas) made their first contribution in [https://github.com/avajs/ava/pull/3172](https://github.com/avajs/ava/pull/3172) - [@​flovogt](https://github.com/flovogt) made their first contribution in [https://github.com/avajs/ava/pull/3194](https://github.com/avajs/ava/pull/3194) - [@​ondreian](https://github.com/ondreian) made their first contribution in [https://github.com/avajs/ava/pull/3192](https://github.com/avajs/ava/pull/3192) - [@​tommy-mitchell](https://github.com/tommy-mitchell) made their first contribution in [https://github.com/avajs/ava/pull/3185](https://github.com/avajs/ava/pull/3185) - [@​craigahobbs](https://github.com/craigahobbs) made their first contribution in [https://github.com/avajs/ava/pull/3198](https://github.com/avajs/ava/pull/3198) - [@​Irvenae](https://github.com/Irvenae) made their first contribution in [https://github.com/avajs/ava/pull/3187](https://github.com/avajs/ava/pull/3187) **Full Changelog**: avajs/ava@v5.2.0...v5.3.0 ### [`v5.2.0`](https://github.com/avajs/ava/releases/tag/v5.2.0) [Compare Source](https://github.com/avajs/ava/compare/v5.1.1...v5.2.0) #### What's Changed - Infer thrown error from expectations by [@​tao-cumplido](https://github.com/tao-cumplido) in [https://github.com/avajs/ava/pull/3156](https://github.com/avajs/ava/pull/3156) #### New Contributors - [@​tao-cumplido](https://github.com/tao-cumplido) made their first contribution in [https://github.com/avajs/ava/pull/3156](https://github.com/avajs/ava/pull/3156) **Full Changelog**: avajs/ava@v5.1.1...v5.2.0 ### [`v5.1.1`](https://github.com/avajs/ava/releases/tag/v5.1.1) [Compare Source](https://github.com/avajs/ava/compare/v5.1.0...v5.1.1) #### What's Changed - Fix de-registration of shared workers to ensure AVA exits correctly, by [@​codetheweb](https://github.com/codetheweb) in [https://github.com/avajs/ava/pull/3149](https://github.com/avajs/ava/pull/3149) & [https://github.com/avajs/ava/pull/3151](https://github.com/avajs/ava/pull/3151) **Full Changelog**: avajs/ava@v5.1.0...v5.1.1 ### [`v5.1.0`](https://github.com/avajs/ava/releases/tag/v5.1.0) [Compare Source](https://github.com/avajs/ava/compare/v5.0.1...v5.1.0) ##### What's Changed - Output logs for tests that remain pending when AVA exits by [@​kevo1ution](https://github.com/kevo1ution) in [https://github.com/avajs/ava/pull/3125](https://github.com/avajs/ava/pull/3125) - Check for --config file extensions after they fail to load, allowing custom loaders by [@​panva](https://github.com/panva) in [https://github.com/avajs/ava/pull/3135](https://github.com/avajs/ava/pull/3135) ##### New Contributors - [@​kevo1ution](https://github.com/kevo1ution) made their first contribution in [https://github.com/avajs/ava/pull/3125](https://github.com/avajs/ava/pull/3125) - [@​panva](https://github.com/panva) made their first contribution in [https://github.com/avajs/ava/pull/3135](https://github.com/avajs/ava/pull/3135) **Full Changelog**: avajs/ava@v5.0.1...v5.1.0 </details> --- ### 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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/gr2m/github-project). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44MS4zIiwidXBkYXRlZEluVmVyIjoiMzcuODEuMyIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ava](https://avajs.dev) ([source](https://github.com/avajs/ava)) | [`^5.3.1` -> `^6.0.0`](https://renovatebot.com/diffs/npm/ava/5.3.1/6.0.0) | [![age](https://developer.mend.io/api/mc/badges/age/npm/ava/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/ava/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/ava/5.3.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ava/5.3.1/6.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`v6.0.0`](https://github.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://github.com/avajs/ava/compare/v5.3.1...v6.0.0) #### Breaking Changes - AVA now requires Node.js versions 18.18, 20.8 or 21. Versions 14 and 16 are no longer supported. [#​3251](https://github.com/avajs/ava/issues/3251) [#​3216](https://github.com/avajs/ava/issues/3216) - When tests finish, worker threads or child processes are no longer exited through `proces.exit()`. If your test file does not exit on its own, the test run will time out. [#​3260](https://github.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://github.com/avajs/ava/issues/3218): - Watch mode can no longer be started via the `ava.config.*` or `package.json` configuration. - The `ignoredByWatcher` configuration has moved to the `watchMode` object, under the `ignoreChanges` key. - Watch mode now uses the built-in [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. This is supported on Linux in Node.js 20 or newer, and MacOS and Windows in Node.js 18 as well. There are [caveats](https://nodejs.org/api/fs.html#caveats) to keep in mind. - Failed assertions now throw, meaning that any subsequent code is not executed. This also impacts the type definitions. [#​3246](https://github.com/avajs/ava/issues/3246) - [Only native errors](https://nodejs.org/api/util.html#utiltypesisnativeerrorvalue) are now considered errors by the `t.throws()` and `t.throwsAsync()` assertions. [`Object.create(Error.prototype)` is **not** a native error](Object.create\(Error.prototype\)). [#​3229](https://github.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://github.com/avajs/ava/issues/3184): - If such modules export a default function, this function is now invoked. - Local files are loaded through `@ava/typescript` if necessary. #### Improvements ##### Rewritten watcher The watcher has been rewritten. It’s now built on [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. [`@vercel/nft`](https://github.com/vercel/nft) is used to perform static dependency analysis, supporting ESM and CJS imports for JavaScript & TypeScript source files. This is a huge improvement over the previous runtime tracking of CJS imports, which did not support ESM. Integration with [`@ava/typescript`](https://github.com/avajs/typescript) has been improved. The watcher can now detect a change to a TypeScript source file, then wait for the corresponding build output to change before re-running tests. The ignoredByWatcher configuration has moved to the watchMode object, under the ignoreChanges key. See [#​3218](https://github.com/avajs/ava/issues/3218) and [#​3257](https://github.com/avajs/ava/issues/3257). ##### Failed assertions now throw Assertions now throw a `TestFailure` error when they fail. This error is not exported or documented and should not be used or thrown manually. You cannot catch this error in order to recover from a failure, use `t.try()` instead. All assertions except for `t.throws()` and `t.throwsAsync()` now return `true` when they pass. This is useful for some of the assertions in TypeScript where they can be used as a type guard. Committing a failed `t.try()` result now also throws. See [#​3246](https://github.com/avajs/ava/issues/3246). ##### `t.throws()` and `t.throwsAsync()` can now expect any error By default, the thrown error (or rejection reason) must be a native error. You can change the assertion to expect any kind of error by setting `any: true` in the expectation object: ```js t.throws(() => { throw 'error' }, {any: true}) ``` See [#​3245](https://github.com/avajs/ava/issues/3245) by [@​adiSuper94](https://github.com/adiSuper94). ##### The `require` configuration is now more powerful It now loads ES modules. Local files are loaded through `@ava/typescript` if necessary, so you can also write these in TypeScript. If there is a default export function, it is invoked after loading. The function is awaited so it can do asynchronous setup before further modules are loaded. Arguments from the configuration can be passed to the function (as a \[[structured clone](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)]\(https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)). See [#​3184](https://github.com/avajs/ava/issues/3184) by [@​sculpt0r](https://github.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://github.com/avajs/ava/issues/3247) by [@​codetheweb](https://github.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://github.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://github.com/avajs/ava/issues/3220) #### New Contributors - [@​sculpt0r](https://github.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://github.com/avajs/ava/pull/3184) - [@​ZachHaber](https://github.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://github.com/avajs/ava/pull/3233) - [@​adiSuper94](https://github.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://github.com/avajs/ava/pull/3245) - [@​bricker](https://github.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://github.com/avajs/ava/pull/3250) **Full Changelog**: avajs/ava@v5.3.1...v6.0.0 </details> --- ### 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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/toeverything/AFFiNE). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44MS4zIiwidXBkYXRlZEluVmVyIjoiMzcuODEuMyIsInRhcmdldEJyYW5jaCI6ImNhbmFyeSJ9-->
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ava](https://avajs.dev) ([source](https://github.com/avajs/ava)) | [`5.3.1` -> `6.1.3`](https://renovatebot.com/diffs/npm/ava/5.3.1/6.1.3) | [![age](https://developer.mend.io/api/mc/badges/age/npm/ava/6.1.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/ava/6.1.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/ava/5.3.1/6.1.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/ava/5.3.1/6.1.3?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>avajs/ava (ava)</summary> ### [`v6.1.3`](https://github.com/avajs/ava/releases/tag/v6.1.3) [Compare Source](https://github.com/avajs/ava/compare/v6.1.2...v6.1.3) #### What's Changed - Include Node.js 22 in supported engines and test matrix by [@​lenovouser](https://github.com/lenovouser) in [https://github.com/avajs/ava/pull/3328](https://github.com/avajs/ava/pull/3328) - Add VS Code debugging instructions for Yarn PnP projects by [@​bitjson](https://github.com/bitjson) in [https://github.com/avajs/ava/pull/3317](https://github.com/avajs/ava/pull/3317) - Document `serial` configuration option by [@​turadg](https://github.com/turadg) in [https://github.com/avajs/ava/pull/3321](https://github.com/avajs/ava/pull/3321) #### New Contributors - [@​bitjson](https://github.com/bitjson) made their first contribution in [https://github.com/avajs/ava/pull/3317](https://github.com/avajs/ava/pull/3317) - [@​turadg](https://github.com/turadg) made their first contribution in [https://github.com/avajs/ava/pull/3321](https://github.com/avajs/ava/pull/3321) - [@​lenovouser](https://github.com/lenovouser) made their first contribution in [https://github.com/avajs/ava/pull/3328](https://github.com/avajs/ava/pull/3328) **Full Changelog**: avajs/ava@v6.1.2...v6.1.3 ### [`v6.1.2`](https://github.com/avajs/ava/releases/tag/v6.1.2) [Compare Source](https://github.com/avajs/ava/compare/v6.1.1...v6.1.2) #### What's Changed - Fix throws assertions rejecting falsy values when `any: true` by [@​gibson042](https://github.com/gibson042) in [https://github.com/avajs/ava/pull/3313](https://github.com/avajs/ava/pull/3313) **Full Changelog**: avajs/ava@v6.1.1...v6.1.2 ### [`v6.1.1`](https://github.com/avajs/ava/releases/tag/v6.1.1) [Compare Source](https://github.com/avajs/ava/compare/v6.1.0...v6.1.1) #### What's Changed - Fix 'previous failures' in watch mode always incrementing by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3297](https://github.com/avajs/ava/pull/3297) **Full Changelog**: avajs/ava@v6.1.0...v6.1.1 ### [`v6.1.0`](https://github.com/avajs/ava/releases/tag/v6.1.0) [Compare Source](https://github.com/avajs/ava/compare/v6.0.1...v6.1.0) ##### What's Changed - Implement `registerCompletionHandler()` by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3283](https://github.com/avajs/ava/pull/3283) AVA 6 expects test code to clean up gracefully when the tests are complete, allowing the test environment (worker thread or child process) to exit. If this does not happen, AVA will report a timeout. You can use `registerCompletionHandler()` to perform any other clean up (or indeed exit the process) after AVA has completed the test execution. See [the description here](https://github.com/avajs/ava/blob/main/docs/08-common-pitfalls.md#timeouts-because-a-file-failed-to-exit). - Fix potential bug with watch mode when no failed test files are written by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3287](https://github.com/avajs/ava/pull/3287) - Fix `ava/internal` ESM type module by [@​codetheweb](https://github.com/codetheweb) in [https://github.com/avajs/ava/pull/3292](https://github.com/avajs/ava/pull/3292) **Full Changelog**: avajs/ava@v6.0.1...v6.1.0 ### [`v6.0.1`](https://github.com/avajs/ava/releases/tag/v6.0.1) [Compare Source](https://github.com/avajs/ava/compare/v6.0.0...v6.0.1) #### What's Changed - Ensure watch mode works outside of its integration tests by [@​novemberborn](https://github.com/novemberborn) in [https://github.com/avajs/ava/pull/3273](https://github.com/avajs/ava/pull/3273) **Full Changelog**: avajs/ava@v6.0.0...v6.0.1 ### [`v6.0.0`](https://github.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://github.com/avajs/ava/compare/v5.3.1...v6.0.0) ##### Breaking Changes - AVA now requires Node.js versions 18.18, 20.8 or 21. Versions 14 and 16 are no longer supported. [#​3251](https://github.com/avajs/ava/issues/3251) [#​3216](https://github.com/avajs/ava/issues/3216) - When tests finish, worker threads or child processes are no longer exited through `proces.exit()`. If your test file does not exit on its own, the test run will time out. [#​3260](https://github.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://github.com/avajs/ava/issues/3218): - Watch mode can no longer be started via the `ava.config.*` or `package.json` configuration. - The `ignoredByWatcher` configuration has moved to the `watchMode` object, under the `ignoreChanges` key. - Watch mode now uses the built-in [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. This is supported on Linux in Node.js 20 or newer, and MacOS and Windows in Node.js 18 as well. There are [caveats](https://nodejs.org/api/fs.html#caveats) to keep in mind. - Failed assertions now throw, meaning that any subsequent code is not executed. This also impacts the type definitions. [#​3246](https://github.com/avajs/ava/issues/3246) - [Only native errors](https://nodejs.org/api/util.html#utiltypesisnativeerrorvalue) are now considered errors by the `t.throws()` and `t.throwsAsync()` assertions. [`Object.create(Error.prototype)` is **not** a native error](Object.create\(Error.prototype\)). [#​3229](https://github.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://github.com/avajs/ava/issues/3184): - If such modules export a default function, this function is now invoked. - Local files are loaded through `@ava/typescript` if necessary. ##### Improvements ##### Rewritten watcher The watcher has been rewritten. It’s now built on [`fs.watch()`](https://nodejs.org/api/fs.html#fswatchfilename-options-listener) in recursive mode. [`@vercel/nft`](https://github.com/vercel/nft) is used to perform static dependency analysis, supporting ESM and CJS imports for JavaScript & TypeScript source files. This is a huge improvement over the previous runtime tracking of CJS imports, which did not support ESM. Integration with [`@ava/typescript`](https://github.com/avajs/typescript) has been improved. The watcher can now detect a change to a TypeScript source file, then wait for the corresponding build output to change before re-running tests. The ignoredByWatcher configuration has moved to the watchMode object, under the ignoreChanges key. See [#​3218](https://github.com/avajs/ava/issues/3218) and [#​3257](https://github.com/avajs/ava/issues/3257). ##### Failed assertions now throw Assertions now throw a `TestFailure` error when they fail. This error is not exported or documented and should not be used or thrown manually. You cannot catch this error in order to recover from a failure, use `t.try()` instead. All assertions except for `t.throws()` and `t.throwsAsync()` now return `true` when they pass. This is useful for some of the assertions in TypeScript where they can be used as a type guard. Committing a failed `t.try()` result now also throws. See [#​3246](https://github.com/avajs/ava/issues/3246). ##### `t.throws()` and `t.throwsAsync()` can now expect any error By default, the thrown error (or rejection reason) must be a native error. You can change the assertion to expect any kind of error by setting `any: true` in the expectation object: ```js t.throws(() => { throw 'error' }, {any: true}) ``` See [#​3245](https://github.com/avajs/ava/issues/3245) by [@​adiSuper94](https://github.com/adiSuper94). ##### The `require` configuration is now more powerful It now loads ES modules. Local files are loaded through `@ava/typescript` if necessary, so you can also write these in TypeScript. If there is a default export function, it is invoked after loading. The function is awaited so it can do asynchronous setup before further modules are loaded. Arguments from the configuration can be passed to the function (as a \[[structured clone](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)]\(https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)). See [#​3184](https://github.com/avajs/ava/issues/3184) by [@​sculpt0r](https://github.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://github.com/avajs/ava/issues/3247) by [@​codetheweb](https://github.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://github.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://github.com/avajs/ava/issues/3220) ##### New Contributors - [@​sculpt0r](https://github.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://github.com/avajs/ava/pull/3184) - [@​ZachHaber](https://github.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://github.com/avajs/ava/pull/3233) - [@​adiSuper94](https://github.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://github.com/avajs/ava/pull/3245) - [@​bricker](https://github.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://github.com/avajs/ava/pull/3250) **Full Changelog**: avajs/ava@v5.3.1...v6.0.0 </details> --- ### 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. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/aepfli/markdownlint-rule-max-one-sentence-per-line). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy44MS4zIiwidXBkYXRlZEluVmVyIjoiMzcuMzQwLjEwIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
This will make ava easier to use with typescript and allow for removing redundant checks.
Since ava is a library and to reduce any type errors in existing projects, it's best to use the most exact approach to the typeguards as possible. For most use cases something akin to
actual is NonNullable<T>
is completely valid, but in this case it's very likely that things likeboolean
will be passed in.Unfortunately typescript doesn't have convenient
Falsy
orTruthy
utility types, so the best approach I've seen so far is to enumerate all possibilities (exceptNaN
) to make upFalsy
and then use that to ExcludeFalsy
types.NaN
doesn't have it's own type, so the typeguard won't be able to differentiate between them no matter what we do.