Skip to content
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

Merged
merged 18 commits into from
Jun 25, 2023
Merged

Modernize require config #3184

merged 18 commits into from
Jun 25, 2023

Conversation

sculpt0r
Copy link
Contributor

@sculpt0r sculpt0r commented Mar 9, 2023

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:


Copy link
Member

@novemberborn novemberborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sculpt0r looks great!

Comment on lines 184 to 185
const mod = await load(path);
mod.apply(null, ...options);
Copy link
Member

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.

Copy link
Contributor Author

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 :)

@sculpt0r
Copy link
Contributor Author

sculpt0r commented Mar 13, 2023

@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 invoke 🤔 Like setting:

"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?

const loadedModule = await load(path);

if (typeof loadedModule === 'function') {
loadedModule.apply(null, ...options);
Copy link
Member

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.

@novemberborn
Copy link
Member

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?

I think a proxy file would be most appropriate.

@sculpt0r
Copy link
Contributor Author

Hi @novemberborn, PR is ready for another verification:

  • both invocations are now await'ed
  • removed null as this argument in favour of using destructed options. Previously I thought that maybe we shouldn't mess with this at all at config level. But this solutions allows users to pass null if they don't want that.

@sculpt0r sculpt0r requested a review from novemberborn March 17, 2023 19:11
Copy link
Member

@novemberborn novemberborn left a 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.

const loadedModule = await load(path);

if (typeof loadedModule === 'function') {
await loadedModule.apply(...options);
Copy link
Member

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:

Suggested change
await loadedModule.apply(...options);
await loadedModule(...options);

if (typeof loadedModule === 'function') {
await loadedModule.apply(...options);
} else if (typeof loadedModule.default === 'function') {
await loadedModule.default.apply(...options);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
await loadedModule.default.apply(...options);
const {default: fn} = loadedModule;
await fn(...options);

@sculpt0r
Copy link
Contributor Author

@novemberborn - could you explain me, why there are two different imports from ava in tests?

There is import test from '@ava/test'; and import test from 'ava'; which one should I use?

@novemberborn
Copy link
Member

@ava/test is a little wrapper around an npm-hosted stable version of AVA. You use it for the tests that test the code in the repo. E.g. https://github.com/avajs/ava/blob/main/test/assertions/test.js.

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 ava itself, e.g. https://github.com/avajs/ava/blob/main/test/assertions/fixtures/happy-path.js.

The ava import is symlinked here https://github.com/avajs/ava/tree/main/test/node_modules.

@sculpt0r
Copy link
Contributor Author

sculpt0r commented May 5, 2023

Sorry for the long delay... I have some life-topics that needs to be handle.

I think I'll finish tests soon.

@sculpt0r
Copy link
Contributor Author

☝️ Rebased on the newest main branch.

Copy link
Contributor Author

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...

Copy link
Member

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.

@novemberborn
Copy link
Member

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.

@novemberborn novemberborn changed the title feat: handle complex options.require config property Modernize require config May 21, 2023
@novemberborn novemberborn added the breaking requires a SemVer major release label May 21, 2023
@novemberborn novemberborn marked this pull request as draft May 21, 2023 16:33
@novemberborn
Copy link
Member

Tracking as a draft until we're ready for AVA 6.

@sculpt0r what do you think of the changes?

const {default: fn} = loadedModule;
await fn(...options);
} else {
channel.send({type: 'non-invokable-require-option'});
Copy link
Contributor Author

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 🤔

Copy link
Member

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 => {
Copy link
Contributor Author

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?

Copy link
Member

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.

@sculpt0r
Copy link
Contributor Author

Thanks @novemberborn for explanation and commits. That are the tests I tried to implement earlier - but I wasn't able...

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.

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.

@novemberborn
Copy link
Member

We'll also want to test and document that you can pass, say, maps and uint8arrays. And verify how that works with child processes.

@sculpt0r
Copy link
Contributor Author

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 :)

@novemberborn
Copy link
Member

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 Map won't survive the round trip. That's fine, but it'd be nicer to v8 serialize/deserialize. With worker threads that may be the default behavior, but for child processes that may require a change. In short I'm not really sure what we do at the moment. I think all other options are JSON compatible so it hasn't come up before.

With ava.config.* files you should be able to create maps for the require option.

All that said, just documenting the current behavior may suffice for now.

novemberborn and others added 3 commits June 16, 2023 12:42
* 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
@sculpt0r
Copy link
Contributor Author

Rebased on the newest main.

@sculpt0r
Copy link
Contributor Author

All that said, just documenting the current behavior may suffice for now.

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 arrify usage). And then the modules are loaded. So right now, I'm not sure if I should further investigate that for documenting purposes? In other words: do You think this PR requires more work? Or just until the 6.0 is ready - just make sure it didn't break anything?

@novemberborn
Copy link
Member

I can't find any place that serialize config in any way?

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 node_modules from which we can then do the import().

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.

@novemberborn novemberborn marked this pull request as ready for review June 21, 2023 16:03
@novemberborn
Copy link
Member

@sculpt0r let me know what you think of my changes! main has now dropped Node.js 14 so this can be merged.

@novemberborn novemberborn merged commit 4dc385b into avajs:main Jun 25, 2023
@sculpt0r sculpt0r deleted the t/1666 branch June 26, 2023 09:35
@sculpt0r
Copy link
Contributor Author

@novemberborn - sorry for being late... As I can see - the PR is already merged.

Brooooooklyn referenced this pull request in toeverything/AFFiNE Dec 5, 2023
[![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. [#&#8203;3251](https://togithub.com/avajs/ava/issues/3251) [#&#8203;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. [#&#8203;3260](https://togithub.com/avajs/ava/issues/3260)

-   Changes to watch mode [#&#8203;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. [#&#8203;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\)). [#&#8203;3229](https://togithub.com/avajs/ava/issues/3229)

-   Changes to modules loaded through the `require` configuration [#&#8203;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 [#&#8203;3218](https://togithub.com/avajs/ava/issues/3218) and [#&#8203;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 [#&#8203;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 [#&#8203;3245](https://togithub.com/avajs/ava/issues/3245) by [@&#8203;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 [#&#8203;3184](https://togithub.com/avajs/ava/issues/3184) by [@&#8203;sculpt0r](https://togithub.com/sculpt0r).

##### Other changes worth noting

-   Internal events can now be observed (experimentally). See [#&#8203;3247](https://togithub.com/avajs/ava/issues/3247) by [@&#8203;codetheweb](https://togithub.com/codetheweb). It’s experimental and undocumented.
-   You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#&#8203;3221](https://togithub.com/avajs/ava/issues/3221)
-   Code coverage is flushed to disk at opportune moments. [#&#8203;3220](https://togithub.com/avajs/ava/issues/3220)

#### New Contributors

-   [@&#8203;sculpt0r](https://togithub.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://togithub.com/avajs/ava/pull/3184)
-   [@&#8203;ZachHaber](https://togithub.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://togithub.com/avajs/ava/pull/3233)
-   [@&#8203;adiSuper94](https://togithub.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://togithub.com/avajs/ava/pull/3245)
-   [@&#8203;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-->
Brooooooklyn referenced this pull request in toeverything/AFFiNE Dec 5, 2023
[![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. [#&#8203;3251](https://togithub.com/avajs/ava/issues/3251) [#&#8203;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. [#&#8203;3260](https://togithub.com/avajs/ava/issues/3260)

-   Changes to watch mode [#&#8203;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. [#&#8203;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\)). [#&#8203;3229](https://togithub.com/avajs/ava/issues/3229)

-   Changes to modules loaded through the `require` configuration [#&#8203;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 [#&#8203;3218](https://togithub.com/avajs/ava/issues/3218) and [#&#8203;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 [#&#8203;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 [#&#8203;3245](https://togithub.com/avajs/ava/issues/3245) by [@&#8203;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 [#&#8203;3184](https://togithub.com/avajs/ava/issues/3184) by [@&#8203;sculpt0r](https://togithub.com/sculpt0r).

##### Other changes worth noting

-   Internal events can now be observed (experimentally). See [#&#8203;3247](https://togithub.com/avajs/ava/issues/3247) by [@&#8203;codetheweb](https://togithub.com/codetheweb). It’s experimental and undocumented.
-   You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#&#8203;3221](https://togithub.com/avajs/ava/issues/3221)
-   Code coverage is flushed to disk at opportune moments. [#&#8203;3220](https://togithub.com/avajs/ava/issues/3220)

#### New Contributors

-   [@&#8203;sculpt0r](https://togithub.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://togithub.com/avajs/ava/pull/3184)
-   [@&#8203;ZachHaber](https://togithub.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://togithub.com/avajs/ava/pull/3233)
-   [@&#8203;adiSuper94](https://togithub.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://togithub.com/avajs/ava/pull/3245)
-   [@&#8203;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-->
gr2m referenced this pull request in gr2m/github-project Dec 5, 2023
[![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.
[#&#8203;3251](https://togithub.com/avajs/ava/issues/3251)
[#&#8203;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.
[#&#8203;3260](https://togithub.com/avajs/ava/issues/3260)

- Changes to watch mode
[#&#8203;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.
[#&#8203;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\)).
[#&#8203;3229](https://togithub.com/avajs/ava/issues/3229)

- Changes to modules loaded through the `require` configuration
[#&#8203;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 [#&#8203;3218](https://togithub.com/avajs/ava/issues/3218) and
[#&#8203;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 [#&#8203;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 [#&#8203;3245](https://togithub.com/avajs/ava/issues/3245) by
[@&#8203;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 [#&#8203;3184](https://togithub.com/avajs/ava/issues/3184) by
[@&#8203;sculpt0r](https://togithub.com/sculpt0r).

##### Other changes worth noting

- Internal events can now be observed (experimentally). See
[#&#8203;3247](https://togithub.com/avajs/ava/issues/3247) by
[@&#8203;codetheweb](https://togithub.com/codetheweb). It’s experimental
and undocumented.
- You can now use `t.timeout.clear()` to restore a previous
`t.timeout()`.
[#&#8203;3221](https://togithub.com/avajs/ava/issues/3221)
- Code coverage is flushed to disk at opportune moments.
[#&#8203;3220](https://togithub.com/avajs/ava/issues/3220)

#### New Contributors

- [@&#8203;sculpt0r](https://togithub.com/sculpt0r) made their first
contribution in
[https://github.com/avajs/ava/pull/3184](https://togithub.com/avajs/ava/pull/3184)
- [@&#8203;ZachHaber](https://togithub.com/ZachHaber) made their first
contribution in
[https://github.com/avajs/ava/pull/3233](https://togithub.com/avajs/ava/pull/3233)
- [@&#8203;adiSuper94](https://togithub.com/adiSuper94) made their first
contribution in
[https://github.com/avajs/ava/pull/3245](https://togithub.com/avajs/ava/pull/3245)
- [@&#8203;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 [@&#8203;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
[@&#8203;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
[@&#8203;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 [@&#8203;Irvenae](https://togithub.com/Irvenae) in
[https://github.com/avajs/ava/pull/3187](https://togithub.com/avajs/ava/pull/3187)

#### New Contributors

- [@&#8203;MartynasZilinskas](https://togithub.com/MartynasZilinskas)
made their first contribution in
[https://github.com/avajs/ava/pull/3172](https://togithub.com/avajs/ava/pull/3172)
- [@&#8203;flovogt](https://togithub.com/flovogt) made their first
contribution in
[https://github.com/avajs/ava/pull/3194](https://togithub.com/avajs/ava/pull/3194)
- [@&#8203;ondreian](https://togithub.com/ondreian) made their first
contribution in
[https://github.com/avajs/ava/pull/3192](https://togithub.com/avajs/ava/pull/3192)
- [@&#8203;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)
- [@&#8203;craigahobbs](https://togithub.com/craigahobbs) made their
first contribution in
[https://github.com/avajs/ava/pull/3198](https://togithub.com/avajs/ava/pull/3198)
- [@&#8203;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
[@&#8203;tao-cumplido](https://togithub.com/tao-cumplido) in
[https://github.com/avajs/ava/pull/3156](https://togithub.com/avajs/ava/pull/3156)

#### New Contributors

- [@&#8203;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 [@&#8203;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
[@&#8203;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 [@&#8203;panva](https://togithub.com/panva) in
[https://github.com/avajs/ava/pull/3135](https://togithub.com/avajs/ava/pull/3135)

##### New Contributors

- [@&#8203;kevo1ution](https://togithub.com/kevo1ution) made their first
contribution in
[https://github.com/avajs/ava/pull/3125](https://togithub.com/avajs/ava/pull/3125)
- [@&#8203;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>
darkskygit referenced this pull request in toeverything/AFFiNE Dec 7, 2023
[![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. [#&#8203;3251](https://togithub.com/avajs/ava/issues/3251) [#&#8203;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. [#&#8203;3260](https://togithub.com/avajs/ava/issues/3260)

-   Changes to watch mode [#&#8203;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. [#&#8203;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\)). [#&#8203;3229](https://togithub.com/avajs/ava/issues/3229)

-   Changes to modules loaded through the `require` configuration [#&#8203;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 [#&#8203;3218](https://togithub.com/avajs/ava/issues/3218) and [#&#8203;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 [#&#8203;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 [#&#8203;3245](https://togithub.com/avajs/ava/issues/3245) by [@&#8203;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 [#&#8203;3184](https://togithub.com/avajs/ava/issues/3184) by [@&#8203;sculpt0r](https://togithub.com/sculpt0r).

##### Other changes worth noting

-   Internal events can now be observed (experimentally). See [#&#8203;3247](https://togithub.com/avajs/ava/issues/3247) by [@&#8203;codetheweb](https://togithub.com/codetheweb). It’s experimental and undocumented.
-   You can now use `t.timeout.clear()` to restore a previous `t.timeout()`. [#&#8203;3221](https://togithub.com/avajs/ava/issues/3221)
-   Code coverage is flushed to disk at opportune moments. [#&#8203;3220](https://togithub.com/avajs/ava/issues/3220)

#### New Contributors

-   [@&#8203;sculpt0r](https://togithub.com/sculpt0r) made their first contribution in [https://github.com/avajs/ava/pull/3184](https://togithub.com/avajs/ava/pull/3184)
-   [@&#8203;ZachHaber](https://togithub.com/ZachHaber) made their first contribution in [https://github.com/avajs/ava/pull/3233](https://togithub.com/avajs/ava/pull/3233)
-   [@&#8203;adiSuper94](https://togithub.com/adiSuper94) made their first contribution in [https://github.com/avajs/ava/pull/3245](https://togithub.com/avajs/ava/pull/3245)
-   [@&#8203;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-->
aepfli referenced this pull request in aepfli/markdownlint-rule-max-one-sentence-per-line Jul 8, 2024
[![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
[@&#8203;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
[@&#8203;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
[@&#8203;turadg](https://togithub.com/turadg) in
[https://github.com/avajs/ava/pull/3321](https://togithub.com/avajs/ava/pull/3321)

#### New Contributors

- [@&#8203;bitjson](https://togithub.com/bitjson) made their first
contribution in
[https://github.com/avajs/ava/pull/3317](https://togithub.com/avajs/ava/pull/3317)
- [@&#8203;turadg](https://togithub.com/turadg) made their first
contribution in
[https://github.com/avajs/ava/pull/3321](https://togithub.com/avajs/ava/pull/3321)
- [@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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 [@&#8203;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
[@&#8203;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
[@&#8203;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.
[#&#8203;3251](https://togithub.com/avajs/ava/issues/3251)
[#&#8203;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.
[#&#8203;3260](https://togithub.com/avajs/ava/issues/3260)

- Changes to watch mode
[#&#8203;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.
[#&#8203;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\)).
[#&#8203;3229](https://togithub.com/avajs/ava/issues/3229)

- Changes to modules loaded through the `require` configuration
[#&#8203;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 [#&#8203;3218](https://togithub.com/avajs/ava/issues/3218) and
[#&#8203;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 [#&#8203;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 [#&#8203;3245](https://togithub.com/avajs/ava/issues/3245) by
[@&#8203;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 [#&#8203;3184](https://togithub.com/avajs/ava/issues/3184) by
[@&#8203;sculpt0r](https://togithub.com/sculpt0r).

##### Other changes worth noting

- Internal events can now be observed (experimentally). See
[#&#8203;3247](https://togithub.com/avajs/ava/issues/3247) by
[@&#8203;codetheweb](https://togithub.com/codetheweb). It’s experimental
and undocumented.
- You can now use `t.timeout.clear()` to restore a previous
`t.timeout()`.
[#&#8203;3221](https://togithub.com/avajs/ava/issues/3221)
- Code coverage is flushed to disk at opportune moments.
[#&#8203;3220](https://togithub.com/avajs/ava/issues/3220)

##### New Contributors

- [@&#8203;sculpt0r](https://togithub.com/sculpt0r) made their first
contribution in
[https://github.com/avajs/ava/pull/3184](https://togithub.com/avajs/ava/pull/3184)
- [@&#8203;ZachHaber](https://togithub.com/ZachHaber) made their first
contribution in
[https://github.com/avajs/ava/pull/3233](https://togithub.com/avajs/ava/pull/3233)
- [@&#8203;adiSuper94](https://togithub.com/adiSuper94) made their first
contribution in
[https://github.com/avajs/ava/pull/3245](https://togithub.com/avajs/ava/pull/3245)
- [@&#8203;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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking requires a SemVer major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support arguments in "require" configuration
2 participants