Releases: avajs/ava
v5.1.0
What's Changed
- Output logs for tests that remain pending when AVA exits by @kevo1ution in #3125
- Check for --config file extensions after they fail to load, allowing custom loaders by @panva in #3135
New Contributors
- @kevo1ution made their first contribution in #3125
- @panva made their first contribution in #3135
Full Changelog: v5.0.1...v5.1.0
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.
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
Improvements
- Detect
process.exit()
called from tests by @gibson042 in #3080 - Improve test result accessibility by @gibson042 in #3082
- Parse for line numbers with latest supported ECMA version by @novemberborn in #3063
- Work around
os.cpus()
returning an empty array on unsupported platforms by @catink123 in #3095 - Count timeouts separately from the timed out tests by @novemberborn in #3099
- Cap idle timeouts to the maximum possible value by @creestor in #3100
New Contributors
- @Prinzhorn made their first contribution in #3073
- @catink123 made their first contribution in #3095
- @creestor made their first contribution in #3100
- @DavidVujic made their first contribution in #3109
Full Changelog: v4.3.3...v5.0.1
v5.0.0
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
Improvements
- Detect
process.exit()
called from tests by @gibson042 in #3080 - Improve test result accessibility by @gibson042 in #3082
- Parse for line numbers with latest supported ECMA version by @novemberborn in #3063
- Work around
os.cpus()
returning an empty array on unsupported platforms by @catink123 in #3095 - Count timeouts separately from the timed out tests by @novemberborn in #3099
New Contributors
- @Prinzhorn made their first contribution in #3073
- @catink123 made their first contribution in #3095
Full Changelog: v4.3.3...v5.0.0
v4.3.3
Add compatibility with Node.js 18.8, thanks @Brooooooklyn #3091.
Full Changelog: v4.3.1...v4.3.3
v4.3.1
What's Changed
- When translating line numbers, check whether the source map entry has original values in #3061
- Report error when parsing for line number selection in #3062
New Contributors
- @ericcornelissen made their first contribution in #3048
- @AlencarGabriel made their first contribution in #3051
- @binyamin made their first contribution in #3028
Full Changelog: v4.3.0...v4.3.1
v4.3.0
What's Changed
- We're now shipping type definitions compatible with TypeScript 4.7, by @RebeccaStevens in #3024
throws
andthrowsAsync
assertions now take a function to test error messages, by @il3ven in #2995- Test failure summaries no longer duplicate
t.log()
messages, by @il3ven in #3013 - The number of timed-out tests is printed at the end of a run, by @il3ven in #3021
- We've documented how to load multiple instances of the same "shared" worker, by @codetheweb in #3009
- Links to translated documentation have been updated, by @forresst in #3037
- Node.js 17 has been removed from the test matrix, and Node.js 18 added in #3039
Full Changelog: v4.2.0...v4.3.0
v4.2.0
What's Changed
- Update Babel recipe for AVA 4 by @il3ven in #3000
- Document how GitHub Actions can be configured for parallel builds by @codetheweb in #3007
- Allow parallel builds to be disabled by @il3ven in #3001
- Improve typing of teardown methods by @novemberborn in #3003
New Contributors
- @mefengl made their first contribution in #2999
- @il3ven made their first contribution in #3000
- @codetheweb made their first contribution in #3007
Full Changelog: v4.1.0...v4.2.0
v4.1.0
New features
- Allow customized sorting of test files prior to execution using
sortTestFiles()
inava.config.js
files by @erezrokah in #2968 - Warn when unsupported
ava.config.json
files are encountered by @razor-x in #2962 - Loosen type constraints for
deepEqual
assertion by @RebeccaStevens in #2969
Fixes
ava --version
works again by @novemberborn in #2961
New Contributors
- @sikrinick made their first contribution in #2958
- @scottdotjs made their first contribution in #2954
- @gibson042 made their first contribution in #2975
- @erezrokah made their first contribution in #2968
- @razor-x made their first contribution in #2962
- @RebeccaStevens made their first contribution in #2969
Full Changelog: v4.0.1...v4.1.0
v4.0.1
What's Changed
- Fix encoding of large snapshot data by @novemberborn in #2936
Full Changelog: v4.0.0...v4.0.1
AVA 4
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.
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 🏞
- 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 4 requires
avajs/typescript@1.1
or newer. - Support for the
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 🥼
- By default test files execute in worker threads, not child processes.
test.meta.file
andtest.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()
andt.try()
no longer take an array of test implementations. Use a loop instead.- The
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 📸
- 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 oft.throws()
andt.throwsAsync()
assertions must now be anError
constructor. - You’re expected to use
test.macro()
when declaring macros. - Implementation arguments now default to
unknown
. - Types have been renamed.
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.- Our TypeScript definitions are now tested against TypeScript 4.4
Other changes 🤓
- We’ve removed the non-verbose reporter because it proved too hard to maintain two subtly different reporter outputs. We’d really like to rewrite the reporter.
- AVA's configuration files may now export promises or asynchronous factory methods.
- The
--config
argument may now point to a file that is not alongside thepackage.json
file. - When you use
t.timeout()
, AVA itself won’t time out until your test does. Thanks @OhYash! - Multi-line snapshot labels now render correctly in Markdown. Thanks @KillyMXI!
- The reporters now clean up
.test
and.spec
extensions from file names, as well astest-
prefixes. - Watch mode is better at detecting changes to snapshots and not rerunning tests.
New Contributors
- @Fem-Fem made their first contribution in #2750
- @OhYash made their first contribution in #2758
- @KillyMXI made their first contribution in #2773
- @mcecode made their first contribution in #2794
- @duncanfinney made their first contribution in #2820
- @asaid-0 made their first contribution in #2788
- @bompus made their first contribution in #2843
- @StefanoA1 made their first contribution in #2849
- @live627 made their first contribution in #2851
- @alessandroasm made their first contribution in #2863
- @eltociear made their first contribution in #2870
- @hamidbae made their first contribution in #2878
- @rrichardson made their first contribution in #2910
- @make-github-pseudonymous-again made their first contribution in #2913
- @lightmare made their first contribution in #2918
Full changelog since RC 1: v4.0.0-rc.1...v4.0.0
Full changelog since AVA 3: v3.15.0...v4.0.0