Internally AVA is now fully ESM. This is possible now that Node.js supports loading ES modules using require() calls and simplifies AVA's types and internals.
If you use AVA from a CommonJS project you'll have to update your imports:
-const test = require('ava');+const {default: test} = require('ava');
We expect an increasing number of projects to be ESM only. As per the above, CommonJS is still supported, but we don't expect cjs extensions to be used. The default file extensions are now js and mjs. Specify extensions: ['cjs', 'js', 'mjs'] for AVA to run test files with the cjs extension.
All test files (and those loaded through AVA's require config) are now loaded via import(). Use customization hooks for transpilation. The object form of the extensions configuration is no longer supported.
If you use AVA with @ava/typescript you must upgrade that package to v7.
New Features
There's two new test modifiers courtesy of@sindresorhus: test.skipIf() to skip a test based on a runtime condition. test.runIf() is the inverse: the test only runs when the condition is true.
test.skipIf(process.platform==='win32')('not on Windows',t=>{t.pass();});test.runIf(process.platform==='linux')('Linux only',t=>{t.pass();});
These work with other modifiers like .serial and .failing:
test.serial.skipIf(process.platform==='win32')('serial, not on Windows',t=>{t.pass();});test.failing.skipIf(process.platform==='win32')('expected failure, not on Windows',t=>{t.fail();});
Other Changes
Watch mode now ignores changes to *.tsbuildinfo files
TAP reporter is more defensive when restoring the original error name, thanks to @ninper00 in #3415
Reported errors when throwsAsync/notThrowsAsync are not awaited have been improved by @sindresorhus in #3436
Replace strip-ansi with node:util.stripVTControlCharacters by @fisker in #3403
Remove support for Node.js 18 and 23; require 20.19 or newer, 22.20 or newer or 24,12 or newer; update dependencies including transitive glob by @novemberborn in #3416
@mmulet did fantastic work to spearhead interactive watch mode filters. You can now filter test files by glob patterns, and tests by matching their titles. It's just like you already could from the CLI itself, but now without exiting AVA 🚀 #3372
As part of this work we've removed the "sticky" .only() behavior #3381
Examples
We've been remiss in merging #3335 which updates the examples to use AVA 6. It's done now, examples are up to date and it's all due to @tommy-mitchell 👏
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.
Fix potential bug with watch mode when no failed test files are written by @novemberborn in #3287
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. #3260
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() 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
Changes to modules loaded through the require configuration #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() 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.
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.
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:
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
AVA now requires Node.js 14.19, 16.15 or 18. #3043
Type definition distribution assumes at least TypeScript 4.7. #3041
We're now exporting types rather than interfaces. #3096
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
AVA now requires Node.js 14.19, 16.15 or 18. #3043
Type definition distribution is no longer compatible with TypeScript versions before 4.7. #3041
We're now exporting types rather than interfaces. #3096
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, or workerThreads: 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 or ava.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 the package.json file. ava.config.mjs is now supported.
test.macro() returns an object that can be used with test() and hooks. The t.context type is inherited from test. 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 🏞
Support for @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).
As a consequence, “enhanced assertions” are no longer available.
ava.config.js now follows the module type configured in package.json.
ava.config.* files may be found that are outside your project directory.
Tests and assertions 🥼
By default test files execute in worker threads, not child processes.
test.meta.file and test.meta.snapshotDirectory are now file URL strings.
Whitespace in test titles is now normalized. This could result in two tests being treated as having the same title, even though they are different in code. Thanks @KillyMXI!
test() and t.try() no longer take an array of test implementations. Use a loop instead.
The t.throws() and t.throwAsync() assertions can no longer be called with a null value for the expectations argument.
test.cb() and t.end() have been removed. Use async functions and util.promisify() instead.
t.teardown() now executes in last-in-first-out order.
Snapshots 📸
Snapshots recorded using earlier AVA versions are no longer recognized. Run npx ava -u to rebuild your snapshots after upgrading.
Snapshots no longer recognize React elements, instead we want to provide this functionality through a plugin interface
t.snapshot() no longer works in hooks.
t.snapshot() no longer takes an options argument allowing you to customize the snapshot ID.
TypeScript 🪛
The instanceOf expectation of t.throws() and t.throwsAsync() assertions must now be an Error constructor.
You’re expected to use test.macro() when declaring macros.
Implementation arguments now default to unknown.
Types have been renamed. Meta replaces MetaInterface, other types with Interface suffixes now use the Fn suffix. There may be some other changes too. 4b4b2f6
t.throws() and t.throwsAsync() return undefined when the assertion fails. The type definition now matches this behavior.
Our TypeScript definitions are now tested against TypeScript 4.4
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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:
Release Notes
avajs/ava (ava)v8.0.1
Compare Source
What's Changed
This release officially adds Node.js 26 support, with thanks to @novemberborn in #3450.
Per our policy, support for Node.js 25 has been removed.
Full Changelog: avajs/ava@v8.0.0...v8.0.1
v8.0.0
Compare Source
Breaking Changes
AVA now expects Node.js 22.20, 24.12 or newer.
Internally AVA is now fully ESM. This is possible now that Node.js supports loading ES modules using require() calls and simplifies AVA's types and internals.
If you use AVA from a CommonJS project you'll have to update your imports:
We expect an increasing number of projects to be ESM only. As per the above, CommonJS is still supported, but we don't expect cjs extensions to be used. The default file extensions are now js and mjs. Specify extensions: ['cjs', 'js', 'mjs'] for AVA to run test files with the cjs extension.
All test files (and those loaded through AVA's require config) are now loaded via import(). Use customization hooks for transpilation. The object form of the extensions configuration is no longer supported.
If you use AVA with @ava/typescript you must upgrade that package to v7.
New Features
There's two new test modifiers courtesy of @sindresorhus: test.skipIf() to skip a test based on a runtime condition. test.runIf() is the inverse: the test only runs when the condition is true.
These work with other modifiers like .serial and .failing:
Other Changes
New Contributors
Full Changelog: avajs/ava@v7.0.0...v8.0.0
v7.0.0
Compare Source
What's Changed
Full Changelog: avajs/ava@v6.4.1...v7.0.0
v6.4.1
Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v6.4.0...v6.4.1
v6.4.0
Compare Source
What's Changed
Interactive watch mode filters
@mmulet did fantastic work to spearhead interactive watch mode filters. You can now filter test files by glob patterns, and tests by matching their titles. It's just like you already could from the CLI itself, but now without exiting AVA 🚀 #3372
As part of this work we've removed the "sticky" .only() behavior #3381
Examples
We've been remiss in merging #3335 which updates the examples to use AVA 6. It's done now, examples are up to date and it's all due to @tommy-mitchell 👏
New Contributors
Full Changelog: avajs/ava@v6.3.0...v6.4.0
v6.3.0
Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v6.2.0...v6.3.0
v6.2.0
Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v6.1.3...v6.2.0
v6.1.3
Compare Source
What's Changed
New Contributors
Full Changelog: avajs/ava@v6.1.2...v6.1.3
v6.1.2
Compare Source
What's Changed
Full 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 #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.
Fix potential bug with watch mode when no failed test files are written by @novemberborn in #3287
Fix ava/internal ESM type module by @codetheweb in #3292
Full 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. #3260
Changes to watch mode #3218:
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() and t.throwsAsync() assertions. Object.create(Error.prototype) is not a native error. #3229
Changes to modules loaded through the require configuration #3184:
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, 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.
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:
See #3245 by @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)).
See #3184 by @sculpt0r.
Other changes worth noting
New Contributors
Full Changelog: avajs/ava@v5.3.1...v6.0.0
v5.3.1
Compare Source
What's Changed
Full Changelog: avajs/ava@v5.3.0...v5.3.1
v5.3.0
Compare Source
What's Changed
New 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 avaBreaking Changes
Improvements
New 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@nextBreaking Changes
Improvements
New 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
Full 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
Fixes
New 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 4
Compare Source
We're celebrating the new year with the official AVA 4 release! 🎊
npm install -D avaThe 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, or workerThreads: 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 or ava.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 the package.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 with test() and hooks. The t.context type is inherited from test. 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 🏞
Configuration 🗒
Tests and assertions 🥼
Snapshots 📸
TypeScript 🪛
Other changes 🤓
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: (UTC)
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.