Node.js test runner that lets you develop with confidence 🚀
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
process.exit()
called from tests by @gibson042 in https://github.com/avajs/ava/pull/3080
os.cpus()
returning an empty array on unsupported platforms by @catink123 in https://github.com/avajs/ava/pull/3095
Full Changelog: https://github.com/avajs/ava/compare/v4.3.3...v5.0.1
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
process.exit()
called from tests by @gibson042 in https://github.com/avajs/ava/pull/3080
os.cpus()
returning an empty array on unsupported platforms by @catink123 in https://github.com/avajs/ava/pull/3095
Full Changelog: https://github.com/avajs/ava/compare/v4.3.3...v5.0.0
Add compatibility with Node.js 18.8, thanks @Brooooooklyn #3091.
Full Changelog: https://github.com/avajs/ava/compare/v4.3.1...v4.3.3
Full Changelog: https://github.com/avajs/ava/compare/v4.3.0...v4.3.1
throws
and throwsAsync
assertions now take a function to test error messages, by @il3ven in https://github.com/avajs/ava/pull/2995
t.log()
messages, by @il3ven in https://github.com/avajs/ava/pull/3013
Full Changelog: https://github.com/avajs/ava/compare/v4.2.0...v4.3.0
Full Changelog: https://github.com/avajs/ava/compare/v4.1.0...v4.2.0
sortTestFiles()
in ava.config.js
files by @erezrokah in https://github.com/avajs/ava/pull/2968
ava.config.json
files are encountered by @razor-x in https://github.com/avajs/ava/pull/2962
deepEqual
assertion by @RebeccaStevens in https://github.com/avajs/ava/pull/2969
ava --version
works again by @novemberborn in https://github.com/avajs/ava/pull/2961
Full Changelog: https://github.com/avajs/ava/compare/v4.0.1...v4.1.0
Full Changelog: https://github.com/avajs/ava/compare/v4.0.0...v4.0.1
We're celebrating the new year with the official AVA 4 release! 🎊
npm install -D ava
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. 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.
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.
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.
@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.
AVA now records which test files failed in the previous run. It then prioritizes testing these files when you run AVA again. Thanks @bunysae!
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.
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.
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.
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.)
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).
@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/[email protected]
or newer.esm
package has been removed.ava.config.js
now follows the module type configured in package.json
.ava.config.*
files may be found that are outside your project directory.test.meta.file
and test.meta.snapshotDirectory
are now file URL strings.test()
and t.try()
no longer take an array of test implementations. Use a loop instead.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.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.instanceOf
expectation of t.throws()
and t.throwsAsync()
assertions must now be an Error
constructor.test.macro()
when declaring macros.unknown
.Meta
replaces MetaInterface
, other types with Interface
suffixes now use the Fn
suffix. There may be some other changes too. 4b4b2f63f184056b4038dfc692f99421038d3ec1t.throws()
and t.throwsAsync()
return undefined
when the assertion fails. The type definition now matches this behavior.--config
argument may now point to a file that is not alongside the package.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 as test-
prefixes.Full changelog since RC 1: https://github.com/avajs/ava/compare/v4.0.0-rc.1...v4.0.0 Full changelog since AVA 3: https://github.com/avajs/ava/compare/v3.15.0...v4.0.0
AVA 4 is nearly done! We’re not expecting major breaking changes, so barring any bugs or other surprises this should be it.
As always with pre-releases though you’re best-off installing an exact version:
npm install -D -E ava@next
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. 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.
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.
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.
@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.
AVA now records which test files failed in the previous run. It then prioritizes testing these files when you run AVA again. Thanks @bunysae!
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.
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.
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.
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.)
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).
@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/[email protected]
or newer.esm
package has been removed.ava.config.js
now follows the module type configured in package.json
.ava.config.*
files may be found that are outside your project directory.test.meta.file
and test.meta.snapshotDirectory
are now file URL strings.test()
and t.try()
no longer take an array of test implementations. Use a loop instead.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.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.instanceOf
expectation of t.throws()
and t.throwsAsync()
assertions must now be an Error
constructor.test.macro()
when declaring macros.unknown
.Meta
replaces MetaInterface
, other types with Interface
suffixes now use the Fn
suffix. There may be some other changes too. 4b4b2f63f184056b4038dfc692f99421038d3ec1t.throws()
and t.throwsAsync()
return undefined
when the assertion fails. The type definition now matches this behavior.--config
argument may now point to a file that is not alongside the package.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 as test-
prefixes.Full changelog since Alpha 2: https://github.com/avajs/ava/compare/v4.0.0-alpha.2...v4.0.0-rc.1