-
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
Modernize require
config
#3184
Modernize require
config
#3184
Conversation
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.
@sculpt0r looks great!
lib/worker/base.js
Outdated
const mod = await load(path); | ||
mod.apply(null, ...options); |
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.
Need to check how this works with a mix of CJs and ESM. You may need to check if mod
is callable, and if not, access a callable default
.
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.
Thanks @novemberborn - I'll correct that :)
@novemberborn I've made requested changes :) Could you take a look at this PR again? For a while I have an idea, that in those options should be some parameter that tells you which part of loaded module I should "ava": {
"require": [
["@babel/register", {
"use": "exportedPartNameThatShouldBeCalled",
"params": {
"ignore": ["test/*"]
}
}]
]
} Not sure if such complication in config is needed? But if you want to load some third party module, that you can't control - you might want to call some specific part of it - without extracting it manually or making proxy file just for sake of re-export some part of it? |
lib/worker/base.js
Outdated
const loadedModule = await load(path); | ||
|
||
if (typeof loadedModule === 'function') { | ||
loadedModule.apply(null, ...options); |
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.
Let's await
this too, so it can do some async setup before we load the next module.
And below for default.apply
.
Do we care about the this
argument? Could loadedModule(...options)
instead.
I think a proxy file would be most appropriate. |
Hi @novemberborn, PR is ready for another verification:
|
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.
Would you be up to writing some tests? Best would be to create a folder in https://github.com/avajs/ava/tree/main/test and doing an integration style test.
lib/worker/base.js
Outdated
const loadedModule = await load(path); | ||
|
||
if (typeof loadedModule === 'function') { | ||
await loadedModule.apply(...options); |
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 uses the first option as the this
argument, so you'd always have to pass null
which seems odd. I think it's better like:
await loadedModule.apply(...options); | |
await loadedModule(...options); |
lib/worker/base.js
Outdated
if (typeof loadedModule === 'function') { | ||
await loadedModule.apply(...options); | ||
} else if (typeof loadedModule.default === 'function') { | ||
await loadedModule.default.apply(...options); |
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.
await loadedModule.default.apply(...options); | |
const {default: fn} = loadedModule; | |
await fn(...options); |
@novemberborn - could you explain me, why there are two different imports There is |
Most if not all of those are integration style tests, which run the repo code in a child process. They have lower level access to the test results which can then be asserted against. The repo code executes test fixtures which import from The |
Sorry for the long delay... I have some life-topics that needs to be handle. I think I'll finish tests soon. |
☝️ Rebased on the newest |
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.
@novemberborn Could you lead me a little bit more?
Is this test construction valid in any way? My idea was to invoke this default exported function and at least see sth in the logs - but it seems to not working the way I thought...
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.
The issue was that the test files were in a subdirectory, which means you have to specify the cwd
option.
Thanks @sculpt0r. I've done some more work on this, will push the commits soon. This code has been a little overlooked in the past few years. For example it only works with CJS modules! I think the answer is to only support local files, and then resolve their paths from the project directories. But that's a breaking change. So we'll have to leave this pending a little while longer until we're ready to cut for AVA 6. |
options.require
config propertyrequire
config
Tracking as a draft until we're ready for AVA 6. @sculpt0r what do you think of the changes? |
lib/worker/base.js
Outdated
const {default: fn} = loadedModule; | ||
await fn(...options); | ||
} else { | ||
channel.send({type: 'non-invokable-require-option'}); |
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'm not sure how important it could be to inform users that the thing
they want to import wont be called at all. For example if they try to use some local file and forgot to export sth that should be called?
It could be better to see an error instead of silent run when something is not working 🤔
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 it's necessarily the case that you want to execute a function, so making that required behavior isn't great either.
t.deepEqual(cjs.receivedArgs, ['goodbye']); | ||
}); | ||
|
||
test('ok to load for side-effects', async t => { |
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.
It took me some time to understand that this test case take adventage of requesting the side-effect
file before (during test loads config).
Maybe test case could be renamed? Sth like side-effects are execute at first with test loading
or sth similar?
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.
Yea I'm fine with renaming them, I didn't think too hard about it just wanted to get the tests done in the little time I had.
Thanks @novemberborn for explanation and commits. That are the tests I tried to implement earlier - but I wasn't able...
We talked before about such resolution - so definitely - if that is a breaking change - let's wait for next major release. I left two extra comments to the latest changes. Not sure how important they are - so I didn't touch the code. |
We'll also want to test and document that you can pass, say, maps and uint8arrays. And verify how that works with child processes. |
Alright, then I add those tests since I think I know how :) Thanks for the tip :) |
Nice! We may find that we always JSON serialize the options, in which case With All that said, just documenting the current behavior may suffice for now. |
- call directly - fallback to `default`
* Resolve from the project directory by joining paths, this means you can only provide relative files and not dependencies, which is a breaking change * Remove Babel recipe since it's now incompatible * Fix tests and add additional cases * Some refactoring
Rebased on the newest |
TBH - I can't find any place that serialize config in any way? Since the config is loaded - it's passed almost unchanged to the API (besides |
This means options are (de)serialized the same way as with worker threads, enabling us to use maps etc for require arguments.
Write a file into node_modules to give us a relative import.
You're right, it was not explicit. With worker threads we already relied on "advanced" serialization and I've pushed a commit to enable that for child processes as well. Plus tests. I also figured out a way to load regular dependencies, by writing a file into I think this is now mostly compatible with AVA 5, except for the invocation of the default export which is new and could still have surprising side-effects. |
@sculpt0r let me know what you think of my changes! |
@novemberborn - sorry for being late... As I can see - the PR is already merged. |
[![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://togithub.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://togithub.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://togithub.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://togithub.com/avajs/ava/issues/3251) [#​3216](https://togithub.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://togithub.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://togithub.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://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3218) and [#​3257](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3245) by [@​adiSuper94](https://togithub.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://togithub.com/avajs/ava/issues/3184) by [@​sculpt0r](https://togithub.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://togithub.com/avajs/ava/issues/3247) by [@​codetheweb](https://togithub.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://togithub.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://togithub.com/avajs/ava/issues/3220) #### New Contributors - [@​sculpt0r](https://togithub.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://togithub.com/avajs/ava/pull/3184) - [@​ZachHaber](https://togithub.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://togithub.com/avajs/ava/pull/3233) - [@​adiSuper94](https://togithub.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://togithub.com/avajs/ava/pull/3245) - [@​bricker](https://togithub.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://togithub.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://togithub.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://togithub.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://togithub.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://togithub.com/avajs/ava/issues/3251) [#​3216](https://togithub.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://togithub.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://togithub.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://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3218) and [#​3257](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3245) by [@​adiSuper94](https://togithub.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://togithub.com/avajs/ava/issues/3184) by [@​sculpt0r](https://togithub.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://togithub.com/avajs/ava/issues/3247) by [@​codetheweb](https://togithub.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://togithub.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://togithub.com/avajs/ava/issues/3220) #### New Contributors - [@​sculpt0r](https://togithub.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://togithub.com/avajs/ava/pull/3184) - [@​ZachHaber](https://togithub.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://togithub.com/avajs/ava/pull/3233) - [@​adiSuper94](https://togithub.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://togithub.com/avajs/ava/pull/3245) - [@​bricker](https://togithub.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://togithub.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://togithub.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://togithub.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://togithub.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://togithub.com/avajs/ava/issues/3251) [#​3216](https://togithub.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://togithub.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://togithub.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://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3218) and [#​3257](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3245) by [@​adiSuper94](https://togithub.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://togithub.com/avajs/ava/issues/3184) by [@​sculpt0r](https://togithub.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://togithub.com/avajs/ava/issues/3247) by [@​codetheweb](https://togithub.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://togithub.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://togithub.com/avajs/ava/issues/3220) #### New Contributors - [@​sculpt0r](https://togithub.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://togithub.com/avajs/ava/pull/3184) - [@​ZachHaber](https://togithub.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://togithub.com/avajs/ava/pull/3233) - [@​adiSuper94](https://togithub.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://togithub.com/avajs/ava/pull/3245) - [@​bricker](https://togithub.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://togithub.com/avajs/ava/pull/3250) **Full Changelog**: avajs/ava@v5.3.1...v6.0.0 ### [`v5.3.1`](https://togithub.com/avajs/ava/releases/tag/v5.3.1) [Compare Source](https://togithub.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://togithub.com/gibson042) in [https://github.com/avajs/ava/pull/3209](https://togithub.com/avajs/ava/pull/3209) - Fix circular selector detection in `t.like()` by [@​novemberborn](https://togithub.com/novemberborn) in [https://github.com/avajs/ava/pull/3212](https://togithub.com/avajs/ava/pull/3212) **Full Changelog**: avajs/ava@v5.3.0...v5.3.1 ### [`v5.3.0`](https://togithub.com/avajs/ava/releases/tag/v5.3.0) [Compare Source](https://togithub.com/avajs/ava/compare/v5.2.0...v5.3.0) #### What's Changed - Support arrays in `t.like()` assertions by [@​tommy-mitchell](https://togithub.com/tommy-mitchell) in [https://github.com/avajs/ava/pull/3185](https://togithub.com/avajs/ava/pull/3185) - Recognize typical assertion errors (`expect` and `assert`) and use their formatting by [@​Irvenae](https://togithub.com/Irvenae) in [https://github.com/avajs/ava/pull/3187](https://togithub.com/avajs/ava/pull/3187) #### New Contributors - [@​MartynasZilinskas](https://togithub.com/MartynasZilinskas) made their first contribution in [https://github.com/avajs/ava/pull/3172](https://togithub.com/avajs/ava/pull/3172) - [@​flovogt](https://togithub.com/flovogt) made their first contribution in [https://github.com/avajs/ava/pull/3194](https://togithub.com/avajs/ava/pull/3194) - [@​ondreian](https://togithub.com/ondreian) made their first contribution in [https://github.com/avajs/ava/pull/3192](https://togithub.com/avajs/ava/pull/3192) - [@​tommy-mitchell](https://togithub.com/tommy-mitchell) made their first contribution in [https://github.com/avajs/ava/pull/3185](https://togithub.com/avajs/ava/pull/3185) - [@​craigahobbs](https://togithub.com/craigahobbs) made their first contribution in [https://github.com/avajs/ava/pull/3198](https://togithub.com/avajs/ava/pull/3198) - [@​Irvenae](https://togithub.com/Irvenae) made their first contribution in [https://github.com/avajs/ava/pull/3187](https://togithub.com/avajs/ava/pull/3187) **Full Changelog**: avajs/ava@v5.2.0...v5.3.0 ### [`v5.2.0`](https://togithub.com/avajs/ava/releases/tag/v5.2.0) [Compare Source](https://togithub.com/avajs/ava/compare/v5.1.1...v5.2.0) #### What's Changed - Infer thrown error from expectations by [@​tao-cumplido](https://togithub.com/tao-cumplido) in [https://github.com/avajs/ava/pull/3156](https://togithub.com/avajs/ava/pull/3156) #### New Contributors - [@​tao-cumplido](https://togithub.com/tao-cumplido) made their first contribution in [https://github.com/avajs/ava/pull/3156](https://togithub.com/avajs/ava/pull/3156) **Full Changelog**: avajs/ava@v5.1.1...v5.2.0 ### [`v5.1.1`](https://togithub.com/avajs/ava/releases/tag/v5.1.1) [Compare Source](https://togithub.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://togithub.com/codetheweb) in [https://github.com/avajs/ava/pull/3149](https://togithub.com/avajs/ava/pull/3149) & [https://github.com/avajs/ava/pull/3151](https://togithub.com/avajs/ava/pull/3151) **Full Changelog**: avajs/ava@v5.1.0...v5.1.1 ### [`v5.1.0`](https://togithub.com/avajs/ava/releases/tag/v5.1.0) [Compare Source](https://togithub.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://togithub.com/kevo1ution) in [https://github.com/avajs/ava/pull/3125](https://togithub.com/avajs/ava/pull/3125) - Check for --config file extensions after they fail to load, allowing custom loaders by [@​panva](https://togithub.com/panva) in [https://github.com/avajs/ava/pull/3135](https://togithub.com/avajs/ava/pull/3135) ##### New Contributors - [@​kevo1ution](https://togithub.com/kevo1ution) made their first contribution in [https://github.com/avajs/ava/pull/3125](https://togithub.com/avajs/ava/pull/3125) - [@​panva](https://togithub.com/panva) made their first contribution in [https://github.com/avajs/ava/pull/3135](https://togithub.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://togithub.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://togithub.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://togithub.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://togithub.com/avajs/ava/issues/3251) [#​3216](https://togithub.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://togithub.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://togithub.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://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3218) and [#​3257](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3245) by [@​adiSuper94](https://togithub.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://togithub.com/avajs/ava/issues/3184) by [@​sculpt0r](https://togithub.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://togithub.com/avajs/ava/issues/3247) by [@​codetheweb](https://togithub.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://togithub.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://togithub.com/avajs/ava/issues/3220) #### New Contributors - [@​sculpt0r](https://togithub.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://togithub.com/avajs/ava/pull/3184) - [@​ZachHaber](https://togithub.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://togithub.com/avajs/ava/pull/3233) - [@​adiSuper94](https://togithub.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://togithub.com/avajs/ava/pull/3245) - [@​bricker](https://togithub.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://togithub.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://togithub.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://togithub.com/avajs/ava/releases/tag/v6.1.3) [Compare Source](https://togithub.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://togithub.com/lenovouser) in [https://github.com/avajs/ava/pull/3328](https://togithub.com/avajs/ava/pull/3328) - Add VS Code debugging instructions for Yarn PnP projects by [@​bitjson](https://togithub.com/bitjson) in [https://github.com/avajs/ava/pull/3317](https://togithub.com/avajs/ava/pull/3317) - Document `serial` configuration option by [@​turadg](https://togithub.com/turadg) in [https://github.com/avajs/ava/pull/3321](https://togithub.com/avajs/ava/pull/3321) #### New Contributors - [@​bitjson](https://togithub.com/bitjson) made their first contribution in [https://github.com/avajs/ava/pull/3317](https://togithub.com/avajs/ava/pull/3317) - [@​turadg](https://togithub.com/turadg) made their first contribution in [https://github.com/avajs/ava/pull/3321](https://togithub.com/avajs/ava/pull/3321) - [@​lenovouser](https://togithub.com/lenovouser) made their first contribution in [https://github.com/avajs/ava/pull/3328](https://togithub.com/avajs/ava/pull/3328) **Full Changelog**: avajs/ava@v6.1.2...v6.1.3 ### [`v6.1.2`](https://togithub.com/avajs/ava/releases/tag/v6.1.2) [Compare Source](https://togithub.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://togithub.com/gibson042) in [https://github.com/avajs/ava/pull/3313](https://togithub.com/avajs/ava/pull/3313) **Full Changelog**: avajs/ava@v6.1.1...v6.1.2 ### [`v6.1.1`](https://togithub.com/avajs/ava/releases/tag/v6.1.1) [Compare Source](https://togithub.com/avajs/ava/compare/v6.1.0...v6.1.1) #### What's Changed - Fix 'previous failures' in watch mode always incrementing by [@​novemberborn](https://togithub.com/novemberborn) in [https://github.com/avajs/ava/pull/3297](https://togithub.com/avajs/ava/pull/3297) **Full Changelog**: avajs/ava@v6.1.0...v6.1.1 ### [`v6.1.0`](https://togithub.com/avajs/ava/releases/tag/v6.1.0) [Compare Source](https://togithub.com/avajs/ava/compare/v6.0.1...v6.1.0) ##### What's Changed - Implement `registerCompletionHandler()` by [@​novemberborn](https://togithub.com/novemberborn) in [https://github.com/avajs/ava/pull/3283](https://togithub.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://togithub.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://togithub.com/novemberborn) in [https://github.com/avajs/ava/pull/3287](https://togithub.com/avajs/ava/pull/3287) - Fix `ava/internal` ESM type module by [@​codetheweb](https://togithub.com/codetheweb) in [https://github.com/avajs/ava/pull/3292](https://togithub.com/avajs/ava/pull/3292) **Full Changelog**: avajs/ava@v6.0.1...v6.1.0 ### [`v6.0.1`](https://togithub.com/avajs/ava/releases/tag/v6.0.1) [Compare Source](https://togithub.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://togithub.com/novemberborn) in [https://github.com/avajs/ava/pull/3273](https://togithub.com/avajs/ava/pull/3273) **Full Changelog**: avajs/ava@v6.0.0...v6.0.1 ### [`v6.0.0`](https://togithub.com/avajs/ava/releases/tag/v6.0.0) [Compare Source](https://togithub.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://togithub.com/avajs/ava/issues/3251) [#​3216](https://togithub.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://togithub.com/avajs/ava/issues/3260) - Changes to watch mode [#​3218](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3229) - Changes to modules loaded through the `require` configuration [#​3184](https://togithub.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://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3218) and [#​3257](https://togithub.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://togithub.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://togithub.com/avajs/ava/issues/3245) by [@​adiSuper94](https://togithub.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://togithub.com/avajs/ava/issues/3184) by [@​sculpt0r](https://togithub.com/sculpt0r). ##### Other changes worth noting - Internal events can now be observed (experimentally). See [#​3247](https://togithub.com/avajs/ava/issues/3247) by [@​codetheweb](https://togithub.com/codetheweb). It’s experimental and undocumented. - You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#​3221](https://togithub.com/avajs/ava/issues/3221) - Code coverage is flushed to disk at opportune moments. [#​3220](https://togithub.com/avajs/ava/issues/3220) ##### New Contributors - [@​sculpt0r](https://togithub.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://togithub.com/avajs/ava/pull/3184) - [@​ZachHaber](https://togithub.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://togithub.com/avajs/ava/pull/3233) - [@​adiSuper94](https://togithub.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://togithub.com/avajs/ava/pull/3245) - [@​bricker](https://togithub.com/bricker) made their first contribution in [https://github.com/avajs/ava/pull/3250](https://togithub.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>
Handled complex
options.require
in api path resolver and also in actual loader inside worker/base.Could you also give some feedback if that is the right direction?
Closes: #1666
IssueHunt Summary
Referenced issues
This pull request has been submitted to: