Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
3.15.0
->6.2.0
Release Notes
avajs/ava (ava)
v6.2.0
Compare Source
What's Changed
filterNodeArgumentsForWorkerThreads
option in https://github.com/avajs/ava/pull/3336New Contributors
Full Changelog: avajs/ava@v6.1.3...v6.2.0
v6.1.3
Compare Source
What's Changed
serial
configuration option by @turadg in https://github.com/avajs/ava/pull/3321New Contributors
Full Changelog: avajs/ava@v6.1.2...v6.1.3
v6.1.2
Compare Source
What's Changed
any: true
by @gibson042 in https://github.com/avajs/ava/pull/3313Full Changelog: avajs/ava@v6.1.1...v6.1.2
v6.1.1
Compare Source
What's Changed
Full Changelog: avajs/ava@v6.1.0...v6.1.1
v6.1.0
Compare Source
What's Changed
Implement
registerCompletionHandler()
by @novemberborn in https://github.com/avajs/ava/pull/3283AVA 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.Fix potential bug with watch mode when no failed test files are written by @novemberborn in https://github.com/avajs/ava/pull/3287
Fix
ava/internal
ESM type module by @codetheweb in https://github.com/avajs/ava/pull/3292Full Changelog: avajs/ava@v6.0.1...v6.1.0
v6.0.1
Compare Source
What's Changed
Full Changelog: avajs/ava@v6.0.0...v6.0.1
v6.0.0
Compare Source
Breaking Changes
AVA now requires Node.js versions 18.18, 20.8 or 21. Versions 14 and 16 are no longer supported. #3251 #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. #3260Changes to watch mode #3218:
ava.config.*
orpackage.json
configuration.ignoredByWatcher
configuration has moved to thewatchMode
object, under theignoreChanges
key.fs.watch()
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 to keep in mind.Failed assertions now throw, meaning that any subsequent code is not executed. This also impacts the type definitions. #3246
Only native errors are now considered errors by the
t.throws()
andt.throwsAsync()
assertions.Object.create(Error.prototype)
is not a native error. #3229Changes to modules loaded through the
require
configuration #3184:@ava/typescript
if necessary.Improvements
Rewritten watcher
The watcher has been rewritten. It’s now built on
fs.watch()
in recursive mode.@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
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 and #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, uset.try()
instead.All assertions except for
t.throws()
andt.throwsAsync()
now returntrue
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.
t.throws()
andt.throwsAsync()
can now expect any errorBy 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:See #3245 by @adiSuper94.
The
require
configuration is now more powerfulIt 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)).
See #3184 by @sculpt0r.
Other changes worth noting
t.timeout.clear()
to restore a previoust.timeout()
. #3221New Contributors
Full Changelog: avajs/ava@v5.3.1...v6.0.0
v5.3.1
Compare Source
What's Changed
t.like()
to support Symbol keys and ignore non-enumerable properties by @gibson042 in https://github.com/avajs/ava/pull/3209t.like()
by @novemberborn in https://github.com/avajs/ava/pull/3212Full Changelog: avajs/ava@v5.3.0...v5.3.1
v5.3.0
Compare Source
What's Changed
t.like()
assertions by @tommy-mitchell in https://github.com/avajs/ava/pull/3185expect
andassert
) and use their formatting by @Irvenae in https://github.com/avajs/ava/pull/3187New Contributors
Full Changelog: avajs/ava@v5.2.0...v5.3.0
v5.2.0
Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v5.1.1...v5.2.0
v5.1.1
Compare Source
What's Changed
Full Changelog: avajs/ava@v5.1.0...v5.1.1
v5.1.0
Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v5.0.1...v5.1.0
v5.0.1
Compare Source
Despite the major version bump this is a relatively minor release. Node.js 12 is no longer supported. The type definitions are now distributed to be compatible with TypeScript 4.7 or newer.
npm install --save-dev ava
Breaking Changes
Improvements
process.exit()
called from tests by @gibson042 in https://github.com/avajs/ava/pull/3080os.cpus()
returning an empty array on unsupported platforms by @catink123 in https://github.com/avajs/ava/pull/3095New Contributors
Full Changelog: avajs/ava@v4.3.3...v5.0.1
v5.0.0
Compare Source
Despite the major version bump this is a relatively minor release. Node.js 12 is no longer supported. The type definitions are now distributed to be compatible with TypeScript 4.7 or newer.
It's available as a pre-release under the
next
tag for the next few weeks:npm install --save-dev ava@next
Breaking Changes
Improvements
process.exit()
called from tests by @gibson042 in https://github.com/avajs/ava/pull/3080os.cpus()
returning an empty array on unsupported platforms by @catink123 in https://github.com/avajs/ava/pull/3095New Contributors
Full Changelog: avajs/ava@v4.3.3...v5.0.0
v4.3.3
Compare Source
Add compatibility with Node.js 18.8, thanks @Brooooooklyn #3091.
Full Changelog: avajs/ava@v4.3.1...v4.3.3
v4.3.2
Compare Source
v4.3.1
Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v4.3.0...v4.3.1
v4.3.0
Compare Source
What's Changed
throws
andthrowsAsync
assertions now take a function to test error messages, by @il3ven in https://github.com/avajs/ava/pull/2995t.log()
messages, by @il3ven in https://github.com/avajs/ava/pull/3013Full Changelog: avajs/ava@v4.2.0...v4.3.0
v4.2.0
Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v4.1.0...v4.2.0
v4.1.0
Compare Source
New features
sortTestFiles()
inava.config.js
files by @erezrokah in https://github.com/avajs/ava/pull/2968ava.config.json
files are encountered by @razor-x in https://github.com/avajs/ava/pull/2962deepEqual
assertion by @RebeccaStevens in https://github.com/avajs/ava/pull/2969Fixes
ava --version
works again by @novemberborn in https://github.com/avajs/ava/pull/2961New Contributors
Full Changelog: avajs/ava@v4.0.1...v4.1.0
v4.0.1
Compare Source
What's Changed
Full Changelog: avajs/ava@v4.0.0...v4.0.1
v4.0.0
: AVA 4Compare Source
We're celebrating the new year with the official AVA 4 release! 🎊
npm install -D ava
The cool new stuff 🆒
Worker threads 🧑💼
By default, test files are now run in worker threads! Huge thanks to @dnlup for landing this.
Test files should run a little quicker, since it's easier to spin up a worker thread than a child process. You can use
--no-worker-threads
on the command line, orworkerThreads: false
in your AVA configuration, to fall back to using child processes.Shared workers are no longer experimental 🎊
Shared workers are no longer experimental. This is a powerful feature that loads a program in a worker thread in AVA's main process and then communicate with code running in the test workers. This enables your tests to better utilize shared resources during a test run, as well as providing opportunities to set up these resources before tests start (or clean them up after).
When you use watch mode, shared workers remain loaded across runs.
Improved test selection 🤳
AVA selects test files based on your
package.json
orava.config.*
configuration files. When used on the CLI you can then provide patterns to select a subset of these files.You can now pass a folder and AVA will select the test files contained therein. Or you can provide a specific JavaScript file and AVA will run it even if it wasn’t selected by your configuration.
If AVA finds files based on the configuration, but none of those were selected to the CLI arguments, it now prints a warning.
Better monorepo support 🚝
AVA now looks for
ava.config.*
files in parent directories, until it finds a directory with a.git
directory (or file). This lets you specify AVA configuration at the top of your monorepo and still run AVA from within each package.New snapshot format 📸
@ninevra has worked tirelessly on landing a new snapshot format. It contains all information necessary to regenerate the report file. This allows for snapshots to be updated even if tests or assertions are skipped.
Previously failing test files run first 🏃
AVA now records which test files failed in the previous run. It then prioritizes testing these files when you run AVA again. Thanks @bunysae!
ESM support 🤾
AVA 4 comes with full ES module support. Both ESM and CJS entrypoints are provided so that you can use it no matter how you manage your project.
The
ava.config.js
file is now treated as CJS or ESM depending on module type configured in thepackage.json
file.ava.config.mjs
is now supported.If you use JavaScript files with non-standard extensions you can configure AVA to import them.
Note that dependency tracking in watch mode does not yet work with ES modules.
Dedicated macro factory with type inference 🏭
test.macro()
returns an object that can be used withtest()
and hooks. Thet.context
type is inherited fromtest
. When used with TypeScript this gives much better type inference.Like with AVA 3, regular functions that also have a
title
property that is a string-returning function are supported. However the type checking won’t be as good.Source maps 🗺
AVA now uses the source map support that’s built in to Node.js itself. This should give better stack traces. However we’re not sure yet what happens if you load a program that automatically modifies stack traces.
Line number selection (where
npx ava test.js:5
runs the test at line 5) now uses source maps and so should work better with TypeScript files.Assertions as type guards 💂
Most assertions now return a boolean indicating whether they passed. If you use AVA with TypeScript, you can use this as a type guard. Thanks @jmarkham828!
(This is not supported for
t.snapshot()
and the "throws" assertions.)Breaking changes 💥
AVA 4 requires at least Node.js 12.22, 14.17, 16.4 or 17. Node.js 10 is no longer supported.
If installed globally, AVA will no longer use any locally installed version. Install locally and run with
npx ava
instead. When running test files from another project that also has AVA installed, those test files will now fail to run (because they'll try and use that other AVA version).Ecosystem 🏞
@ava/babel
has been removed. We haven’t seen enough contributions to that package to recommend it for AVA 4. We’d be open to reinstating it in the future (just as we’d be open to support any other compilation provider).avajs/typescript@1.1
or newer.esm
package has been removed.Configuration 🗒
ava.config.js
now follows the module type configured inpackage.json
.ava.config.*
files may be found that are outside your project directory.Tests and assertions 🥼
test.meta.file
andtest.meta.snapshotDirectory
are now file URL strings.test()
andt.try()
no longer take an array of test implementations. Use a loop instead.t.throws()
andt.throwAsync()
assertions can no longer be called with anull
value for the expectations argument.test.cb()
andt.end()
have been removed. Use async functions andutil.promisify()
instead.t.teardown()
now executes in last-in-first-out order.Snapshots 📸
npx ava -u
to rebuild your snapshots after upgrading.t.snapshot()
no longer works in hooks.t.snapshot()
no longer takes an options argument allowing you to customize the snapshot ID.TypeScript 🪛
instanceOf
expectation oft.throws()
andt.throwsAsync()
assertions must now be anError
constructor.test.macro()
when declaring macros.unknown
.Meta
replacesMetaInterface
, other types withInterface
suffixes now use theFn
suffix. There may be some other changes too.4b4b2f6
t.throws()
andt.throwsAsync()
returnundefined
when the assertion fails. The type definition now matches this behavior.Other changes 🤓
--config
argument may now point to a file that is not alongside thepackage.json
file.t.timeout()
, AVA itself won’t time out until your test does. Thanks @OhYash!.test
and.spec
extensions from file names, as well astest-
prefixes.New Contributors
Full changelog since RC 1: avajs/ava@v4.0.0-rc.1...v4.0.0
Full changelog since AVA 3: avajs/ava@v3.15.0...v4.0.0
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.