Open greenkeeper[bot] opened 5 years ago
devDependency
ava was updated from 0.25.0
to 1.1.0
.Update to this version instead π
AVA now exports a meta
object. Currently, you can retrieve the path of the test file being run:
import test from 'ava';
console.log('Test currently being run: ', test.meta.file);
import {meta} from 'ava';
console.log('Test currently being run: ', meta.file);
This is useful in helpers that need to know the test file. bccd297
t.log()
now works in hooks d187712
Error output for improper usage of t.throws()
once again links to the correct documentation dc552bc
We've added a section on webpack aliases to the Babel recipe c3bcbf2
We've updated the Vue recipe for Babel 7, and added a section on webpack aliases c3bcbf2
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.
The new version differs by 9 commits.
a28094a
1.1.0
7262a78
Bump dependencies
d187712
Fix t.log() in hooks
bccd297
Expose test file path within worker process
c3bcbf2
Improve Babel and Vue recipes
dc552bc
Update link to t.throws()
assertion in AVA output
f4b2d19
Fix links to French translation of docs (#2005)
2e72fe7
Fix npm install command in readme (#2001)
7b6e578
Use newer ES syntax where possible
See the full diff
devDependency
ava was updated from 0.25.0
to 1.2.0
.Update to this version instead π
You can now set a timeout for test themselves. The test will fail if this timeout is exceeded. The timeout is reset each time an assertion is made:
test('foo', t => {
t.timeout(100); // 100 milliseconds
// Write your assertions here
});
AVA also has a global timeout feature. The mini reporter now logs tests that were pending when those timeouts occur. Additionally, if you interrupt a test using ctrl+c we'll now also show the pending tests. 2b60556
Thank you @dflupu for your hard work on this!
workspaceFolder
variable 0a5fe42 and --serial
argument placement edfc005We 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.
The new version differs by 11 commits.
010914b
1.2.0
ad087f2
Fix stack traces in throw assertions
8ad5efd
Bump dependencies
2b60556
Print pending tests on interrupt, and on timeout in mini reporter
0a5fe42
Change deprecated workspaceRoot variable to the equivalent workspaceFolder
b65c6d7
Add t.timeout()
ed7807e
Linter fixes
f0a07cd
Rely on npm 6.6.0
6b10f2e
Bump XO and fix some lint issues
72e0762
Fix accidental truncation of multi-line error messages
edfc005
Fix profile.js example
See the full diff
devDependency
ava was updated from 0.25.0
to 1.2.1
.Update to this version instead π
This is a bug fix release. In very large projects, the options send to worker processes would exceed limits on process argument size. We're now sending the options via the inter-process communication channel. 3078892
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.
devDependency
ava was updated from 0.25.0
to 1.3.0
.Update to this version instead π
t.throws()
and t.throwsAsync()
. If you'd set a code
expectation to a number we never actually checked that the thrown error had such a code! Thanks to @qlonik for both spotting and fixing this. 82daa5eclearTimeout()
, you'd break AVA. That's now been fixed. 40f331cYou can now use require()
in ava.config.js
files to load non-ES modules. 334e15b
Thank you @itaisteinherz, @jdalton, @kagawagao, @KompKK, @SleeplessByte, @Chrisyee22 and @qlonik for helping us with this release. We couldn't have done this without you!
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.
The new version differs by 12 commits.
b0fadb4
1.3.0
9600966
Bump dependencies
82daa5e
Assert on expected error code, even when a number
1e3b072
Document timeout
configuration
d97f11d
Improve pronunciation examples
40f331c
Fix unbound reference to clearTimeout
334e15b
Support require() in config files
5751226
Added few tests for lib/chalk.js
7d10446
Fix link to Babel recipe
565822e
Update esm package detection
2fce19f
Remove the typings
field in package.json
d066f6f
Recognize snapshot files as source files
See the full diff
devDependency
ava was updated from 0.25.0
to 1.3.1
.Update to this version instead π
t.throws()
and t.throwsAsync()
. If you'd set a code
expectation to a number we never actually checked that the thrown error had such a code! Thanks to @qlonik for both spotting and fixing this. 82daa5eclearTimeout()
, you'd break AVA. That's now been fixed. 40f331cYou can now use require()
in ava.config.js
files to load non-ES modules. 334e15b
Thank you @itaisteinherz, @jdalton, @kagawagao, @KompKK, @SleeplessByte, @Chrisyee22 and @qlonik for helping us with this release. We couldn't have done this without you!
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.
devDependency
ava was updated from 0.25.0
to 1.4.0
.Update to this version instead π
power-assert
AVA comes with power-assert
built-in, giving you more descriptive assertion messages. However it's been confusing to understand which assertions come with power-assert
. To address this we've added the new t.assert()
assertion. It's now the only assertion that is power-assert
enabled. The assertion passes if called with a truthy value. Consider this example:
test('enhanced assertions', t => {
const a = /foo/;
const b = 'bar';
const c = 'baz';
t.assert(a.test(b) || b === c);
});
6: const c = 'baz'; 7: t.assert(a.test(b) || b === c); 8: });
Value is not truthy:
false
a.test(b) || b === c
=> falseb === c
=> falsec
=> 'baz'b
=> 'bar'a.test(b)
=> falseb
=> 'bar'
a
=> /foo/
Our ESLint plugin has been updated to support this new assertion. Many thanks to @eemed for implementing this! 9406470
Watch mode now prints the available commands. Thanks @KompKK! cd256ac
--match
, .skip()
or .only()
) are no longer included in the list of pending tests when timeouts occur or when you interrupt a test run. Thanks @vancouverwill! 23e302aThank you @eemed, @KompKK, @vancouverwill, @okyantoro and @amokmen. We couldn't have done this without you!
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.
The new version differs by 7 commits.
20db474
1.4.0
0154a7f
Bump dependencies
9406470
Only apply power-assert to new t.assert() assertion
c1f6fdf
Shim all tty methods
23e302a
Don't report filtered tests as pending
99a10a1
Document that there is no default timeout
cd256ac
Print commands in watch mode
See the full diff
devDependency
ava was updated from 0.25.0
to 1.4.1
.Update to this version instead π
power-assert
AVA comes with power-assert
built-in, giving you more descriptive assertion messages. However it's been confusing to understand which assertions come with power-assert
. To address this we've added the new t.assert()
assertion. It's now the only assertion that is power-assert
enabled. The assertion passes if called with a truthy value. Consider this example:
test('enhanced assertions', t => {
const a = /foo/;
const b = 'bar';
const c = 'baz';
t.assert(a.test(b) || b === c);
});
6: const c = 'baz'; 7: t.assert(a.test(b) || b === c); 8: });
Value is not truthy:
false
a.test(b) || b === c
=> falseb === c
=> falsec
=> 'baz'b
=> 'bar'a.test(b)
=> falseb
=> 'bar'
a
=> /foo/
Our ESLint plugin has been updated to support this new assertion. Many thanks to @eemed for implementing this! 9406470
Watch mode now prints the available commands. Thanks @KompKK! cd256ac
--match
, .skip()
or .only()
) are no longer included in the list of pending tests when timeouts occur or when you interrupt a test run. Thanks @vancouverwill! 23e302aThank you @eemed, @KompKK, @vancouverwill, @okyantoro and @amokmen. We couldn't have done this without you!
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.
devDependency
ava was updated from 0.25.0
to 2.0.0
.Update to this version instead π
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
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
and sources
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 a helpers
directory. Instead you can now specify glob paterns to find these helpers:
{
"ava": {
"helpers": [
"**/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 watches ava.config.js
files.
AVA now also selects files ending with .spec.js
when looking for tests, as well as looking in tests
directories. 08e99e5 b1e54b1
The CLI now only takes file paths, not glob patterns.
We'd like some help updating our ESLint plugin as well.
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
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
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.
Test implementations may return observables. We've updated our TypeScript definition to require these to have a Symbol.observable
function. c2d8218
AVA now uses the util.inspect.defaultOptions.depth
option when printing objects, so you can configure the depth. 98034fb
You can now specify environment variables in your config, using the environmentVariables
object. a53ea15
UntitledMacro
and UntitledCbMacro
types, for macro functions that will never have a .title
function. Though really this just helped simplify the type definition. Thanks @qlonik! ebf4807test.skip(macro)
ba5cd80Thank you @StoneCypher, @LukasHechenberger, @lo1tuma, @htor, @alexisfontaine and @grnch. We couldn't have done this without you!
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.
The new version differs by 36 commits.
e1572d9
2.0.0
2daf6a9
Bump dependencies
b1e54b1
By default, select test and helpers inside 'tests' directories
677578f
Replace individual lodash packages with the main package
a53ea15
Define environment variables to be injected in the test file processes
626e58c
2.0.0-rc.1
51433be
Implement helper for our ESLint plugin
c10e38c
Remove underline from Babel configuration validation errors
928ed14
Bump dependencies
98034fb
Make the object printing depth configurable (#2121)
f26634b
2.0.0-beta.2
80d72ff
Bump dependencies
5f4c96f
Further helper selection improvements
ba5cd80
Fix TypeScript definition allowing macro-without-title-using-tests to be skipped
13a89e1
Reduce size of logo in readme
There are 36 commits in total.
See the full diff
devDependency
ava was updated from 0.25.0
to 2.1.0
.devDependency
ava was updated from 0.25.0
to 2.2.0
.devDependency
ava was updated from 0.25.0
to 2.3.0
.devDependency
ava was updated from 0.25.0
to 2.4.0
.
The devDependency ava was updated from
0.25.0
to1.0.1
.This version is not covered by your current version range.
If you donβt accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.
Release Notes for 1.0
AVA 1.0π
Back in January we started work on the 1.0 release, taking the opportunity to upgrade to Babel 7 and follow its beta releases. It's been a year where we made massive improvements to AVA. It's also been a year with many exciting events in our personal lives. Be it honeymoons & weddings, work & friends, naturalizations and international relocations.
So, we're done. Or, rather, we're just beginning. Testing can be a drag. AVA helps you get it done. Its concise API, detailed error output, embrace of new language features and process isolation let you write tests more effectively. So you can ship more awesome code or do non-programming things.
Starting now we'll push out patches and new features more regularly. And, when the time comes, ship a 2.0 and a 3.0 and so forth. If you like what we're doing, why not try and contribute? We're a friendly bunch and we could use your help to make AVA even better.
We couldn't have gotten here without the nearly one hundred people who've contributed more, and the many more who suggested improvements, reported bugs and provided feedback. And, of course, everyone who's used AVA. Thank you for your enthusiasm and support.
Mark & Sindre
What's new & improved
Assertions
New
t.throws()
behavior &t.throwsAsync()
We've rewritten
t.throws()
so it behaves better, has better error output and lets you write better tests:You have a few ways of asserting that the exception is as designed. You can pass a second argument:
message
should be equal to it.message
should match it.The most exciting new feature though is that you can pass an expectation object. A combination of the following expectations is supported:
This makes tests like these much easier to write:
We've removed promise support from
t.throws()
andt.notThrows()
. Use the newt.throwsAsync()
andt.notThrowsAsync()
assertions instead. Support for observables has been removed completey.The original behavior was both hard to explain and hard to express in Flow and TypeScript. Now, if you have a function that throws a synchronous error, use
t.throws()
(ort.notThrows()
). If you have a promise that should reject, or an asynchronous function that should fail, useawait t.throwsAsync()
(orawait t.notThrowsAsync()
).Generally speaking, you should be able to replace every occurence of
await t.throws
withawait t.throwsAsync
, andawait t.notThrows
withawait t.notThrowsAsync
. A transform file for jscodeshift is available in this Gist. Run it like:$ npx jscodeshift -t https://gist.githubusercontent.com/novemberborn/c2cdc94020083a1cafe3f41e8276f983/raw/eaa64c55dfcda8006fc760054055372bb3109d1c/transform.js test.js
Change
test.js
to a glob pattern that matches your test files. See the jscodeshift CLI usage documentation for further details.Bound assertion methods
Assertion methods are now bound to the test, meaning you can provide them as direct arguments to other functions. A contrived example:
Whilst not strictly assertions,
t.plan()
andt.log()
are now also bound to the test.BigInt
As part of our Node.js 10 support you can now use
BigInt
values int.deepEqual()
andt.snapshot()
. Note that this is still a stage-3 proposal.Babel 7
AVA now uses Babel 7, with support for
babel.config.js
files. We'll automatically use your project's Babel configuration. Babel options must now be specified in atestOptions
object. This will allow us to add source related options in the future.Our
@ava/stage-4
preset is now accessible viaava/stage-4
. We've added transforms for the latest ES2018 features where available (and even an ES2019 one!). You can also disableava/stage-4
entirely:package.json
:Or, you can disable just ES module compilation:
package.json
:The
powerAssert
option and command line flags have been removed. You can now disable AVA's test enhancements by settingcompileEnhancements
tofalse
. You can also disable AVA's Babel pipeline entirely:package.json
:Serial hooks and context
Hooks declared using
test.serial
will now execute serially. Only one of those hooks will run at a time. Other hooks run concurrently. Hooks still run in their declaration order.Note that concurrent tests run concurrently. This means that
.beforeEach()
and.afterEach()
hooks for those tests may also run concurrently, even if you usetest.serial
to declare them.t.context
can now be used in.before
and.after
hooks.CLI
Pass flags to your test
AVA now forwards arguments, provided after an
--
argument terminator, to the worker processes. Arguments are available fromprocess.argv[2]
onwards.npx ava test.js -- hello world
There's a new recipe on how to use this.
Previously AVA populated
process.argv[2]
andprocess.argv[3]
with some undocumented internal values. These are no longer available.Resetting AVA's cache
The
--no-cache
CLI flag has been replaced by a--reset-cache
command. The latter resets AVA's regular cache location. You can still disable the cache through thecache
configuration option.npx ava --reset-cache
Configuration
Introducing
ava.config.js
You can now configure AVA through an
ava.config.js
file. It must be placed next to thepackage.json
, and you mustn't have any"ava"
options in thepackage.json
file. Export the configuration as a default:Or export a factory function:
Following our convention to use ES modules in test files, we're expecting ES modules to be used in the configuration file. If this is causing difficulties please let us know in #1820.
Configurable test & helper file extensions
You can now tell AVA to run test files with extensions other than
js
! For files that should be compiled using Babel you can specifybabel.extensions
:package.json
:Or define generic extensions, e.g. for use with TypeScript:
package.json
:Note that AVA still assumes test & helper files to be valid JavaScript. They're still precompiled to enable some AVA-specific enhancements. You can disable this behavior by specifying
"compileEnhancements": false
.Snapshots
Adding new snapshots no longer causes the Markdown files to become malformed. Snapshots are now consistent across operating systems. If you've previously generated snapshots on Windows, you should update them using this release.
We now support
BigInt
and<React.Fragment>
int.snapshot()
. We've also improved support for theSymbol.asyncIterator
well-known symbol. Unfortunately these changes are not backwards compatible. You'll need to update your snapshots when upgrading to this release.We've improved how AVA builds snapshot files to better support precompiled projects. Say, if you compile your TypeScript test files using
tsc
before running AVA on the build output. AVA will now use the source map to figure out the original filename and use that as the basis for the snapshot files. You'll have to manually remove snapshots generated by previous AVA versions.Type definitions
The TypeScript and Flow definitions have been rewritten and much improved. The TypeScript recipe has been updated to reflect the changes, and there's a new Flow recipe too.
TypeScript
AVA recognizes TypeScript build errors when using
ts-node/register
.TypeScript now type-checks additional arguments used by macros. You must type the arguments used:
Other improvements
require
configuration.--fail-fast
behavior has been improved. AVA now makes sure not to start new tests. Tests that are already running though will finish. Hooks will also be called. AVA now prints the number of skipped test files if an error occurs and--fail-fast
is enabled.ci-parallel-vars
package for a list of supported CI environments.assert
module in Node.js 10 no longer crashes.process.stderr
is now emulated in the worker processes.--verbose
.<React.Fragment>
can be used int.deepEqual
.title
functions of macros now receiveundefined
rather than an empty string if no title was given in the test declaration. This means you can use default parameters.Breaking changes since 0.25.0
Supported Node.js versions
We've published a statement with regards to which Node.js versions we intend to support. As of this release we're only supporting Node.js 6.12.3 or newer, 8.9.4 or newer, 10.0.0 or newer and 11.0.0 or newer. This does not include Node.js 7 and 9.
Tests must now have titles, and they must be unique
You can no longer do:
Instead all tests must have titles, and they must be unique within the test file:
This makes it easier to pinpoint test failures and makes snapshots better too.
Note that AVA no longer infers a test title from a function name:
Modifier chaining
AVA's various test modifiers (
.serial
,.skip
) must now be used in the correct order:.serial
must be used at the beginning, e.g.test.serial()
..only
and.skip
must be used at the end, e.g.test.skip()
. You cannot combine them..failing
must be used at the end, but can be followed by.only
and.skip
, e.g.test.cb.failing()
andtest.cb.failing.only()
..always
can only be used after.after
and.afterEach
, e.g.test.after.always()
..todo()
is only available ontest
andtest.serial
. No further modifiers can be applied.Declaring tests
You must declare all tests and hooks at once. This was always the intent but previously AVA didn't enforce it very well. Now, once you declare a test or hook, all other tests and hooks must be declared synchronously. However you can perform some asynchronous actions before declaring your tests and hooks.
test
exportWe're no longer exporting the
test()
method as a named export. Where before you could useimport {test} from 'ava'
, you should now writeimport test from 'ava'
.Set default title using parameters syntax
Macros can generate a test title. Previously, AVA would call the
title
function with an empty string if no title was given in the test declaration. Now, it'll passundefined
instead. This means you can use default parameters. Here's an example:This is a breaking change if you were concatenating the provided title, under the assumption that it was an empty string.
Assertions
t.throws()
&t.notThrows()
Thrown exceptions (or rejection reasons) must now be error objects.
t.throws()
andt.notThrows()
no longer support observables or promises. For the latter, useawait t.throwsAsync()
andawait t.notThrowsAsync()
instead.Generally speaking, you should be able to replace every occurence of
await t.throws
withawait t.throwsAsync
, andawait t.notThrows
withawait t.notThrowsAsync
. A transform file for jscodeshift is available in this Gist. Run it like:$ npx jscodeshift -t https://gist.githubusercontent.com/novemberborn/c2cdc94020083a1cafe3f41e8276f983/raw/eaa64c55dfcda8006fc760054055372bb3109d1c/transform.js test.js
Change
test.js
to a glob pattern that matches your test files. See the jscodeshift CLI usage documentation for further details.Skipping assertions
Assertions can be skipped by using
.skip
at the end of the assertion, e.g.t.deepEqual.skip()
. You can now safely skip snapshot tests, though not whilst updating snapshots.t.ifError()
We've removed the
t.ifError()
assertion. It worked the same ast.falsy()
, so if you were using it please switch tot.falsy()
instead.Configuration changes
The
source
option has been renamed tosources
. This is now consistent withfiles
. AVA will exit with an error if it encounters thesource
option.We've also removed unintentional support for
init
,watch
andupdateSnapshot
options.Babel
The
"default"
and"inherit"
configuration values have been removed. Babel options must now be specified in atestOptions
object. This will allow us to add source related options in the future.The
powerAssert
option and command line flags have been removed. You can now disable AVA's test enhancements by settingcompileEnhancements
tofalse
.The Babel recipe has been updated with the latest details.
Updated type definitions
The TypeScript and Flow definitions have been rewritten. The definitions export different interfaces so you may need to update your test code as well.
TypeScript now type-checks additional arguments used by macros. You must type the arguments used.
Internals
Some other internals have changed. You shouldn't have been relying on these, though if you did we're interested in hearing about it so we can better support your use case.
t._test
value has been removedOther potential breaking changes
@std/esm
, in favor of the plainesm
package.ava/stage-4
preset is applied after all other plugins and presets.null
as thethis
value.stdout
. Thestdout
andstderr
output from workers is written toprocess.stderr
. AVA will insert linebreaks inprocess.stdout
after writing a chunk toprocess.stderr
that does not end in a line break.--no-cache
CLI flag has been replaced by a--reset-cache
command. The latter resets AVA's regular cache location. You can still disable the cache through thecache
configuration option.async
/await
support.New recipes
There's a new recipe on using ES modules. We've also added a recipe on setting up tests and how test webapps using AVA and Puppeteer.
All changesπ
v0.25.0...v1.0.1
Thanksπ
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.
Commits
The new version differs by 218 commits.
783944f
1.0.1
024bab7
1.0.0
aac41dc
Reword introduction
84d8fff
Bump dependencies & update documentation
c1364a1
Update the tagline and readme intro (#1983)
eed2e7a
Clarify that not all configuration options can be overridden by CLI flags
93e91c9
Fix 'sources' option in configuration docs
3bc80b0
Remove moot ESLint disable comment
311c197
Fix snapshot skip interface
0e82b04
1.0.0-rc.2
f97e277
Bump dependencies
6f54db8
Type additional arguments used by macros
a82fee5
Documentation updates
afe028a
CI updates
1ba31d8
Reorganize documentation
There are 218 commits in total.
See the full diff
FAQ and help
There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those donβt help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new).Your Greenkeeper bot :palm_tree: