3.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 v3.9.0...v3.10.1 for all changes.

3.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 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 v3.8.2...v3.9.0 for all changes. Thank you @paulrobertlloyd and @Autre31415 for contributing documentation improvements.

3.8.2

• Fix bad dependency fd92b4a
• Use configured depth limit for diffs in assertion failures, thanks @bunysae! a5385a4

v3.8.1...v3.8.2

3.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 #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() 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
   	}
   });

• 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 v3.7.1...v3.8.1 for all changes.

3.7.1

• Support parallel runs that do not need to run test files, courtesy of @micaelmbagira 26c8326

v3.7.0...v3.7.1

3.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 v3.6.0...v3.7.0 for all changes.

3.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 v3.5.0...v3.6.0 for all changes.

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.