This repository has been archived by the owner on Apr 20, 2022. It is now read-only.
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.
Version 0.20.0 of ava just got published.
The version 0.20.0 is not covered by your current version range.
Without accepting this pull request your project will work just like it did before. There might be a bunch of new features, fixes and perf improvements that the maintainers worked on for you though.
I recommend you look into these changes and try to get onto the latest version of ava.
Given that you have a decent test suite, a passing build is a strong indicator that you can take advantage of these changes by merging the proposed change into your project. Otherwise this branch is a great starting point for you to work on the update.
Release Notes
0.20.0Today’s release is very exciting. After adding magic assert and snapshot testing we found that these features sometimes disagreed with each other.
t.deepEqual()
would returnfalse
, yet AVA wouldn’t show a diff. Snapshot tests cared aboutSet
order butt.deepEqual()
didn’t. @novemberborn came to the realization that comparing and diffing object trees, and doing so over time with snapshots, are variations on the same problem. Thus he started ConcordanceJS, a new project that lets you compare, format, diff and serialize any JavaScript value. This AVA release reaps the fruits of his labor.Highlights
More magical asserts
Magic assert will now always show the difference between actual and expected values. If an unexpected error occurs it’ll print all (enumerable) properties of the error which can make it easier to debug your program.
More details of an object are printed, like the constructor name and the string tag. Buffers are hex-encoded with line breaks so they’re easy to read:
t.deepEqual()
improvementst.deepEqual()
andt.notDeepEqual()
now useconcordance
, rather thanlodash.isequal
. This changes what values AVA considers to be equal, making thet.deepEqual()
assertion more predictable. You can now trust that all aspects of your objects are compared.Object wrappers are no longer equal. The following assertion will now fail:
For
Map
andSet
objects to be equal, their elements must now be in the same order:With this release AVA will compare all enumerable properties of an object. For an array this means that the comparison considers not just the array elements. The following are no longer considered equal:
The same goes for
Map
andSet
objects, errors, and so forth:You used to be able to compare
Arguments
object to an object literal:Instead you must now use:
(Of course you can still compare
Arguments
objects to each other.)New in this release is the ability to compare React elements:
Snapshot improvements
Snapshots too now use
concordance
. This means values are compared with the snapshot according to the same rules ast.deepEqual()
, albeit with some minor differences:Argument
objects can only be compared toArgument
objectsNote that Node.js versions before 6.5 cannot infer names of all functions . AVA will pass a snapshot assertion if it determines the name information is unreliable.
AVA now saves two files when snapshotting. One, ending in the
.snap
extension, contains a compressed serialization of the expected value. The other is a readable Markdown file that contains the snapshot report. You should commit both to source control. The report file can be used to see what is in your snapshots and to compare snapshot changes over time.Try it out with our snapshot example! Or check out an example snapshot report.
The snapshot file location now follows your test layout. If you use a
test
folder, they’ll be placed intest/snapshots
. With__tests__
they’ll be placed in__tests__/__snapshots__
. And if you just have atest.js
in your project root the snapshot files will be written totest.js.snap
andtest.js.md
. You may have to manually remove old snapshot files after installing this new AVA version. ebd572aImproved snapshot support in watch mode
In watch mode, AVA now watches for changes to snapshot files. This is handy when you revert changes while the watcher is running. Snapshot files are correctly tracked as test dependencies, so the right tests are rerun. Typing
u
, followed byEnter
updates the snapshots in the tests that just ran. (And the watcher won’t rerun tests when snapshots are updated.) 87eef84 dbc78dc f507e36 50b60a1Node.js 8 support
AVA 0.19 already worked great with Node.js 8, and we’ve made it even better by removing unnecessary Babel transpilations in our
stage-4
preset. We’re now also forwarding the--inspect-brk
flag for debugging purposes. e456951 a868b02New and improved recipes
We’ve added new recipes and improved others:
browser-env
c01ac05Miscellaneous
--concurrency
without a value now causes AVA to exit with an error 8c35a1at.throws()
with a resolved promise now prints a helpful error message dfca2d9t.title
accessor has been documented. 549e99bAll changes
v0.19.1...v0.20.0
Thanks
💖 Huge thanks to @lukechilds, @alexrussell, @zs-zs, @cncolder, @JPeer264, @CImrie, @blake-newman, @yatharthk, @bfred-it, @tdeschryver, @sudo-suhas, @dohomi, @efegurkan and @forresst 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 63 commits.
854203a
0.20.0
652705b
Add more screenshot fixtures
9d3b1ba
Deep update of XO and its dependencies
8d09ba5
Link to ava-snapshot-example
2360256
Redo all of the screenshots
589489d
Meta tweaks
f507e36
Add command for updating snapshots in watch mode (#1413)
87eef84
Automatically watch for snapshot changes
a141033
concordance@2
f62c137
Update readme
0e82f8f
Add integration test for appending to an existing snapshot file
ebd572a
Determine snapshot directory by where the test is located
dbc78dc
Treat loaded snapshot files as test dependencies
50b60a1
Track snapshot files touched during test run, ignore in watcher
6d3c279
Include dirty sources in watcher debug output
There are 63 commits in total.
See the full diff
Not sure how things should work exactly?
There is a collection of frequently asked questions and of course you may always ask my humans.
Your Greenkeeper Bot 🌴