Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^1.0.1
->^3.0.0
Release Notes
avajs/ava
v3.13.0
Compare Source
t.passed
can now be used in tests and teardown functions. Thanks @tymfear!900dc6d
null
as the expectation fort.throws()
&t.throwsAsync()
. You can opt in to this early by enabling thedisableNullExpectations
experiment. Thanks @JSimoni42!f328a69
db5d2c3
a3379fa
See avajs/ava@v3.12.1...v3.13.0 for all changes.
v3.12.1
Compare Source
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 yourpackage.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 avajs/ava@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
Compare Source
v3.11.1
Compare Source
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 avajs/ava@v3.11.0...v3.11.1 for all changes.
v3.11.0
Compare Source
New
t.like()
assertionThanks to @futpib we now have a
t.like()
assertion19c4f35
:In the following example, the
map
property ofvalue
must be deeply equal to that ofselector
. Howevernested.qux
is ignored, because it's not inselector
.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 avajs/ava@v3.10.1...v3.11.0 for all changes.
v3.10.1
Compare Source
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()
callsThanks 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
t.try()
does not work in hookst.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 eithert.snapshot()
sort of works in hooks, but we'll be removing this in AVA 4. You can opt in to this behavior by enabling thedisableSnapshotsInHooks
experiment. Again thank you @okyantorod01db61
.Fixed TypeScript definition for
t.like()
The experimental
t.like()
assertion should now work better with TypeScript.All changes
See avajs/ava@v3.9.0...v3.10.1 for all changes.
v3.10.0
Compare Source
v3.9.0
Compare Source
New experiments!
Thanks to @futpib we now have an experimental
t.like()
assertion19c4f35
:In the following example, the
map
property ofvalue
must be deeply equal to that ofselector
. Howevernested.qux
is ignored, because it's not inselector
.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 first952a017
. This will be the behavior in AVA 4.To enable both these experiments update your AVA configuration:
package.json
:ava.config.js
:Reporter changes
@Michael55555 has helped us combine our reporter code into a single file
b3866b6
. We've also made some other tweaks and improvementsbaaf99a
. 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 concordancejs/concordance#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 avajs/ava@v3.8.2...v3.9.0 for all changes. Thank you @paulrobertlloyd and @Autre31415 for contributing documentation improvements.
v3.8.2
Compare Source
fd92b4a
a5385a4
v3.8.1
Compare Source
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
Running
npx ava test.js:2
for would run theunicorn
test. In fact you could use any line number between1
and3
.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 #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
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!8f312c0
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 avajs/ava@v3.7.1...v3.8.1 for all changes.
v3.8.0
Compare Source
v3.7.1
Compare Source
26c8326
v3.7.0
Compare Source
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 avajs/ava@v3.6.0...v3.7.0 for all changes.
v3.6.0
Compare Source
afterEach()
andafterEach.always()
hooks can now determine whether the test passed. Thank you @bunysae for contributing this!8f312c0
:@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 avajs/ava@v3.5.0...v3.6.0 for all changes.
v3.5.2
Compare Source
v3.5.1
Compare Source
v3.5.0
Compare Source
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 avajs/ava@v3.4.0...v3.5.0 for all changes. Spoiler alert: it's just this one 😉
v3.4.0
Compare Source
Introducing the
t.try()
assertionThe new
t.try()
allows you to try assertions without causing the test to fail: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
t.throws()
andt.throwsAsync()
assertions can now be called withundefined
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 passnull
. That's still allowed, of course.d0e2161
@stavalfiava.config.js
files once again work with our@ava/typescript
packagef4d4edd
@types/node
7a1dacf
test.cb()
is used with asynchronous functions or observablesf5a8c2b
@toddkcarlsonjsdom-global
instead ofbrowser-env
3f9c616
@Scrum8831f54
See avajs/ava@v3.3.0...v3.4.0 for all changes.
v3.3.0
Compare Source
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 avajs/ava@v3.2.0...v3.3.0 for all changes.
v3.2.0
Compare Source
This release improves the integration with the new
@ava/typescript
package, which allows AVA to load pre-compiled TypeScript files.First, install the new
@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 abuild
directory. Configure AVA like so:ava.config.js
file: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
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 avajs/ava@v3.1.0...v3.2.0 for all changes.
v3.1.0
Compare Source
AVA can now load pre-compiled TypeScript files!
First, install the new
@ava/typescript
package:npm install --save-dev @​ava/typescript
Now let's assume your TypeScript files are in a
src
directory, output to abuild
directory. Configure AVA like so:ava.config.js
file: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
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 avajs/ava@v3.0.0...v3.1.0 for all changes.
v3.0.0
Compare Source
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 impactsava.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 settingbabel: true
in the AVA configuration. Having this as a separate package means it can evolve independently.The
compileEnhancements
setting has been moved into thebabel
configuration. Consequently, thet.assert()
assertion will only print its detailed information when you use Babel. And we won't be able to catch typical mistakes witht.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 theesm
package. To avoid confusion between the different module formats we now only supportexport default
statements. Noimport
, 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 thepackage.json
file, or inside top-levelsrc
andsource
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 thefiles
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 theignoredByWatcher
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 inignoredByWatcher
:CLI changes
Internally we've replaced
meow
byyargs
. 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 properreset-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()
andt.throwsAsync()
assertionsThe 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
esm
versions has been removed.NODE_PATH
environment variable is no longer rewritten to ensure values are absolute paths.Other changes
subscribe
function is assumed to be an observable. AVA's type definition has been updated accordingly.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!
v2.4.0
Compare Source
Experimental
t.try()
assertionsThanks to the amazing work and patience of @qlonik we're shipping a new assertion!
t.try()
lets you perform assertions and decide whether to commit or discard their outcome. All kinds of interesting things can be built on top of this, from fuzzy testers to new test interfaces and more.We're excited to get this out there, but it's not quite done yet. For now you have to opt in to this new feature. Being opt-in, we may make changes (breaking ones even!) until we feel this is stable.
To opt in, configure AVA with the following:
package.json
:ava.config.js
:We'd love to hear your feedback. Please join us in this issue: #2250
Also, if you're looking to help out with the remaining issues so that we can ship this without the opt-in, have a look at this project: https://github.com/orgs/avajs/projects/1
Thanks again @qlonik!
Other changes
49b202f
67e4dea
All changes
v2.3.0...v2.4.0
Thanks
Thank you @jeremenichelli, @jamesgeorge007, @dongjae93, @qlonik and @tryzniak. We couldn't have done this without you!
Get involved
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
v2.3.0
Compare Source
Changes
ffa62ce
9e8d28f
f01d05f
8628976
b27cb8d
7dcb473
9baca8c
import-local@^3.0.2
which fixes issues with Lerna projects.t.context
tounknown
, in line with TypeScript's changes in their 3.5 release.2fc7d56
All changes
v2.2.0...v2.3.0
Thanks
Thank you @MarchWorks, @yovasx2 and @bobthekingofegypt. We couldn't have done this without you!
Get involved
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
v2.2.0
Compare Source
Enhancements
You can now specify an alternative config file, using the
--config
CLI argument. This is useful if you want to run unit tests separately from integration tests, since you can have a config file specific to your integration tests which specifies different glob patterns.2dae2bf
Bug fixes
We're now faking the new
hasColors()
method for better compatibility with Node.js 12.d399797
Node.js 11
We've removed Node.js 11 from our test matrix. You should upgrade to Node.js 12.
90acbb9
All changes
v2.1.0...v2.2.0
Thanks
Thank you @langri-sha, @keyspress, @cdaringe and @okyantoro. We couldn't have done this without you!
Get involved
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
v2.1.0
Compare Source
Bug fixes
bb44da7
Enhancements
486acaf
ac212ba
007c7af
b3c9ea7
All changes
v2.0.0...v2.1.0
Thanks
Thank you @anishkny, @yovasx2 and @mihai-dinu. We couldn't have done this without you!
Get involved
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
v2.0.0
Compare Source
Breaking changes
AVA now requires at least Node.js 8.9.4
Per the Node.js release schedule, the 6.x releases reach end of live on April 30th. Consequently we've removed support in AVA. We are now testing with Node.js 12 though.
3a4afc6
Test file and helper selection
We've been working on simplifying how test files and helpers are selected. First off, the
files
option now only accepts glob patterns. If you configured it with directories before, please add/**/*
to get the previous behavior.The
files
andsources
options must now be arrays containing at least one pattern. It's no longer possible to override a default exclusion pattern, but we're looking at making these configurable separately.AVA used to treat all files inside a
helpers
directory as test helpers. Finding these files could be really slow, however, and it also meant you couldn't have tests inside ahelpers
directory. Instead you can now specify glob paterns to find these helpers:Test files starting with an underscore are still recognized as helpers.
Files inside
fixtures
directories are no longer ignored, and will now be treated as test files. The watcher now also watchesava.config.js
files.AVA now also selects files ending with
.spec.js
when looking for tests, as well as looking intests
directories.08e99e5
b1e54b1
The CLI now only takes file paths, not glob patterns.
We'd like some help updating our ESLint plugin as well.
Snapshots in CI
When you run tests locally and add a new snapshot, AVA automatically updates the
.snap
file. However if you forget to commit this file and then run your CI tests, they won't fail because AVA quietly updates the.snap
file, just like it does locally.With this release, AVA will fail the
t.snapshot()
assertion if it is run in CI and no snapshot could be found.0804107
Assertion messages must be strings
AVA now enforces assertion messages to be strings. The message is only used when the assertion fails, and non-string values may cause AVA to crash. You may see test failures if you were accidentally passing a non-string message.
49120aa
Flow type definitions
We've decided to remove the Flow type definitions from AVA itself. We don't have anybody to maintain them and consequently they've become a blocker when adding features to AVA.
c633cf0
We've set up a new repository from which we'll publish the definitions, but we need your help setting it up. If you use AVA and Flow, please join us in avajs/flow-typed#1.
Observable typing
Test implementations may return observables. We've updated our TypeScript definition to require these to have a
Symbol.observable
function.c2d8218
New features
Configurable printing depth
AVA now uses the
util.inspect.defaultOptions.depth
option when printing objects, so you can configure the depth.98034fb
Specify environment variables in your AVA config
You can now specify environment variables in your config, using the
environmentVariables
object.a53ea15
Other changes
UntitledMacro
andUntitledCbMacro
types, for macro functions that will never have a.title
function. Though really this just helped simplify the type definition. Thanks @qlonik!ebf4807
cb4c809
test.skip(macro)
ba5cd80
51433be
All changes
v1.4.1...v2.0.0
Thanks
Thank you @StoneCypher, @LukasHechenberger, @lo1tuma, @htor, @alexisfontaine and @grnch. We couldn't have done this without you!
Get involved
We welcome new contributors. AVA is a friendly place to get started in open source. We have a great article on getting started contributing and a comprehensive contributing guide.
Renovate configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻️ Rebasing: Renovate will not automatically rebase this PR, because other commits have been found.
🔕 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.