-
-
Notifications
You must be signed in to change notification settings - Fork 163
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update ava to the latest version 🚀 #69
base: master
Are you sure you want to change the base?
Conversation
Update to this version instead 🚀 Release Notes for 1.1.01.1.0New featuresAVA now exports a import test from 'ava'; import {meta} from 'ava'; This is useful in helpers that need to know the test file. bccd297 Bug fixes and other improvements
All changes 📚Thanks 💌💖 Huge thanks to @fitztrev, @forresst, @astrob0t, @pearofducks, @coreyfarrell and @dflupu for helping us with this release. We couldn’t have done it 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. CommitsThe new version differs by 9 commits.
See the full diff |
Update to this version instead 🚀 Release Notes for 1.2.0New featuresYou 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! Bug fixes and other improvements
All changes 📚Thanks 💌💖 Huge thanks to @anishkny, @CrispusDH, @dflupu and @niktekusho for helping us with this release. We couldn’t have done it 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. CommitsThe new version differs by 11 commits.
See the full diff |
Update to this version instead 🚀 Release Notes for 1.2.1This 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 All changes 📚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. |
Update to this version instead 🚀 Release Notes for 1.3.0Bug fixes
New featuresYou can now use All changesThanksThank you @itaisteinherz, @jdalton, @kagawagao, @KompKK, @SleeplessByte, @Chrisyee22 and @qlonik for helping us with this release. We couldn't have done this without you! Get involvedWe 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. CommitsThe new version differs by 12 commits.
See the full diff |
Update to this version instead 🚀 Release Notes for 1.3.1Bug fixes
New featuresYou can now use All changesThanksThank you @itaisteinherz, @jdalton, @kagawagao, @KompKK, @SleeplessByte, @Chrisyee22 and @qlonik for helping us with this release. We couldn't have done this without you! Get involvedWe 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. |
Update to this version instead 🚀 Release Notes for 1.4.0Focusing
|
Update to this version instead 🚀 Release Notes for 1.4.1Focusing
|
Update to this version instead 🚀 Release Notes for 2.0.0Breaking changesAVA now requires at least Node.js 8.9.4Per 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 selectionWe've been working on simplifying how test files and helpers are selected. First off, the The AVA used to treat all files inside a { "ava": { "helpers": [ "**/helpers/**/*" ] } } Test files starting with an underscore are still recognized as helpers. Files inside AVA now also selects files ending with The CLI now only takes file paths, not glob patterns. We'd like some help updating our ESLint plugin as well. Snapshots in CIWhen you run tests locally and add a new snapshot, AVA automatically updates the With this release, AVA will fail the Assertion messages must be stringsAVA 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 definitionsWe'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 typingTest implementations may return observables. We've updated our TypeScript definition to require these to have a New featuresConfigurable printing depthAVA now uses the Specify environment variables in your AVA configYou can now specify environment variables in your config, using the Other changes
All changesThanksThank you @StoneCypher, @LukasHechenberger, @lo1tuma, @htor, @alexisfontaine and @grnch. We couldn't have done this without you! Get involvedWe 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. CommitsThe new version differs by 36 commits.
There are 36 commits in total. See the full diff |
|
|
|
|
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 💌
💖 Huge thanks to @okyantoro, @JasonRitchie, @forresst, @mdvorscak, @kugtong33, @motss, @BusbyActual, @billyjanitsch, @Briantmorr, @jdalton, @malimichael, @martypdx, @clemtrek, @samuelli, @emilyschultz, @hallettj, @isnifer, @Jaden-Giordano, @good-idea, @jamiebuilds, @tobil, @TheDancingCode, @btkostner, @CanRau, @coreyfarrell, @ivanschwarz, @jagoda, @padmaia, @ronen, @sh7dm, @sharkykh, @Phrynobatrachus, @grant37, @xxczaki, @robertbernardbrown, @lo1tuma, @goooseman, @wmik, @vancouverwill, @qlonik, @vlajos and @itskolli for helping us with this release. We couldn’t have done it 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.
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. If those don’t help, you can always ask the humans behind Greenkeeper.
Your Greenkeeper bot 🌴