3.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 v3.4.0...v3.5.0 for all changes. Spoiler alert: it's just this one 😉

3.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() 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 @stavalfi
• ava.config.js files once again work with our @ava/typescript package f4d4edd
• Our TypeScript definition no longer references @types/node 7a1dacf
• We've improved the error message shown when test.cb() is used with asynchronous functions or observables f5a8c2b @toddkcarlson
• The Vue recipe has been updated to use jsdom-global instead of browser-env 3f9c616 @Scrum
• @fisker optimized how we detect ESM support 8831f54

See v3.3.0...v3.4.0 for all changes.

3.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 v3.2.0...v3.3.0 for all changes.

3.2.0

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 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 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 v3.1.0...v3.2.0 for all changes.

3.1.0

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 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 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 v3.0.0...v3.1.0 for all changes.

3.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 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.
• We've added a Selenium WebDriver JS recipe.

All changes

v2.4.0...v3.0.0

Thanks

Thank you @tymfear, @HeathNaylor, @grnch, @alexdrans, @MoppetX, @jimmywarting, @micaelmbagira, @aptester, @theashraf, @sramam and @maximelkin. We couldn't have done this without you!

3.0.0 Beta 2

We've been busy building AVA 3. It comes with a fair amount of breaking changes but also some exciting features, like a built-in debug mode!

You can install the latest beta today:

npm install -D -E ava@next

This is the second beta release. It addresses the known issues from the first beta.

Please read the 3.0.0 Beta 1 release notes first

Fixes

• t.assert() once again counts as a passed assertion
• --update-snapshots works again
• console and process are available in ava.config.js files

Enhancements

• Timeouts are disabled in debug mode
• We've added a Selenium WebDriver JS recipe

All changes

v3.0.0-beta.1...v3.0.0-beta.2

Thanks

Thank you @aptester, @theashraf and @sramam. We couldn't have done this without you!

3.0.0 Beta 1

We've been busy building AVA 3. This is the first beta release. It comes with a fair amount of breaking changes but also some exciting features, like a built-in debug mode!

That said there are some known issues:

• Passing t.assert() does not count as a passed assertion
• Globals are no longer available when loading ava.config.js
• Cannot update snapshots

You can install the latest beta today:

npm install -D -E ava@next

Breaking changes

Removing Babel

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.

Instead you can 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

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 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

Removing Babel allowed us to simplify how test files are selected. First of all, 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.

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.

Other breaking changes

• Support for old 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.

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.

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.

All changes

v2.4.0...v3.0.0-beta.1

Thanks

Thank you @tymfear, @HeathNaylor, @grnch, @alexdrans, @MoppetX, @jimmywarting and @micaelmbagira. We couldn't have done this without you!

2.4.0

Experimental t.try() assertions

Thanks 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": {
    "nonSemVerExperiments": {
      "tryAssertion": true
    }
  }
}

ava.config.js:

export default {
	nonSemVerExperiments: {
		tryAssertion: true
	}
};

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

• We've added the common pitfall of sharing variables across asynchronous tests 49b202f
• We've updated the endpoint testing recipe to focus on the concept, not specific libraries 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.

2.3.0

Changes

• We've fixed some bugs to improve watch mode. ffa62ce 9e8d28f
• AVA now prints an error when it receives non-existent test files on the command line. f01d05f
• When using the TAP reporter, remaining tests are now included in failed test count. Failed hooks are no longer treated as test failures, and logs are printed. 8628976
• Internal errors that may occur for some edge cases are now printed. b27cb8d
• TTY in the worker processes should follow the new APIs in Node.js 12.7.0 (when used with those Node.js versions). 7dcb473
• AVA now handles stage-4 syntax like dynamic import, and stage-3 syntax like BigInt, numeric separators and class properties that are supported by V8. 9baca8c
• AVA now supports dynamic import through our stage-4 preset.
• AVA now uses import-local@^3.0.2 which fixes issues with Lerna projects.
• For our TypeScript users, we've changed the default type of t.context to unknown, 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.