avajs/ava
### [`v3.15.0`](https://togithub.com/avajs/ava/releases/v3.15.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.14.0...v3.15.0)
#### Automatic snapshot file removal
When you stop using snapshots in a test file, the next time you run `ava --update-snapshots` we'll remove the left-over snapshot files. Thanks [@ninevra](https://togithub.com/ninevra)! [`4f093ab`](https://togithub.com/avajs/ava/commit/4f093ab)
#### TAP improvements
[@tymfear](https://togithub.com/tymfear) has been on a roll improving our TAP reporter. `t.log()` output is now compliant with the spec [`99ab93a`](https://togithub.com/avajs/ava/commit/99ab93a). Tests that did not run due to timeouts are now reported [`98595da`](https://togithub.com/avajs/ava/commit/98595dae58209a9062d0238c7a3dd7078a9962d1).
#### Next-generation configuration
AVA 4 will add full support for ESM configuration files as well as allowing you to have asynchronous factory functions [`a2f2614`](https://togithub.com/avajs/ava/commit/a2f2614cc1e34fb9a7aa204b37b3b25559f203d9). If you're using Node.js 12 or later you can opt-in to these features in AVA 3 by enabling the `nextGenConfig` experiment. Say in an `ava.config.mjs` file:
```js
export default {
nonSemVerExperiments: {
nextGenConfig: true
},
files: ['unit-tests/**/*]
};
```
This also allows you to pass an `.mjs` file using the `--config` argument.
With this experiment enabled, AVA will no longer have special treatment for `ava.config.js` files. Instead AVA follows Node.js' behavior, so if you've set [`"type": "module"`](https://nodejs.org/docs/latest/api/packages.html#packages_type) you must use ESM, and otherwise you must use CommonJS.
You mustn't have an `ava.config.mjs` file next to an `ava.config.js` or `ava.config.cjs` file.
***
See https://github.com/avajs/ava/compare/v3.14.0...v3.15.0 for all changes.
### [`v3.14.0`](https://togithub.com/avajs/ava/releases/v3.14.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.13.0...v3.14.0)
#### Snapshot ordering
With this release, snapshot files are now ordered based on test declaration, not completion. This makes it easier to compare the human-readable reports to your test file, and also stops the `.snap` from changing when the reports themselves don't. You'll want to rebuild snapshots after upgrading to this release to isolate any changes. Thanks [@ninevra](https://togithub.com/ninevra)! [`e66b54c`](https://togithub.com/avajs/ava/commit/e66b54ce61d8bb16bbcd15b7fb90893d02e5a65c)
#### Shared workers
We’ve been working on making AVA more extensible. One major step on this path is our new shared worker support: run code in the main process, communicate with test workers and influence execution. Find out more in our [shared workers recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/shared-workers.md).
***
See https://github.com/avajs/ava/compare/v3.13.0...v3.14.0 for all changes.
### [`v3.13.0`](https://togithub.com/avajs/ava/releases/v3.13.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.12.1...v3.13.0)
- `t.passed` can now be used in tests and teardown functions. Thanks [@tymfear](https://togithub.com/tymfear)! [`900dc6d`](https://togithub.com/avajs/ava/commit/900dc6d46a1f8728dddfab1e42caef1fa8a51c85)
- In AVA 4, you'll no longer be able to pass `null` as the expectation for `t.throws()` & `t.throwsAsync()`. You can opt in to this early by enabling the `disableNullExpectations` experiment. Thanks [@JSimoni42](https://togithub.com/JSimoni42)! [`f328a69`](https://togithub.com/avajs/ava/commit/f328a6933af7aca221b08f694bb14b03701eca68)
- The Enzyme recipe has been updated. Thanks [@jonathansamines](https://togithub.com/jonathansamines)! [`db5d2c3`](https://togithub.com/avajs/ava/commit/db5d2c369178b78dfbd899d002a141a05655ccdc)
- The TypeScript recipe has been updated. Thanks [@SephReed](https://togithub.com/SephReed)! [`a3379fa`](https://togithub.com/avajs/ava/commit/a3379fad3893468309a43b4b56d290f94933f082)
See https://github.com/avajs/ava/compare/v3.12.1...v3.13.0 for all changes.
### [`v3.12.1`](https://togithub.com/avajs/ava/releases/v3.12.1)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.12.0...v3.12.1)
#### Configure how AVA loads test files
Normally, AVA loads all files as CommonJS, except for `mjs` files and if you've configured `"type": "module"` in your `package.json`.
As an experiment, you can now configure how AVA loads other file extensions. This is useful if you want to use Node.js' [experimental loaders](https://nodejs.org/docs/latest/api/esm.html#esm_experimental_loaders) feature. Read more [in our documentation](https://togithub.com/avajs/ava/blob/master/docs/06-configuration.md#configuring-module-formats). Thank you [@macarie](https://togithub.com/macarie) for working on this! [`5c9dbb9`](https://togithub.com/avajs/ava/commit/5c9dbb96ad0beb7521e5051390478493250ba6b0)
#### Comparison bugfix
There was a bug in our [comparison library](https://togithub.com/concordancejs/concordance) which meant that negative-index properties on lists were not compared. This was fixed in a patch release, which will definitely be installed when you install AVA 3.12. Your tests may have been passing, even though they should have been failing. They'll fail now. Snapshots may also be different, causing tests to fail.
#### All changes
See https://github.com/avajs/ava/compare/v3.11.1...v3.12.1 for all changes.
Thank you [@AnthumChris](https://togithub.com/AnthumChris) for making sure our ESM example used ESM syntax ([`20bc781`](https://togithub.com/avajs/ava/commit/20bc7810536b3b968db5461ff4093bb5ae912050)).
### [`v3.12.0`](https://togithub.com/avajs/ava/compare/v3.11.1...v3.12.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.11.1...v3.12.0)
### [`v3.11.1`](https://togithub.com/avajs/ava/releases/v3.11.1)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.11.0...v3.11.1)
This release fixes corrupted output of the default reporter when test or program code writes to standard out. [`5ddc9fd`](https://togithub.com/avajs/ava/commit/5ddc9fda100205a5ca315a86e27a01be443b88b1)
Also, thanks to [@jonathansamines](https://togithub.com/jonathansamines) we've taken another step to using AVA to test AVA. [`1150991`](https://togithub.com/avajs/ava/commit/1150991ba1921cbf888438d46350894484356078)
See https://github.com/avajs/ava/compare/v3.11.0...v3.11.1 for all changes.
### [`v3.11.0`](https://togithub.com/avajs/ava/releases/v3.11.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.10.1...v3.11.0)
#### New `t.like()` assertion
Thanks to [@futpib](https://togithub.com/futpib) we now have a `t.like()` assertion [`19c4f35`](https://togithub.com/avajs/ava/commit/19c4f35fbae740268dedeeb4d450f813f2d5e85e):
In the following example, the `map` property of `value` must be deeply equal to that of `selector`. However `nested.qux` is ignored, because it's not in `selector`.
```js
t.like({
map: new Map([['foo', 'bar']]),
nested: {
baz: 'thud',
qux: 'quux'
}
}, {
map: new Map([['foo', 'bar']]),
nested: {
baz: 'thud',
}
})
```
Read more in the [`t.like()` assertion documentation](https://togithub.com/avajs/ava/blob/master/docs/03-assertions.md#likevalue-selector-message).
This assertion was [previously introduced](https://togithub.com/avajs/ava/releases/tag/v3.9.0) as an experiment.
#### VSCode 1.47 debugging improvements
You can now debug tests using the new JavaScript Debug Terminal in VSCode 1.47. We've updated our [debugging recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/debugging-with-vscode.md) accordingly. Thank you [@connor4312](https://togithub.com/connor4312) for the documentation updates and your work on VSCode! [`bc39bcc`](https://togithub.com/avajs/ava/commit/bc39bcc3ff92cb2979564ec2e69dc72be6509f78)
#### All changes
See https://github.com/avajs/ava/compare/v3.10.1...v3.11.0 for all changes.
### [`v3.10.1`](https://togithub.com/avajs/ava/releases/v3.10.1)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.10.0...v3.10.1)
### It's time for another AVA release 🎉
#### Restricting when you can update snapshots
When executing a subset of tests, through `--match` or or `.only()` or `.skip()`, you can no longer *also* update snapshots. This prevents you from accidentally deleting snapshots. Thank you [@bunysae](https://togithub.com/bunysae) for putting this together. [`f72fab4`](https://togithub.com/avajs/ava/commit/f72fab40160a413f4d7ab0208979fe3e721198ea)
If you are skipping a test that you can't immediately fix, but you still need to update snapshots, use `.failing()` instead.
#### Support for message strings in `t.timeout()` calls
Thanks to [@jonathansamines](https://togithub.com/jonathansamines) you can now provide a message string when using `t.timeout()`. This can be useful if your test depends on some other setup that may not have been completed: [`ca8ea45`](https://togithub.com/avajs/ava/commit/ca8ea45587ebefa5584d6a7aa50adf90840701cf)
```js
test('foo', t => {
t.timeout(100, 'make sure database has started');
// Write your assertions here
});
```
#### `t.try()` does not work in hooks
`t.try()` has never worked in hooks, but thanks to [@okyantoro](https://togithub.com/okyantoro) it now fails properly instead of crashing. [`d01db61`](https://togithub.com/avajs/ava/commit/d01db61ee5e9785d9f80ad5683cac21db4b96509)
#### `t.snapshot()` does not really work in hooks either
`t.snapshot()` sort of works in hooks, but we'll be removing this in AVA 4. You can opt in to this behavior by enabling the `disableSnapshotsInHooks` experiment. Again thank you [@okyantoro](https://togithub.com/okyantoro) [`d01db61`](https://togithub.com/avajs/ava/commit/d01db61ee5e9785d9f80ad5683cac21db4b96509).
#### Fixed TypeScript definition for `t.like()`
The [experimental `t.like()` assertion](https://togithub.com/avajs/ava/issues/2518) should now work better with TypeScript.
#### All changes
See https://github.com/avajs/ava/compare/v3.9.0...v3.10.1 for all changes.
### [`v3.10.0`](https://togithub.com/avajs/ava/compare/v3.9.0...v3.10.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.9.0...v3.10.0)
### [`v3.9.0`](https://togithub.com/avajs/ava/releases/v3.9.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.8.2...v3.9.0)
##### New experiments!
Thanks to [@futpib](https://togithub.com/futpib) we now have an experimental `t.like()` assertion [`19c4f35`](https://togithub.com/avajs/ava/commit/19c4f35fbae740268dedeeb4d450f813f2d5e85e):
In the following example, the `map` property of `value` must be deeply equal to that of `selector`. However `nested.qux` is ignored, because it's not in `selector`.
```js
t.like({
map: new Map([['foo', 'bar']]),
nested: {
baz: 'thud',
qux: 'quux'
}
}, {
map: new Map([['foo', 'bar']]),
nested: {
baz: 'thud',
}
})
```
Read more in the [`t.like()` assertion documentation](https://togithub.com/avajs/ava/blob/master/docs/03-assertions.md#likevalue-selector-message) and [let us know what you think](https://togithub.com/avajs/ava/issues/2518).
[@yjpa7145](https://togithub.com/yjpa7145) has contributed an experiment to reverse the order in which `t.teardown()` functions are run, so that the last registered function is called first [`952a017`](https://togithub.com/avajs/ava/commit/952a0177758c5601a72c2b050fc0308e7fa774c7). This will be the behavior in AVA 4.
To enable both these experiments update your AVA configuration:
**`package.json`**:
```json
{
"ava": {
"nonSemVerExperiments": {
"likeAssertion": true,
"reverseTeardowns": true
}
}
}
```
**`ava.config.js`**:
```js
export default {
nonSemVerExperiments: {
likeAssertion: true,
reverseTeardowns: true
}
}
```
##### Reporter changes
[@Michael55555](https://togithub.com/Michael55555) has helped us combine our reporter code into a single file [`b3866b6`](https://togithub.com/avajs/ava/commit/b3866b6b06c98862a19f6cb27ec28b643e2f00c7). We've also made some other tweaks and improvements [`baaf99a`](https://togithub.com/avajs/ava/commit/baaf99a792eed586678a0cf88864f3f0aa16bd7a). Let us know if anything seems amiss.
##### Improved diffs
[@bunysae](https://togithub.com/bunysae) made it so that missing or extraneous objects in diffs are printed with extra depth [https://github.com/concordancejs/concordance/pull/62](https://togithub.com/concordancejs/concordance/pull/62).
##### Farewell Node.js 13
Node.js 13 has reached end-of-life. Per our [support statement](https://togithub.com/avajs/ava/blob/master/docs/support-statement.md) we have removed it from our test matrix and supported version list.
##### All changes
See https://github.com/avajs/ava/compare/v3.8.2...v3.9.0 for all changes. Thank you [@paulrobertlloyd](https://togithub.com/paulrobertlloyd) and [@Autre31415](https://togithub.com/Autre31415) for contributing documentation improvements.
### [`v3.8.2`](https://togithub.com/avajs/ava/releases/v3.8.2)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.8.1...v3.8.2)
- Fix bad dependency [`fd92b4a`](https://togithub.com/avajs/ava/commit/fd92b4a3)
- Use configured depth limit for diffs in assertion failures, thanks [@bunysae](https://togithub.com/bunysae)! [`a5385a4`](https://togithub.com/avajs/ava/commit/a5385a41)
### [`v3.8.1`](https://togithub.com/avajs/ava/releases/v3.8.1)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.8.0...v3.8.1)
#### Node.js 14 support
Great news, this is a feature heavy release!
First off, though, AVA now officially supports Node.js 14. Thank you [@zackschuster](https://togithub.com/zackschuster)! [`2e7c76b`](https://togithub.com/avajs/ava/commit/2e7c76b85cb65a04605fed843ee2f571afc66c37)
#### Run tests at specific line numbers
AVA can now run tests at specific line numbers! 🎉
Given the following test file:
`test.js`
```js
1: test('unicorn', t => {
2: t.pass();
3: });
4:
5: test('rainbow', t => {
6: t.fail();
7: });
```
Running `npx ava test.js:2` for would run the `unicorn` test. In fact you could use any line number between `1` and `3`.
This feature is only available from the command line. It won't work if you use tools like `ts-node/register` or `@babel/register`, and it does not currently work with `@ava/babel` and `@ava/typescript`. See [https://github.com/avajs/ava/issues/2473](https://togithub.com/avajs/ava/issues/2473).
Thank you [@ulken](https://togithub.com/ulken) for your hard work and patience to get this shipped. [`1222ce9`](https://togithub.com/avajs/ava/commit/1222ce9538e4890c20af695e558e3ee490f5a41b)
#### Test-specific teardown functions
Sometimes tests have side-effects you want to clean up. [@ulken](https://togithub.com/ulken) has implemented `t.teardown()` which lets you register teardown functions *within* your test. They'll run once your test has finished, even if it failed: [`75cbc3b`](https://togithub.com/avajs/ava/commit/75cbc3b2a53d3b8530266b10bed71b838bc11fec)
test('read file', t => {
fs.writeFileSync('file.txt', '👋');
t.teardown(() => fs.unlinkSync('file.txt');
// Run assertions
});
#### Node.js internal in stack traces
Thanks to [@bunysae](https://togithub.com/bunysae), stack traces now include Node.js internals. Previously we removed them because we wanted you to focus on your own code, but quite often they do provide context. Now they're displayed, but somewhat dimmed. [`9a9351d`](https://togithub.com/avajs/ava/commit/9a9351ddbee9c6c76601210c5dd8f5b0d81cc3b0)
#### Watch mode with the default reporter
Watch mode with the default reporter once again accepts key input. Thanks [@pcdevil](https://togithub.com/pcdevil)! [`59c227d`](https://togithub.com/avajs/ava/commit/59c227d9c5261117d99e8e84693b9c89c3438a92)
#### ICYMI
- `afterEach()` and `afterEach.always()` hooks can now determine whether the test passed. Thank you [@bunysae](https://togithub.com/bunysae) for contributing this! [`8f312c0`](https://togithub.com/avajs/ava/commit/8f312c0)
```js
test('passes', t => t.pass());
test.afterEach(t => {
if (t.passed) {
// Do something because the test passed
} else {
// Do something because the test failed
}
});
```
- If you've ever wanted to save some files along with AVA's snapshots, you can now determine the directory path by accessing `test.meta.snapshotDirectory`. Thank you [@ulken](https://togithub.com/ulken)! [`cb5f9f7`](https://togithub.com/avajs/ava/commit/cb5f9f7)
#### All changes
See https://github.com/avajs/ava/compare/v3.7.1...v3.8.1 for all changes.
### [`v3.8.0`](https://togithub.com/avajs/ava/compare/v3.7.1...v3.8.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.7.1...v3.8.0)
### [`v3.7.1`](https://togithub.com/avajs/ava/releases/v3.7.1)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.7.0...v3.7.1)
- Support parallel runs that do not need to run test files, courtesy of [@micaelmbagira](https://togithub.com/micaelmbagira) [`26c8326`](https://togithub.com/avajs/ava/commit/26c8326b)
### [`v3.7.0`](https://togithub.com/avajs/ava/releases/v3.7.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.6.0...v3.7.0)
If you've ever wanted to save some files along with AVA's snapshots, you can now determine the directory path by accessing `test.meta.snapshotDirectory`. Thank you [@ulken](https://togithub.com/ulken) ! [`cb5f9f7`](https://togithub.com/avajs/ava/commit/cb5f9f70879ee549837c31e577e01f87970164ed)
See https://github.com/avajs/ava/compare/v3.6.0...v3.7.0 for all changes.
### [`v3.6.0`](https://togithub.com/avajs/ava/releases/v3.6.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.5.2...v3.6.0)
`afterEach()` and `afterEach.always()` hooks can now determine whether the test passed. Thank you [@bunysae](https://togithub.com/bunysae) for contributing this! [`8f312c0`](https://togithub.com/avajs/ava/commit/8f312c0f2c978ba39baae0f701015d79af18cbde):
```js
test('passes', t => t.pass());
test.afterEach(t => {
if (t.passed) {
// Do something because the test passed
} else {
// Do something because the test failed
}
});
```
[@mbiesiad](https://togithub.com/mbiesiad) has diligently [translated our documentation to Polish](https://togithub.com/avajs/ava-docs/tree/master/pl_PL). Thank you [@kekuu](https://togithub.com/kekuu) for reviewing.
Also thank you [@timgates42](https://togithub.com/timgates42) for fixing a typo in our documentation. [`ede4f32`](https://togithub.com/avajs/ava/commit/ede4f322b4fa6263c8ae14ec04282ab06bb0afd4)
See https://github.com/avajs/ava/compare/v3.5.0...v3.6.0 for all changes.
### [`v3.5.2`](https://togithub.com/avajs/ava/compare/v3.5.1...v3.5.2)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.5.1...v3.5.2)
### [`v3.5.1`](https://togithub.com/avajs/ava/compare/v3.5.0...v3.5.1)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.5.0...v3.5.1)
### [`v3.5.0`](https://togithub.com/avajs/ava/releases/v3.5.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.4.0...v3.5.0)
When using `ava debug`, you can now specify the address or hostname the inspector is available through by using the `--host` option. Thanks to [@DYefimov](https://togithub.com/DYefimov) for contributing this! [`13d6651`](https://togithub.com/avajs/ava/commit/13d66519)
See https://github.com/avajs/ava/compare/v3.4.0...v3.5.0 for all changes. Spoiler alert: it's just this one 😉
### [`v3.4.0`](https://togithub.com/avajs/ava/releases/v3.4.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.3.0...v3.4.0)
#### Introducing the `t.try()` assertion
The new `t.try()` allows you to *try* assertions without causing the test to fail:
```js
test('do the thing', async t => {
const attempt = () => t.try(async tt => {
const result = await getResult()
// getResult() can be flaky and sometimes throws :(
tt.is(result, 'expected')
})
const firstAttempt = await attempt()
if (firstAttempt.passed) return firstAttempt.commit()
t.log('Retrying (just once)')
firstAttempt.discard()
const secondAttempt = await attempt()
secondAttempt.commit()
})
```
You can use any test implementation with `t.try()`, including (arrays of) [macros](https://togithub.com/avajs/ava/blob/master/docs/01-writing-tests.md#reusing-test-logic-through-macros). You can decide what to do with attempts. You can even run attempts concurrently, so long as they don't use snapshot assertions.
This is great building block for handling all kinds of advanced test scenarios. We can't wait to see what you'll do with it! Find out more in the [assertion documentation](https://togithub.com/avajs/ava/blob/master/docs/03-assertions.md#trytitle-implementation--macro--macro-args).
This feature was previously behind an experimental flag. That flag has now been removed. If you have enabled the flag you'll have to update your AVA config. Also note that as of this release, attempt titles are always prefixed with the title of the parent test [`7ee3a0e`](https://togithub.com/avajs/ava/commit/7ee3a0e5940a105dec447851c777ea44555e8220).
Once again, thank you [@qlonik](https://togithub.com/qlonik) for contributing this new assertion.
#### In case you missed it: ESM support
As of the [3.3.0](https://togithub.com/avajs/ava/releases/tag/v3.3.0) release, AVA can load ESM test files! Check our updated [ES Modules recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/es-modules.md) for details.
Our ESM support is still incomplete. Progress is tracked in the [ESM support project](https://togithub.com/orgs/avajs/projects/2). Join us, won't you?
#### Other changes
- The `t.throws()` and `t.throwsAsync()` assertions can now be called with `undefined` as the second argument. Previously, if you wanted to set an assertion message but did not want to provide any expectations for the thrown error you had to pass `null`. That's still allowed, of course. [`d0e2161`](https://togithub.com/avajs/ava/commit/d0e21612390d50f084f7062b051164624ef391ff) [@stavalfi](https://togithub.com/stavalfi)
- `ava.config.js` files once again work with our [`@ava/typescript`](https://togithub.com/avajs/typescript) package [`f4d4edd`](https://togithub.com/avajs/ava/commit/f4d4edd3379e51ac733b184e20dd0228be24245a)
- Our TypeScript definition no longer references `@types/node` [`7a1dacf`](https://togithub.com/avajs/ava/commit/7a1dacf369a5857309effa42fc1638d7b8fe4ead)
- We've improved the error message shown when `test.cb()` is used with asynchronous functions or observables [`f5a8c2b`](https://togithub.com/avajs/ava/commit/f5a8c2b2df757886247492ce3372f1e18da36ab7) [@toddkcarlson](https://togithub.com/toddkcarlson)
- The [Vue recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/vue.md) has been updated to use `jsdom-global` instead of `browser-env` [`3f9c616`](https://togithub.com/avajs/ava/commit/3f9c616b44c7374404d75af63f393750160c6b84) [@Scrum](https://togithub.com/Scrum)
- [@fisker](https://togithub.com/fisker) optimized how we detect ESM support [`8831f54`](https://togithub.com/avajs/ava/commit/8831f54d760bbcadf8924ef6b10899a6b786c3b5)
See https://github.com/avajs/ava/compare/v3.3.0...v3.4.0 for all changes.
### [`v3.3.0`](https://togithub.com/avajs/ava/releases/v3.3.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.2.0...v3.3.0)
AVA can now load ESM test files! 🎉Thank you [@arlac77](https://togithub.com/arlac77) for making this happen. Check our updated [ES Modules recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/es-modules.md) for details.
Our ESM support is still incomplete. Progress is tracked in the [ESM support project](https://togithub.com/orgs/avajs/projects/2). Join us, won't you?
#### Other changes
See https://github.com/avajs/ava/compare/v3.2.0...v3.3.0 for all changes.
### [`v3.2.0`](https://togithub.com/avajs/ava/releases/v3.2.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.1.0...v3.2.0)
This release improves the integration with the new [`@ava/typescript`][@ava/typescript] package, which allows AVA to load pre-compiled TypeScript files.
First, install the new [`@ava/typescript`][@ava/typescript] package:
```console
npm install --save-dev @ava/typescript@^1.1
```
Now let's assume your TypeScript files are in a `src` directory, output to a `build` directory. Configure AVA like so:
`ava.config.js` file:
```js
export default {
typescript: {
rewritePaths: {
'src/': 'build/'
}
}
}
```
Compile your TypeScript files and run your tests! Or, to run a specific test file, run `npx ava src/test.ts`.
For more examples see the [`@ava/typescript`][@ava/typescript] package.
As exciting as this is, it's still early days. We need your help improving our TypeScript support. Check out the [open issues](https://togithub.com/avajs/typescript/issues).
[`@ava/typescript`]: https://togithub.com/avajs/typescript
#### Other changes
See https://github.com/avajs/ava/compare/v3.1.0...v3.2.0 for all changes.
### [`v3.1.0`](https://togithub.com/avajs/ava/releases/v3.1.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v3.0.0...v3.1.0)
AVA can now load pre-compiled TypeScript files!
First, install the new [`@ava/typescript`][@ava/typescript] package:
```console
npm install --save-dev @ava/typescript
```
Now let's assume your TypeScript files are in a `src` directory, output to a `build` directory. Configure AVA like so:
`ava.config.js` file:
```js
export default {
typescript: {
rewritePaths: {
'src/': 'build/'
}
}
}
```
Compile your TypeScript files and run your tests! Or, to run a specific test file, run `npx ava src/test.ts`.
For more examples see the [`@ava/typescript`][@ava/typescript] package.
As exciting as this is, it's still early days. We need your help improving our TypeScript support. Check out the [open issues](https://togithub.com/avajs/typescript/issues).
[`@ava/typescript`]: https://togithub.com/avajs/typescript
#### Other changes
Thanks to [@jhechtf](https://togithub.com/jhechtf) for fixing our TypeScript recipe after the changes in AVA 3.0 [`91a0086`](https://togithub.com/avajs/ava/commit/91a00864f7f113dd63a2c4ecc383fc8c45f79665)
See https://github.com/avajs/ava/compare/v3.0.0...v3.1.0 for all changes.
### [`v3.0.0`](https://togithub.com/avajs/ava/releases/v3.0.0)
[Compare Source](https://togithub.com/avajs/ava/compare/v2.4.0...v3.0.0)
### We're proud to introduce AVA 3! 🚀
When we began AVA, JavaScript was very different. Most syntax you find familiar today was not supported by Node.js. Instead we relied on [Babel](https://babeljs.io/) to support that syntax before it made its way to Node.js itself.
These days most new [stage-4](https://togithub.com/tc39/proposals/blob/master/finished-proposals.md) syntax is adopted quickly. It's often not necessary to transpile anything. Therefore we're removing our built-in Babel support from AVA itself.
Without Babel you'll have to resort to using `require()` functions in your JavaScript files. But, you say, [Node.js 13 supports ECMAScript Modules](https://nodejs.org/api/esm.html)!
Well, we're getting there. For a start, AVA now also looks for `.cjs` files. And `.mjs` files are recognized too, but can't be loaded just yet. This also impacts `ava.config.js` files. If you'd like to help out delivering full `.mjs` support check out the issues in the [ESM support project](https://togithub.com/orgs/avajs/projects/2).
Removing Babel allowed us to simplify how test files are selected. Likely non-test files, inside "fixture" or "helper" directories are ignored. The same for files that are inside an underscore-prefixed directory. We've made some other breaking changes in this area so please do read the full release notes.
You can again pass glob patterns on the CLI. However these now filter the test files that AVA already selected based on the configuration. In other words you can't run files that wouldn't be run by invoking `npx ava`.
AVA now interrupts your tests if there's no progress for 10 seconds. Use the `timeout` configuration or `--timeout` CLI option to change this.
#### New features
##### Built-in debug mode
You can now debug individual test files using the V8 Inspector:
```console
npx ava debug test.js
```
Connect to the debugger with [Chrome DevTools](https://togithub.com/avajs/ava/blob/master/docs/recipes/debugging-with-chrome-devtools.md). Or [set up a debugger in VSCode](https://togithub.com/avajs/ava/blob/master/docs/recipes/debugging-with-vscode.md).
##### Configurable Node.js arguments
You can now configure the arguments passed to Node.js itself when AVA starts its worker processes. Use the `nodeArguments` configuration or combine with the `--node-arguments` CLI option.
#### All breaking changes
##### Supported Node.js versions
We now support Node.js 10, 12 and 13. The minimal versions are 10.18.0, 12.14.0 and 13.5.0 respectively.
##### Removing Babel
Utilize Babel with AVA by installing our [`@ava/babel`](https://togithub.com/avajs/babel) package and then enabling Babel by setting `babel: true` in the AVA configuration. Having this as a separate package means it can evolve independently.
The `compileEnhancements` setting has been moved into the `babel` configuration. Consequently, the `t.assert()` assertion will only print its detailed information when you use Babel. And we won't be able to catch typical mistakes with `t.throws()` as well as we could before.
The `ava/stage-4` preset is now available from `@ava/babel/stage-4`. Our old `@ava/babel-preset-transform-test-files` and `@ava/babel-preset-stage-4` packages are no longer maintained and not installed with AVA itself.
##### ECMAScript Module Support
AVA now also looks for `.cjs` and `.mjs` test files. That said, `.mjs` files cannot be loaded just yet.
Also, when you add `"type": "module"` , AVA would really like to treat `.js` files as ECMAScript Modules, but can't just yet.
Similarly,`ava.config.cjs` configuration files are now supported. `ava.config.mjs` files not just yet.
With AVA 2, we loaded `ava.config.js` files using the [`esm`](https://www.npmjs.com/package/esm) package. To avoid confusion between the different module formats we now *only* support `export default` statements. No `import`, no `__filename`. Configuration files that have dependencies should be written as a `.cjs` file for now.
Configuration files can only have `.cjs`, `.js` and `.mjs` extensions.
The remaining work is tracked in the [ESM support project](https://togithub.com/orgs/avajs/projects/2).
##### File selection
When you use the default configuration AVA will no longer select files matching the following glob patterns:
- `**/__tests__/**/__helper__/**/*`
- `**/__tests__/**/__helpers__/**/*`
- `**/__tests__/**/__fixture__/**/*`
- `**/__tests__/**/__fixtures__/**/*`
- `**/test/**/helper/**/*`
- `**/test/**/helpers/**/*`
- `**/test/**/fixture/**/*`
- `**/test/**/fixtures/**/*`
- `**/tests/**/helper/**/*`
- `**/tests/**/helpers/**/*`
- `**/tests/**/fixture/**/*`
- `**/tests/**/fixtures/**/*`
Additionally, when a file has a parent directory that starts with a *single* underscore, it can never be a test file.
`test.js` files are only selected if they're next to the `package.json` file, or inside top-level `src` and ` source `directories.
We've removed the configuration of helpers. Previously, files selected by the `helpers` glob patterns were never considered test files. Now that this configuration is no longer supported you'll need to ensure the `files` patterns exclude your helper files. If you're using Babel, you can configure [the compilation of additional files](https://togithub.com/avajs/babel#compile-additional-files) .
The `sources` configuration has also been removed. Instead, use the `ignoredByWatcher` configuration. Changes to files matched by these glob patterns will not cause the watcher to rerun tests.
Negated `sources` patterns must be used without the negation in `ignoredByWatcher`:
```diff
export default {
- sources: ['!examples/**/*']
+ ignoredByWatcher: ['examples/**/*']
}
```
##### CLI changes
Internally we've replaced [`meow`](https://www.npmjs.com/package/meow) by [`yargs`](https://www.npmjs.com/package/yargs). We're not expecting things to break because of this, but you never know.
##### Resetting the cache
The `--reset-cache` argument has been replaced by a proper `reset-cache` command:
```console
npx ava reset-cache
```
##### File selection (again!)
AVA again accepts glob patterns via the CLI:
```console
npx ava '**/api/**/*'
```
The way this work is that AVA first finds all test files, according to the configuration, and then filters to select just the files that also match the glob patterns passed via the CLI.
You can still pass paths to specific files:
```console
npx ava src/api/test/my-api-test.js
```
However unlike with AVA 2, you can no longer specify test files that aren't already selected by AVA's configuration.
##### `t.throws()` and `t.throwsAsync()` assertions
The second argument passed to these assertions must now be an `expectation` object. You can no longer pass the expected constructor, error message or regular expression.
##### Other breaking changes
- Support for old [`esm`](https://www.npmjs.com/package/esm) versions has been removed.
- We've set a default test timeout of 10 seconds. This means that if no test results are received for 10 seconds, AVA forces its worker processes to quit.
- The `NODE_PATH` environment variable is no longer rewritten to ensure values are absolute paths.
- AVA longer fakes the TTY in worker processes.
#### Other changes
- We've simplified how we identify observables. Any object returned by a test implementation that has a `subscribe` function is assumed to be an observable. AVA's type definition has been updated accordingly.
- The TAP reporter now reports hook failures as test failures.
- We've added an example of [module path mapping to our TypeScript recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/typescript.md#using-module-path-mapping).
- We've added a [Selenium WebDriver JS recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/testing-with-selenium-webdriverjs.md).
#### All changes
#### Thanks
Thank you [@tymfear](https://togithub.com/tymfear), [@HeathNaylor](https://togithub.com/HeathNaylor), [@grnch](https://togithub.com/grnch), [@alexdrans](https://togithub.com/alexdrans), [@MoppetX](https://togithub.com/MoppetX), [@jimmywarting](https://togithub.com/jimmywarting), [@micaelmbagira](https://togithub.com/micaelmbagira), [@aptester](https://togithub.com/aptester), [@theashraf](https://togithub.com/theashraf), [@sramam](https://togithub.com/sramam) and [@maximelkin](https://togithub.com/maximelkin). We couldn't have done this without you!
Configuration
📅 Schedule: 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.
[ ] If you want to rebase/retry this PR, check this box.
This PR contains the following updates:
2.4.0->3.15.0Release Notes
avajs/ava
### [`v3.15.0`](https://togithub.com/avajs/ava/releases/v3.15.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.14.0...v3.15.0) #### Automatic snapshot file removal When you stop using snapshots in a test file, the next time you run `ava --update-snapshots` we'll remove the left-over snapshot files. Thanks [@ninevra](https://togithub.com/ninevra)! [`4f093ab`](https://togithub.com/avajs/ava/commit/4f093ab) #### TAP improvements [@tymfear](https://togithub.com/tymfear) has been on a roll improving our TAP reporter. `t.log()` output is now compliant with the spec [`99ab93a`](https://togithub.com/avajs/ava/commit/99ab93a). Tests that did not run due to timeouts are now reported [`98595da`](https://togithub.com/avajs/ava/commit/98595dae58209a9062d0238c7a3dd7078a9962d1). #### Next-generation configuration AVA 4 will add full support for ESM configuration files as well as allowing you to have asynchronous factory functions [`a2f2614`](https://togithub.com/avajs/ava/commit/a2f2614cc1e34fb9a7aa204b37b3b25559f203d9). If you're using Node.js 12 or later you can opt-in to these features in AVA 3 by enabling the `nextGenConfig` experiment. Say in an `ava.config.mjs` file: ```js export default { nonSemVerExperiments: { nextGenConfig: true }, files: ['unit-tests/**/*] }; ``` This also allows you to pass an `.mjs` file using the `--config` argument. With this experiment enabled, AVA will no longer have special treatment for `ava.config.js` files. Instead AVA follows Node.js' behavior, so if you've set [`"type": "module"`](https://nodejs.org/docs/latest/api/packages.html#packages_type) you must use ESM, and otherwise you must use CommonJS. You mustn't have an `ava.config.mjs` file next to an `ava.config.js` or `ava.config.cjs` file. *** See https://github.com/avajs/ava/compare/v3.14.0...v3.15.0 for all changes. ### [`v3.14.0`](https://togithub.com/avajs/ava/releases/v3.14.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.13.0...v3.14.0) #### Snapshot ordering With this release, snapshot files are now ordered based on test declaration, not completion. This makes it easier to compare the human-readable reports to your test file, and also stops the `.snap` from changing when the reports themselves don't. You'll want to rebuild snapshots after upgrading to this release to isolate any changes. Thanks [@ninevra](https://togithub.com/ninevra)! [`e66b54c`](https://togithub.com/avajs/ava/commit/e66b54ce61d8bb16bbcd15b7fb90893d02e5a65c) #### Shared workers We’ve been working on making AVA more extensible. One major step on this path is our new shared worker support: run code in the main process, communicate with test workers and influence execution. Find out more in our [shared workers recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/shared-workers.md). *** See https://github.com/avajs/ava/compare/v3.13.0...v3.14.0 for all changes. ### [`v3.13.0`](https://togithub.com/avajs/ava/releases/v3.13.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.12.1...v3.13.0) - `t.passed` can now be used in tests and teardown functions. Thanks [@tymfear](https://togithub.com/tymfear)! [`900dc6d`](https://togithub.com/avajs/ava/commit/900dc6d46a1f8728dddfab1e42caef1fa8a51c85) - In AVA 4, you'll no longer be able to pass `null` as the expectation for `t.throws()` & `t.throwsAsync()`. You can opt in to this early by enabling the `disableNullExpectations` experiment. Thanks [@JSimoni42](https://togithub.com/JSimoni42)! [`f328a69`](https://togithub.com/avajs/ava/commit/f328a6933af7aca221b08f694bb14b03701eca68) - The Enzyme recipe has been updated. Thanks [@jonathansamines](https://togithub.com/jonathansamines)! [`db5d2c3`](https://togithub.com/avajs/ava/commit/db5d2c369178b78dfbd899d002a141a05655ccdc) - The TypeScript recipe has been updated. Thanks [@SephReed](https://togithub.com/SephReed)! [`a3379fa`](https://togithub.com/avajs/ava/commit/a3379fad3893468309a43b4b56d290f94933f082) See https://github.com/avajs/ava/compare/v3.12.1...v3.13.0 for all changes. ### [`v3.12.1`](https://togithub.com/avajs/ava/releases/v3.12.1) [Compare Source](https://togithub.com/avajs/ava/compare/v3.12.0...v3.12.1) #### Configure how AVA loads test files Normally, AVA loads all files as CommonJS, except for `mjs` files and if you've configured `"type": "module"` in your `package.json`. As an experiment, you can now configure how AVA loads other file extensions. This is useful if you want to use Node.js' [experimental loaders](https://nodejs.org/docs/latest/api/esm.html#esm_experimental_loaders) feature. Read more [in our documentation](https://togithub.com/avajs/ava/blob/master/docs/06-configuration.md#configuring-module-formats). Thank you [@macarie](https://togithub.com/macarie) for working on this! [`5c9dbb9`](https://togithub.com/avajs/ava/commit/5c9dbb96ad0beb7521e5051390478493250ba6b0) #### Comparison bugfix There was a bug in our [comparison library](https://togithub.com/concordancejs/concordance) which meant that negative-index properties on lists were not compared. This was fixed in a patch release, which will definitely be installed when you install AVA 3.12. Your tests may have been passing, even though they should have been failing. They'll fail now. Snapshots may also be different, causing tests to fail. #### All changes See https://github.com/avajs/ava/compare/v3.11.1...v3.12.1 for all changes. Thank you [@AnthumChris](https://togithub.com/AnthumChris) for making sure our ESM example used ESM syntax ([`20bc781`](https://togithub.com/avajs/ava/commit/20bc7810536b3b968db5461ff4093bb5ae912050)). ### [`v3.12.0`](https://togithub.com/avajs/ava/compare/v3.11.1...v3.12.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.11.1...v3.12.0) ### [`v3.11.1`](https://togithub.com/avajs/ava/releases/v3.11.1) [Compare Source](https://togithub.com/avajs/ava/compare/v3.11.0...v3.11.1) This release fixes corrupted output of the default reporter when test or program code writes to standard out. [`5ddc9fd`](https://togithub.com/avajs/ava/commit/5ddc9fda100205a5ca315a86e27a01be443b88b1) Also, thanks to [@jonathansamines](https://togithub.com/jonathansamines) we've taken another step to using AVA to test AVA. [`1150991`](https://togithub.com/avajs/ava/commit/1150991ba1921cbf888438d46350894484356078) See https://github.com/avajs/ava/compare/v3.11.0...v3.11.1 for all changes. ### [`v3.11.0`](https://togithub.com/avajs/ava/releases/v3.11.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.10.1...v3.11.0) #### New `t.like()` assertion Thanks to [@futpib](https://togithub.com/futpib) we now have a `t.like()` assertion [`19c4f35`](https://togithub.com/avajs/ava/commit/19c4f35fbae740268dedeeb4d450f813f2d5e85e): In the following example, the `map` property of `value` must be deeply equal to that of `selector`. However `nested.qux` is ignored, because it's not in `selector`. ```js t.like({ map: new Map([['foo', 'bar']]), nested: { baz: 'thud', qux: 'quux' } }, { map: new Map([['foo', 'bar']]), nested: { baz: 'thud', } }) ``` Read more in the [`t.like()` assertion documentation](https://togithub.com/avajs/ava/blob/master/docs/03-assertions.md#likevalue-selector-message). This assertion was [previously introduced](https://togithub.com/avajs/ava/releases/tag/v3.9.0) as an experiment. #### VSCode 1.47 debugging improvements You can now debug tests using the new JavaScript Debug Terminal in VSCode 1.47. We've updated our [debugging recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/debugging-with-vscode.md) accordingly. Thank you [@connor4312](https://togithub.com/connor4312) for the documentation updates and your work on VSCode! [`bc39bcc`](https://togithub.com/avajs/ava/commit/bc39bcc3ff92cb2979564ec2e69dc72be6509f78) #### All changes See https://github.com/avajs/ava/compare/v3.10.1...v3.11.0 for all changes. ### [`v3.10.1`](https://togithub.com/avajs/ava/releases/v3.10.1) [Compare Source](https://togithub.com/avajs/ava/compare/v3.10.0...v3.10.1) ### It's time for another AVA release 🎉 #### Restricting when you can update snapshots When executing a subset of tests, through `--match` or or `.only()` or `.skip()`, you can no longer *also* update snapshots. This prevents you from accidentally deleting snapshots. Thank you [@bunysae](https://togithub.com/bunysae) for putting this together. [`f72fab4`](https://togithub.com/avajs/ava/commit/f72fab40160a413f4d7ab0208979fe3e721198ea) If you are skipping a test that you can't immediately fix, but you still need to update snapshots, use `.failing()` instead. #### Support for message strings in `t.timeout()` calls Thanks to [@jonathansamines](https://togithub.com/jonathansamines) you can now provide a message string when using `t.timeout()`. This can be useful if your test depends on some other setup that may not have been completed: [`ca8ea45`](https://togithub.com/avajs/ava/commit/ca8ea45587ebefa5584d6a7aa50adf90840701cf) ```js test('foo', t => { t.timeout(100, 'make sure database has started'); // Write your assertions here }); ``` #### `t.try()` does not work in hooks `t.try()` has never worked in hooks, but thanks to [@okyantoro](https://togithub.com/okyantoro) it now fails properly instead of crashing. [`d01db61`](https://togithub.com/avajs/ava/commit/d01db61ee5e9785d9f80ad5683cac21db4b96509) #### `t.snapshot()` does not really work in hooks either `t.snapshot()` sort of works in hooks, but we'll be removing this in AVA 4. You can opt in to this behavior by enabling the `disableSnapshotsInHooks` experiment. Again thank you [@okyantoro](https://togithub.com/okyantoro) [`d01db61`](https://togithub.com/avajs/ava/commit/d01db61ee5e9785d9f80ad5683cac21db4b96509). #### Fixed TypeScript definition for `t.like()` The [experimental `t.like()` assertion](https://togithub.com/avajs/ava/issues/2518) should now work better with TypeScript. #### All changes See https://github.com/avajs/ava/compare/v3.9.0...v3.10.1 for all changes. ### [`v3.10.0`](https://togithub.com/avajs/ava/compare/v3.9.0...v3.10.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.9.0...v3.10.0) ### [`v3.9.0`](https://togithub.com/avajs/ava/releases/v3.9.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.8.2...v3.9.0) ##### New experiments! Thanks to [@futpib](https://togithub.com/futpib) we now have an experimental `t.like()` assertion [`19c4f35`](https://togithub.com/avajs/ava/commit/19c4f35fbae740268dedeeb4d450f813f2d5e85e): In the following example, the `map` property of `value` must be deeply equal to that of `selector`. However `nested.qux` is ignored, because it's not in `selector`. ```js t.like({ map: new Map([['foo', 'bar']]), nested: { baz: 'thud', qux: 'quux' } }, { map: new Map([['foo', 'bar']]), nested: { baz: 'thud', } }) ``` Read more in the [`t.like()` assertion documentation](https://togithub.com/avajs/ava/blob/master/docs/03-assertions.md#likevalue-selector-message) and [let us know what you think](https://togithub.com/avajs/ava/issues/2518). [@yjpa7145](https://togithub.com/yjpa7145) has contributed an experiment to reverse the order in which `t.teardown()` functions are run, so that the last registered function is called first [`952a017`](https://togithub.com/avajs/ava/commit/952a0177758c5601a72c2b050fc0308e7fa774c7). This will be the behavior in AVA 4. To enable both these experiments update your AVA configuration: **`package.json`**: ```json { "ava": { "nonSemVerExperiments": { "likeAssertion": true, "reverseTeardowns": true } } } ``` **`ava.config.js`**: ```js export default { nonSemVerExperiments: { likeAssertion: true, reverseTeardowns: true } } ``` ##### Reporter changes [@Michael55555](https://togithub.com/Michael55555) has helped us combine our reporter code into a single file [`b3866b6`](https://togithub.com/avajs/ava/commit/b3866b6b06c98862a19f6cb27ec28b643e2f00c7). We've also made some other tweaks and improvements [`baaf99a`](https://togithub.com/avajs/ava/commit/baaf99a792eed586678a0cf88864f3f0aa16bd7a). Let us know if anything seems amiss. ##### Improved diffs [@bunysae](https://togithub.com/bunysae) made it so that missing or extraneous objects in diffs are printed with extra depth [https://github.com/concordancejs/concordance/pull/62](https://togithub.com/concordancejs/concordance/pull/62). ##### Farewell Node.js 13 Node.js 13 has reached end-of-life. Per our [support statement](https://togithub.com/avajs/ava/blob/master/docs/support-statement.md) we have removed it from our test matrix and supported version list. ##### All changes See https://github.com/avajs/ava/compare/v3.8.2...v3.9.0 for all changes. Thank you [@paulrobertlloyd](https://togithub.com/paulrobertlloyd) and [@Autre31415](https://togithub.com/Autre31415) for contributing documentation improvements. ### [`v3.8.2`](https://togithub.com/avajs/ava/releases/v3.8.2) [Compare Source](https://togithub.com/avajs/ava/compare/v3.8.1...v3.8.2) - Fix bad dependency [`fd92b4a`](https://togithub.com/avajs/ava/commit/fd92b4a3) - Use configured depth limit for diffs in assertion failures, thanks [@bunysae](https://togithub.com/bunysae)! [`a5385a4`](https://togithub.com/avajs/ava/commit/a5385a41) ### [`v3.8.1`](https://togithub.com/avajs/ava/releases/v3.8.1) [Compare Source](https://togithub.com/avajs/ava/compare/v3.8.0...v3.8.1) #### Node.js 14 support Great news, this is a feature heavy release! First off, though, AVA now officially supports Node.js 14. Thank you [@zackschuster](https://togithub.com/zackschuster)! [`2e7c76b`](https://togithub.com/avajs/ava/commit/2e7c76b85cb65a04605fed843ee2f571afc66c37) #### Run tests at specific line numbers AVA can now run tests at specific line numbers! 🎉 Given the following test file: `test.js` ```js 1: test('unicorn', t => { 2: t.pass(); 3: }); 4: 5: test('rainbow', t => { 6: t.fail(); 7: }); ``` Running `npx ava test.js:2` for would run the `unicorn` test. In fact you could use any line number between `1` and `3`. This feature is only available from the command line. It won't work if you use tools like `ts-node/register` or `@babel/register`, and it does not currently work with `@ava/babel` and `@ava/typescript`. See [https://github.com/avajs/ava/issues/2473](https://togithub.com/avajs/ava/issues/2473). Thank you [@ulken](https://togithub.com/ulken) for your hard work and patience to get this shipped. [`1222ce9`](https://togithub.com/avajs/ava/commit/1222ce9538e4890c20af695e558e3ee490f5a41b) #### Test-specific teardown functions Sometimes tests have side-effects you want to clean up. [@ulken](https://togithub.com/ulken) has implemented `t.teardown()` which lets you register teardown functions *within* your test. They'll run once your test has finished, even if it failed: [`75cbc3b`](https://togithub.com/avajs/ava/commit/75cbc3b2a53d3b8530266b10bed71b838bc11fec) test('read file', t => { fs.writeFileSync('file.txt', '👋'); t.teardown(() => fs.unlinkSync('file.txt'); // Run assertions }); #### Node.js internal in stack traces Thanks to [@bunysae](https://togithub.com/bunysae), stack traces now include Node.js internals. Previously we removed them because we wanted you to focus on your own code, but quite often they do provide context. Now they're displayed, but somewhat dimmed. [`9a9351d`](https://togithub.com/avajs/ava/commit/9a9351ddbee9c6c76601210c5dd8f5b0d81cc3b0) #### Watch mode with the default reporter Watch mode with the default reporter once again accepts key input. Thanks [@pcdevil](https://togithub.com/pcdevil)! [`59c227d`](https://togithub.com/avajs/ava/commit/59c227d9c5261117d99e8e84693b9c89c3438a92) #### ICYMI - `afterEach()` and `afterEach.always()` hooks can now determine whether the test passed. Thank you [@bunysae](https://togithub.com/bunysae) for contributing this! [`8f312c0`](https://togithub.com/avajs/ava/commit/8f312c0) ```js test('passes', t => t.pass()); test.afterEach(t => { if (t.passed) { // Do something because the test passed } else { // Do something because the test failed } }); ``` - If you've ever wanted to save some files along with AVA's snapshots, you can now determine the directory path by accessing `test.meta.snapshotDirectory`. Thank you [@ulken](https://togithub.com/ulken)! [`cb5f9f7`](https://togithub.com/avajs/ava/commit/cb5f9f7) #### All changes See https://github.com/avajs/ava/compare/v3.7.1...v3.8.1 for all changes. ### [`v3.8.0`](https://togithub.com/avajs/ava/compare/v3.7.1...v3.8.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.7.1...v3.8.0) ### [`v3.7.1`](https://togithub.com/avajs/ava/releases/v3.7.1) [Compare Source](https://togithub.com/avajs/ava/compare/v3.7.0...v3.7.1) - Support parallel runs that do not need to run test files, courtesy of [@micaelmbagira](https://togithub.com/micaelmbagira) [`26c8326`](https://togithub.com/avajs/ava/commit/26c8326b) ### [`v3.7.0`](https://togithub.com/avajs/ava/releases/v3.7.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.6.0...v3.7.0) If you've ever wanted to save some files along with AVA's snapshots, you can now determine the directory path by accessing `test.meta.snapshotDirectory`. Thank you [@ulken](https://togithub.com/ulken) ! [`cb5f9f7`](https://togithub.com/avajs/ava/commit/cb5f9f70879ee549837c31e577e01f87970164ed) See https://github.com/avajs/ava/compare/v3.6.0...v3.7.0 for all changes. ### [`v3.6.0`](https://togithub.com/avajs/ava/releases/v3.6.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.5.2...v3.6.0) `afterEach()` and `afterEach.always()` hooks can now determine whether the test passed. Thank you [@bunysae](https://togithub.com/bunysae) for contributing this! [`8f312c0`](https://togithub.com/avajs/ava/commit/8f312c0f2c978ba39baae0f701015d79af18cbde): ```js test('passes', t => t.pass()); test.afterEach(t => { if (t.passed) { // Do something because the test passed } else { // Do something because the test failed } }); ``` [@mbiesiad](https://togithub.com/mbiesiad) has diligently [translated our documentation to Polish](https://togithub.com/avajs/ava-docs/tree/master/pl_PL). Thank you [@kekuu](https://togithub.com/kekuu) for reviewing. Also thank you [@timgates42](https://togithub.com/timgates42) for fixing a typo in our documentation. [`ede4f32`](https://togithub.com/avajs/ava/commit/ede4f322b4fa6263c8ae14ec04282ab06bb0afd4) See https://github.com/avajs/ava/compare/v3.5.0...v3.6.0 for all changes. ### [`v3.5.2`](https://togithub.com/avajs/ava/compare/v3.5.1...v3.5.2) [Compare Source](https://togithub.com/avajs/ava/compare/v3.5.1...v3.5.2) ### [`v3.5.1`](https://togithub.com/avajs/ava/compare/v3.5.0...v3.5.1) [Compare Source](https://togithub.com/avajs/ava/compare/v3.5.0...v3.5.1) ### [`v3.5.0`](https://togithub.com/avajs/ava/releases/v3.5.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.4.0...v3.5.0) When using `ava debug`, you can now specify the address or hostname the inspector is available through by using the `--host` option. Thanks to [@DYefimov](https://togithub.com/DYefimov) for contributing this! [`13d6651`](https://togithub.com/avajs/ava/commit/13d66519) See https://github.com/avajs/ava/compare/v3.4.0...v3.5.0 for all changes. Spoiler alert: it's just this one 😉 ### [`v3.4.0`](https://togithub.com/avajs/ava/releases/v3.4.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.3.0...v3.4.0) #### Introducing the `t.try()` assertion The new `t.try()` allows you to *try* assertions without causing the test to fail: ```js test('do the thing', async t => { const attempt = () => t.try(async tt => { const result = await getResult() // getResult() can be flaky and sometimes throws :( tt.is(result, 'expected') }) const firstAttempt = await attempt() if (firstAttempt.passed) return firstAttempt.commit() t.log('Retrying (just once)') firstAttempt.discard() const secondAttempt = await attempt() secondAttempt.commit() }) ``` You can use any test implementation with `t.try()`, including (arrays of) [macros](https://togithub.com/avajs/ava/blob/master/docs/01-writing-tests.md#reusing-test-logic-through-macros). You can decide what to do with attempts. You can even run attempts concurrently, so long as they don't use snapshot assertions. This is great building block for handling all kinds of advanced test scenarios. We can't wait to see what you'll do with it! Find out more in the [assertion documentation](https://togithub.com/avajs/ava/blob/master/docs/03-assertions.md#trytitle-implementation--macro--macro-args). This feature was previously behind an experimental flag. That flag has now been removed. If you have enabled the flag you'll have to update your AVA config. Also note that as of this release, attempt titles are always prefixed with the title of the parent test [`7ee3a0e`](https://togithub.com/avajs/ava/commit/7ee3a0e5940a105dec447851c777ea44555e8220). Once again, thank you [@qlonik](https://togithub.com/qlonik) for contributing this new assertion. #### In case you missed it: ESM support As of the [3.3.0](https://togithub.com/avajs/ava/releases/tag/v3.3.0) release, AVA can load ESM test files! Check our updated [ES Modules recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/es-modules.md) for details. Our ESM support is still incomplete. Progress is tracked in the [ESM support project](https://togithub.com/orgs/avajs/projects/2). Join us, won't you? #### Other changes - The `t.throws()` and `t.throwsAsync()` assertions can now be called with `undefined` as the second argument. Previously, if you wanted to set an assertion message but did not want to provide any expectations for the thrown error you had to pass `null`. That's still allowed, of course. [`d0e2161`](https://togithub.com/avajs/ava/commit/d0e21612390d50f084f7062b051164624ef391ff) [@stavalfi](https://togithub.com/stavalfi) - `ava.config.js` files once again work with our [`@ava/typescript`](https://togithub.com/avajs/typescript) package [`f4d4edd`](https://togithub.com/avajs/ava/commit/f4d4edd3379e51ac733b184e20dd0228be24245a) - Our TypeScript definition no longer references `@types/node` [`7a1dacf`](https://togithub.com/avajs/ava/commit/7a1dacf369a5857309effa42fc1638d7b8fe4ead) - We've improved the error message shown when `test.cb()` is used with asynchronous functions or observables [`f5a8c2b`](https://togithub.com/avajs/ava/commit/f5a8c2b2df757886247492ce3372f1e18da36ab7) [@toddkcarlson](https://togithub.com/toddkcarlson) - The [Vue recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/vue.md) has been updated to use `jsdom-global` instead of `browser-env` [`3f9c616`](https://togithub.com/avajs/ava/commit/3f9c616b44c7374404d75af63f393750160c6b84) [@Scrum](https://togithub.com/Scrum) - [@fisker](https://togithub.com/fisker) optimized how we detect ESM support [`8831f54`](https://togithub.com/avajs/ava/commit/8831f54d760bbcadf8924ef6b10899a6b786c3b5) See https://github.com/avajs/ava/compare/v3.3.0...v3.4.0 for all changes. ### [`v3.3.0`](https://togithub.com/avajs/ava/releases/v3.3.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.2.0...v3.3.0) AVA can now load ESM test files! 🎉Thank you [@arlac77](https://togithub.com/arlac77) for making this happen. Check our updated [ES Modules recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/es-modules.md) for details. Our ESM support is still incomplete. Progress is tracked in the [ESM support project](https://togithub.com/orgs/avajs/projects/2). Join us, won't you? #### Other changes See https://github.com/avajs/ava/compare/v3.2.0...v3.3.0 for all changes. ### [`v3.2.0`](https://togithub.com/avajs/ava/releases/v3.2.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.1.0...v3.2.0) This release improves the integration with the new [`@ava/typescript`][@ava/typescript] package, which allows AVA to load pre-compiled TypeScript files. First, install the new [`@ava/typescript`][@ava/typescript] package: ```console npm install --save-dev @ava/typescript@^1.1 ``` Now let's assume your TypeScript files are in a `src` directory, output to a `build` directory. Configure AVA like so: `ava.config.js` file: ```js export default { typescript: { rewritePaths: { 'src/': 'build/' } } } ``` Compile your TypeScript files and run your tests! Or, to run a specific test file, run `npx ava src/test.ts`. For more examples see the [`@ava/typescript`][@ava/typescript] package. As exciting as this is, it's still early days. We need your help improving our TypeScript support. Check out the [open issues](https://togithub.com/avajs/typescript/issues). [`@ava/typescript`]: https://togithub.com/avajs/typescript #### Other changes See https://github.com/avajs/ava/compare/v3.1.0...v3.2.0 for all changes. ### [`v3.1.0`](https://togithub.com/avajs/ava/releases/v3.1.0) [Compare Source](https://togithub.com/avajs/ava/compare/v3.0.0...v3.1.0) AVA can now load pre-compiled TypeScript files! First, install the new [`@ava/typescript`][@ava/typescript] package: ```console npm install --save-dev @ava/typescript ``` Now let's assume your TypeScript files are in a `src` directory, output to a `build` directory. Configure AVA like so: `ava.config.js` file: ```js export default { typescript: { rewritePaths: { 'src/': 'build/' } } } ``` Compile your TypeScript files and run your tests! Or, to run a specific test file, run `npx ava src/test.ts`. For more examples see the [`@ava/typescript`][@ava/typescript] package. As exciting as this is, it's still early days. We need your help improving our TypeScript support. Check out the [open issues](https://togithub.com/avajs/typescript/issues). [`@ava/typescript`]: https://togithub.com/avajs/typescript #### Other changes Thanks to [@jhechtf](https://togithub.com/jhechtf) for fixing our TypeScript recipe after the changes in AVA 3.0 [`91a0086`](https://togithub.com/avajs/ava/commit/91a00864f7f113dd63a2c4ecc383fc8c45f79665) See https://github.com/avajs/ava/compare/v3.0.0...v3.1.0 for all changes. ### [`v3.0.0`](https://togithub.com/avajs/ava/releases/v3.0.0) [Compare Source](https://togithub.com/avajs/ava/compare/v2.4.0...v3.0.0) ### We're proud to introduce AVA 3! 🚀 When we began AVA, JavaScript was very different. Most syntax you find familiar today was not supported by Node.js. Instead we relied on [Babel](https://babeljs.io/) to support that syntax before it made its way to Node.js itself. These days most new [stage-4](https://togithub.com/tc39/proposals/blob/master/finished-proposals.md) syntax is adopted quickly. It's often not necessary to transpile anything. Therefore we're removing our built-in Babel support from AVA itself. Without Babel you'll have to resort to using `require()` functions in your JavaScript files. But, you say, [Node.js 13 supports ECMAScript Modules](https://nodejs.org/api/esm.html)! Well, we're getting there. For a start, AVA now also looks for `.cjs` files. And `.mjs` files are recognized too, but can't be loaded just yet. This also impacts `ava.config.js` files. If you'd like to help out delivering full `.mjs` support check out the issues in the [ESM support project](https://togithub.com/orgs/avajs/projects/2). Removing Babel allowed us to simplify how test files are selected. Likely non-test files, inside "fixture" or "helper" directories are ignored. The same for files that are inside an underscore-prefixed directory. We've made some other breaking changes in this area so please do read the full release notes. You can again pass glob patterns on the CLI. However these now filter the test files that AVA already selected based on the configuration. In other words you can't run files that wouldn't be run by invoking `npx ava`. AVA now interrupts your tests if there's no progress for 10 seconds. Use the `timeout` configuration or `--timeout` CLI option to change this. #### New features ##### Built-in debug mode You can now debug individual test files using the V8 Inspector: ```console npx ava debug test.js ``` Connect to the debugger with [Chrome DevTools](https://togithub.com/avajs/ava/blob/master/docs/recipes/debugging-with-chrome-devtools.md). Or [set up a debugger in VSCode](https://togithub.com/avajs/ava/blob/master/docs/recipes/debugging-with-vscode.md). ##### Configurable Node.js arguments You can now configure the arguments passed to Node.js itself when AVA starts its worker processes. Use the `nodeArguments` configuration or combine with the `--node-arguments` CLI option. #### All breaking changes ##### Supported Node.js versions We now support Node.js 10, 12 and 13. The minimal versions are 10.18.0, 12.14.0 and 13.5.0 respectively. ##### Removing Babel Utilize Babel with AVA by installing our [`@ava/babel`](https://togithub.com/avajs/babel) package and then enabling Babel by setting `babel: true` in the AVA configuration. Having this as a separate package means it can evolve independently. The `compileEnhancements` setting has been moved into the `babel` configuration. Consequently, the `t.assert()` assertion will only print its detailed information when you use Babel. And we won't be able to catch typical mistakes with `t.throws()` as well as we could before. The `ava/stage-4` preset is now available from `@ava/babel/stage-4`. Our old `@ava/babel-preset-transform-test-files` and `@ava/babel-preset-stage-4` packages are no longer maintained and not installed with AVA itself. ##### ECMAScript Module Support AVA now also looks for `.cjs` and `.mjs` test files. That said, `.mjs` files cannot be loaded just yet. Also, when you add `"type": "module"` , AVA would really like to treat `.js` files as ECMAScript Modules, but can't just yet. Similarly,`ava.config.cjs` configuration files are now supported. `ava.config.mjs` files not just yet. With AVA 2, we loaded `ava.config.js` files using the [`esm`](https://www.npmjs.com/package/esm) package. To avoid confusion between the different module formats we now *only* support `export default` statements. No `import`, no `__filename`. Configuration files that have dependencies should be written as a `.cjs` file for now. Configuration files can only have `.cjs`, `.js` and `.mjs` extensions. The remaining work is tracked in the [ESM support project](https://togithub.com/orgs/avajs/projects/2). ##### File selection When you use the default configuration AVA will no longer select files matching the following glob patterns: - `**/__tests__/**/__helper__/**/*` - `**/__tests__/**/__helpers__/**/*` - `**/__tests__/**/__fixture__/**/*` - `**/__tests__/**/__fixtures__/**/*` - `**/test/**/helper/**/*` - `**/test/**/helpers/**/*` - `**/test/**/fixture/**/*` - `**/test/**/fixtures/**/*` - `**/tests/**/helper/**/*` - `**/tests/**/helpers/**/*` - `**/tests/**/fixture/**/*` - `**/tests/**/fixtures/**/*` Additionally, when a file has a parent directory that starts with a *single* underscore, it can never be a test file. `test.js` files are only selected if they're next to the `package.json` file, or inside top-level `src` and ` source `directories. We've removed the configuration of helpers. Previously, files selected by the `helpers` glob patterns were never considered test files. Now that this configuration is no longer supported you'll need to ensure the `files` patterns exclude your helper files. If you're using Babel, you can configure [the compilation of additional files](https://togithub.com/avajs/babel#compile-additional-files) . The `sources` configuration has also been removed. Instead, use the `ignoredByWatcher` configuration. Changes to files matched by these glob patterns will not cause the watcher to rerun tests. Negated `sources` patterns must be used without the negation in `ignoredByWatcher`: ```diff export default { - sources: ['!examples/**/*'] + ignoredByWatcher: ['examples/**/*'] } ``` ##### CLI changes Internally we've replaced [`meow`](https://www.npmjs.com/package/meow) by [`yargs`](https://www.npmjs.com/package/yargs). We're not expecting things to break because of this, but you never know. ##### Resetting the cache The `--reset-cache` argument has been replaced by a proper `reset-cache` command: ```console npx ava reset-cache ``` ##### File selection (again!) AVA again accepts glob patterns via the CLI: ```console npx ava '**/api/**/*' ``` The way this work is that AVA first finds all test files, according to the configuration, and then filters to select just the files that also match the glob patterns passed via the CLI. You can still pass paths to specific files: ```console npx ava src/api/test/my-api-test.js ``` However unlike with AVA 2, you can no longer specify test files that aren't already selected by AVA's configuration. ##### `t.throws()` and `t.throwsAsync()` assertions The second argument passed to these assertions must now be an `expectation` object. You can no longer pass the expected constructor, error message or regular expression. ##### Other breaking changes - Support for old [`esm`](https://www.npmjs.com/package/esm) versions has been removed. - We've set a default test timeout of 10 seconds. This means that if no test results are received for 10 seconds, AVA forces its worker processes to quit. - The `NODE_PATH` environment variable is no longer rewritten to ensure values are absolute paths. - AVA longer fakes the TTY in worker processes. #### Other changes - We've simplified how we identify observables. Any object returned by a test implementation that has a `subscribe` function is assumed to be an observable. AVA's type definition has been updated accordingly. - The TAP reporter now reports hook failures as test failures. - We've added an example of [module path mapping to our TypeScript recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/typescript.md#using-module-path-mapping). - We've added a [Selenium WebDriver JS recipe](https://togithub.com/avajs/ava/blob/master/docs/recipes/testing-with-selenium-webdriverjs.md). #### All changes #### Thanks Thank you [@tymfear](https://togithub.com/tymfear), [@HeathNaylor](https://togithub.com/HeathNaylor), [@grnch](https://togithub.com/grnch), [@alexdrans](https://togithub.com/alexdrans), [@MoppetX](https://togithub.com/MoppetX), [@jimmywarting](https://togithub.com/jimmywarting), [@micaelmbagira](https://togithub.com/micaelmbagira), [@aptester](https://togithub.com/aptester), [@theashraf](https://togithub.com/theashraf), [@sramam](https://togithub.com/sramam) and [@maximelkin](https://togithub.com/maximelkin). We couldn't have done this without you!Configuration
📅 Schedule: 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.
This PR has been generated by WhiteSource Renovate. View repository job log here.