schema-tools
schema-tools copied to clipboard
chore(deps): update dependency ava to version 4.x 🌟
This PR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| ava (source) | 2.4.0 -> 4.3.3 |
Release Notes
avajs/ava
v4.3.3
Add compatibility with Node.js 18.8, thanks @Brooooooklyn #3091.
Full Changelog: https://github.com/avajs/ava/compare/v4.3.1...v4.3.3
v4.3.2
v4.3.1
What's Changed
- When translating line numbers, check whether the source map entry has original values in https://github.com/avajs/ava/pull/3061
- Report error when parsing for line number selection in https://github.com/avajs/ava/pull/3062
New Contributors
- @ericcornelissen made their first contribution in https://github.com/avajs/ava/pull/3048
- @AlencarGabriel made their first contribution in https://github.com/avajs/ava/pull/3051
- @binyamin made their first contribution in https://github.com/avajs/ava/pull/3028
Full Changelog: https://github.com/avajs/ava/compare/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 https://github.com/avajs/ava/pull/3024
throwsandthrowsAsyncassertions now take a function to test error messages, by @il3ven in https://github.com/avajs/ava/pull/2995- Test failure summaries no longer duplicate
t.log()messages, by @il3ven in https://github.com/avajs/ava/pull/3013 - The number of timed-out tests is printed at the end of a run, by @il3ven in https://github.com/avajs/ava/pull/3021
- We've documented how to load multiple instances of the same "shared" worker, by @codetheweb in https://github.com/avajs/ava/pull/3009
- Links to translated documentation have been updated, by @forresst in https://github.com/avajs/ava/pull/3037
- Node.js 17 has been removed from the test matrix, and Node.js 18 added in https://github.com/avajs/ava/pull/3039
Full Changelog: https://github.com/avajs/ava/compare/v4.2.0...v4.3.0
v4.2.0
What's Changed
- Update Babel recipe for AVA 4 by @il3ven in https://github.com/avajs/ava/pull/3000
- Document how GitHub Actions can be configured for parallel builds by @codetheweb in https://github.com/avajs/ava/pull/3007
- Allow parallel builds to be disabled by @il3ven in https://github.com/avajs/ava/pull/3001
- Improve typing of teardown methods by @novemberborn in https://github.com/avajs/ava/pull/3003
New Contributors
- @mefengl made their first contribution in https://github.com/avajs/ava/pull/2999
- @il3ven made their first contribution in https://github.com/avajs/ava/pull/3000
- @codetheweb made their first contribution in https://github.com/avajs/ava/pull/3007
Full Changelog: https://github.com/avajs/ava/compare/v4.1.0...v4.2.0
v4.1.0
New features
- Allow customized sorting of test files prior to execution using
sortTestFiles()inava.config.jsfiles by @erezrokah in https://github.com/avajs/ava/pull/2968 - Warn when unsupported
ava.config.jsonfiles are encountered by @razor-x in https://github.com/avajs/ava/pull/2962 - Loosen type constraints for
deepEqualassertion by @RebeccaStevens in https://github.com/avajs/ava/pull/2969
Fixes
ava --versionworks again by @novemberborn in https://github.com/avajs/ava/pull/2961
New Contributors
- @sikrinick made their first contribution in https://github.com/avajs/ava/pull/2958
- @scottdotjs made their first contribution in https://github.com/avajs/ava/pull/2954
- @gibson042 made their first contribution in https://github.com/avajs/ava/pull/2975
- @erezrokah made their first contribution in https://github.com/avajs/ava/pull/2968
- @razor-x made their first contribution in https://github.com/avajs/ava/pull/2962
- @RebeccaStevens made their first contribution in https://github.com/avajs/ava/pull/2969
Full Changelog: https://github.com/avajs/ava/compare/v4.0.1...v4.1.0
v4.0.1
What's Changed
- Fix encoding of large snapshot data by @novemberborn in https://github.com/avajs/ava/pull/2936
Full Changelog: https://github.com/avajs/ava/compare/v4.0.0...v4.0.1
v4.0.0
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/babelhas 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/[email protected]or newer. - Support for the
esmpackage has been removed.
Configuration 🗒
ava.config.jsnow 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.fileandtest.meta.snapshotDirectoryare 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 anullvalue 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 -uto 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
instanceOfexpectation oft.throws()andt.throwsAsync()assertions must now be anErrorconstructor. - You’re expected to use
test.macro()when declaring macros. - Implementation arguments now default to
unknown. - Types have been renamed.
MetareplacesMetaInterface, other types withInterfacesuffixes now use theFnsuffix. There may be some other changes too.4b4b2f6 t.throws()andt.throwsAsync()returnundefinedwhen 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
--configargument may now point to a file that is not alongside thepackage.jsonfile. - 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
.testand.specextensions 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 https://github.com/avajs/ava/pull/2750
- @OhYash made their first contribution in https://github.com/avajs/ava/pull/2758
- @KillyMXI made their first contribution in https://github.com/avajs/ava/pull/2773
- @mcecode made their first contribution in https://github.com/avajs/ava/pull/2794
- @duncanfinney made their first contribution in https://github.com/avajs/ava/pull/2820
- @asaid-0 made their first contribution in https://github.com/avajs/ava/pull/2788
- @bompus made their first contribution in https://github.com/avajs/ava/pull/2843
- @StefanoA1 made their first contribution in https://github.com/avajs/ava/pull/2849
- @live627 made their first contribution in https://github.com/avajs/ava/pull/2851
- @alessandroasm made their first contribution in https://github.com/avajs/ava/pull/2863
- @eltociear made their first contribution in https://github.com/avajs/ava/pull/2870
- @hamidbae made their first contribution in https://github.com/avajs/ava/pull/2878
- @rrichardson made their first contribution in https://github.com/avajs/ava/pull/2910
- @make-github-pseudonymous-again made their first contribution in https://github.com/avajs/ava/pull/2913
- @lightmare made their first contribution in https://github.com/avajs/ava/pull/2918
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
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! 4f093ab
TAP improvements
@tymfear has been on a roll improving our TAP reporter. t.log() output is now compliant with the spec 99ab93a. Tests that did not run due to timeouts are now reported 98595da.
Next-generation configuration
AVA 4 will add full support for ESM configuration files as well as allowing you to have asynchronous factory functions a2f2614. 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:
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" 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
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! e66b54c
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.
See https://github.com/avajs/ava/compare/v3.13.0...v3.14.0 for all changes.
v3.13.0
t.passedcan now be used in tests and teardown functions. Thanks @tymfear!900dc6d- In AVA 4, you'll no longer be able to pass
nullas the expectation fort.throws()&t.throwsAsync(). You can opt in to this early by enabling thedisableNullExpectationsexperiment. Thanks @JSimoni42!f328a69 - The Enzyme recipe has been updated. Thanks @jonathansamines!
db5d2c3 - The TypeScript recipe has been updated. Thanks @SephReed!
a3379fa
See https://github.com/avajs/ava/compare/v3.12.1...v3.13.0 for all changes.
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 feature. Read more in our documentation. Thank you @macarie for working on this! 5c9dbb9
Comparison bugfix
There was a bug in our comparison library 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 for making sure our ESM example used ESM syntax (20bc781).
v3.12.0
v3.11.1
This release fixes corrupted output of the default reporter when test or program code writes to standard out. 5ddc9fd
Also, thanks to @jonathansamines we've taken another step to using AVA to test AVA. 1150991
See https://github.com/avajs/ava/compare/v3.11.0...v3.11.1 for all changes.
v3.11.0
New t.like() assertion
Thanks to @futpib we now have a t.like() assertion 19c4f35:
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.
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.
This assertion was previously introduced 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 accordingly. Thank you @connor4312 for the documentation updates and your work on VSCode! bc39bcc
All changes
See https://github.com/avajs/ava/compare/v3.10.1...v3.11.0 for all changes.
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 for putting this together. f72fab4
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 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
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 it now fails properly instead of crashing. d01db61
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 d01db61.
Fixed TypeScript definition for t.like()
The experimental t.like() assertion 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
v3.9.0
New experiments!
Thanks to @futpib we now have an experimental t.like() assertion 19c4f35:
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.
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 and let us know what you think.
@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. This will be the behavior in AVA 4.
To enable both these experiments update your AVA configuration:
package.json:
{
"ava": {
"nonSemVerExperiments": {
"likeAssertion": true,
"reverseTeardowns": true
}
}
}
ava.config.js:
export default {
nonSemVerExperiments: {
likeAssertion: true,
reverseTeardowns: true
}
}
Reporter changes
@Michael55555 has helped us combine our reporter code into a single file b3866b6. We've also made some other tweaks and improvements baaf99a. Let us know if anything seems amiss.
Improved diffs
@bunysae made it so that missing or extraneous objects in diffs are printed with extra depth https://github.com/concordancejs/concordance/pull/62.
Farewell Node.js 13
Node.js 13 has reached end-of-life. Per our support statement 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 and @Autre31415 for contributing documentation improvements.
v3.8.2
- Fix bad dependency
fd92b4a - Use configured depth limit for diffs in assertion failures, thanks @bunysae!
a5385a4
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! 2e7c76b
Run tests at specific line numbers
AVA can now run tests at specific line numbers! 🎉
Given the following test file:
test.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.
Thank you @ulken for your hard work and patience to get this shipped. 1222ce9
Test-specific teardown functions
Sometimes tests have side-effects you want to clean up. @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
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, 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
Watch mode with the default reporter
Watch mode with the default reporter once again accepts key input. Thanks @pcdevil! 59c227d
ICYMI
-
afterEach()andafterEach.always()hooks can now determine whether the test passed. Thank you @bunysae for contributing this!8f312c0test('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!cb5f9f7
All changes
See https://github.com/avajs/ava/compare/v3.7.1...v3.8.1 for all changes.
v3.8.0
v3.7.1
- Support parallel runs that do not need to run test files, courtesy of @micaelmbagira
26c8326
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 ! cb5f9f7
See https://github.com/avajs/ava/compare/v3.6.0...v3.7.0 for all changes.
v3.6.0
afterEach() and afterEach.always() hooks can now determine whether the test passed. Thank you @bunysae for contributing this! 8f312c0:
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 has diligently translated our documentation to Polish. Thank you @kekuu for reviewing.
Also thank you @timgates42 for fixing a typo in our documentation. ede4f32
See https://github.com/avajs/ava/compare/v3.5.0...v3.6.0 for all changes.
v3.5.2
v3.5.1
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 for contributing this! 13d6651
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
Introducing the t.try() assertion
The new t.try() allows you to try assertions without causing the test to fail:
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. 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.
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.
Once again, thank you @qlonik for contributing this new assertion.
In case you missed it: ESM support
As of the 3.3.0 release, AVA can load ESM test files! Check our updated ES Modules recipe for details.
Our ESM support is still incomplete. Progress is tracked in the ESM support project. Join us, won't you?
Other changes
- The
t.throws()andt.throwsAsync()assertions can now be called withundefinedas 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 passnull. That's still allowed, of course.d0e2161@stavalfi ava.config.jsfiles once again work with our@ava/typescriptpackagef4d4edd- Our TypeScript definition no longer references
@types/node7a1dacf - We've improved the error message shown when
test.cb()is used with asynchronous functions or observablesf5a8c2b@toddkcarlson - The Vue recipe has been updated to use
jsdom-globalinstead ofbrowser-env3f9c616@Scrum - @fisker optimized how we detect ESM support
8831f54
See https://github.com/avajs/ava/compare/v3.3.0...v3.4.0 for all changes.
v3.3.0
AVA can now load ESM test files! 🎉Thank you @arlac77 for making this happen. Check our updated ES Modules recipe for details.
Our ESM support is still incomplete. Progress is tracked in the ESM support project. 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
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:
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:
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.
Other changes
See https://github.com/avajs/ava/compare/v3.1.0...v3.2.0 for all changes.
v3.1.0
AVA can now load pre-compiled TypeScript files!
First, install the new [@ava/typescript][@ava/typescript] package:
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:
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.
Other changes
Thanks to @jhechtf for fixing our TypeScript recipe after the changes in AVA 3.0 91a0086
See https://github.com/avajs/ava/compare/v3.0.0...v3.1.0 for all changes.
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 to support that syntax before it made its way to Node.js itself.
These days most new stage-4 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!
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.
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:
npx ava debug test.js
Connect to the debugger with Chrome DevTools. Or set up a debugger in VSCode.
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 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 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.
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 .
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:
export default {
- sources: ['!examples/**/*']
+ ignoredByWatcher: ['examples/**/*']
}
CLI changes
Internally we've replaced meow by 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:
npx ava reset-cache
File selection (again!)
AVA again accepts glob patterns via the CLI:
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:
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
esmversions 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_PATHenvironment 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
subscribefunction 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.
- We've added a Selenium WebDriver JS recipe.
All changes
Thanks
Thank you @tymfear, @HeathNaylor, @grnch, @alexdrans, @MoppetX, @jimmywarting, @micaelmbagira, @aptester, @theashraf, @sramam and @maximelkin. We couldn't have done this without you!
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - 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, click this checkbox.
This PR has been generated by Mend Renovate. View repository job log here.
⚠ Artifact update problem
Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.
♻ Renovate will retry this branch, including artifacts, only when one of the following happens:
- any of the package files in this branch needs updating, or
- the branch becomes conflicted, or
- you click the rebase/retry checkbox if found above, or
- you rename this PR's title to start with "rebase!" to trigger it manually
The artifact failure details are included below:
File name: package-lock.json
ERROR: npm is known not to run on Node.js v8.17.0
You'll need to upgrade to a newer Node.js version in order to use this
version of npm. You can find the latest version at https://nodejs.org/
ERROR: npm is known not to run on Node.js v8.17.0
You'll need to upgrade to a newer Node.js version in order to use this
version of npm. You can find the latest version at https://nodejs.org/