search

static-dev / spike-tpl-base

:seedling: The base template for spike projects
Other
15 stars 12 forks source link

Update ava to the latest version 🚀 #63

Closed greenkeeper[bot] closed 7 years ago

greenkeeper[bot] commented 7 years ago

Version 0.19.0 of ava just got published.

Dependency ava
Current Version 0.18.2
Type devDependency

The version 0.19.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.19.0

Since our last minor release, @novemberborn has worked tirelessly on refactoring big parts of the codebase to be more correct and readable, while squashing many bugs. We've also added multiple detections that will prevent user mistakes.

Highlights

Working snapshots

We released snapshot support with v0.18.0, but unfortunately it didn’t work. That’s fixed now. Since we’re using jest-snapshot the output will look a little different from AVA’s other assertions. Most notably the output will not be colored.

57fd051

Tests fail if no assertions are run (BREAKING)

Sometimes you write a test that accidentally passes, because your assertion was never run. For example, the following test passes if getAnimals() returns an empty array:

test('unicorn', t => {
  for (const animal of getAnimals()) {
    t.is(animal, 'unicorn');
  }
});

AVA now fails your test if no assertions were run. This can be a problem if you use third-party assertion libraries, since AVA cannot detect when those assertions pass. You can disable this behavior by setting the failWithoutAssertions option to false in AVA's package.json configuration.

3a4553c

Improved t.throws() and t.notThrows() assertions (BREAKING)

Various improvements have been made to these assertions. Unfortunately this does include some breaking changes.

Calling these assertions with an observable or promise makes them asynchronous. You now need to await them:

const promise = Promise.reject(new TypeError('🦄'));

test('rejects', async t => {
  await t.throws(promise);
});

Previously, these would return a promise that was rejected if the assertion failed. This leaked AVA’s internal assertion error. Now they’ll fulfill their returned promise with undefined instead (d56db75). You typically won’t notice this in your test.

We’ve improved how we detect when t.throws() and t.notThrows() are used incorrectly (d924045). This might be when, rather than passing a function, you call it:

test('throws', t => {
  t.throws(throwingFunction());
});

You can now use await and yield in the argument expressions (e.g. t.throws(await createThrowingFunction()). The instructions on how to use these assertions correctly are now shown with the test failure, instead of being written to the console as your tests run.

Incorrectly using these assertions now always causes your test to fail.

Stack traces are now correct, even if used asynchronously (f6a42ba). The error messages have been improved for when t.throws() fails to encounter an error, or if t.notThrows() does (4463f38). If t.notThrows() fails, the encountered error is shown (22c93ed).

Improved magic assert output

Actual and/or expected values are now included in the magic assert output, with helpful labels that are relevant to the failing assertion.

4f87f32

Detect hanging tests

AVA can now detect when an asynchronous test is hanging (880e87e).

Note that this may not work if your code is listening on a socket or is using a timer or interval.

Better Babel option resolution

We’re now resolving Babel options ahead of time, using hullabaloo-config-manager. This fixes long-standing issues with relative paths in AVA’s "babel" options in package.json files (#707). It also means we’re better at recompiling test and helper files if your Babel config changes or you update plugins or presets.

0464b14

Miscellaneous

All changes

v0.18.2…v0.19.0

Thanks

💖 Huge thanks to @Wp1987, @lukechilds, @jakwuh, @danny-andrews, @mmkal, @yatharthk, @klauscfhq, @screendriver, @jhnns, @danez and @florianb 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 65 commits .

  • 8f80ed1 0.19.0
  • 054d39b Fix get-port usage
  • affbb45 Fail tests that finish with pending assertions
  • 2e48970 Remove unnecessary test to verify throws/notThrows return promises
  • d2a294d Reword error message for when assertions are used after test has finished
  • ecdadfa Improve Babel recipe (#1290)
  • 146c3e2 Set default color config based on supports-color
  • 2283247 Document --color CLI flag
  • b581983 Don't highlight formatted values with --no-color
  • 941c42e Bump hullabaloo-config-manager
  • 57fd051 Make snapshots usable again
  • 48b892a Refactor Runner
  • f23c17d Remove mention of stage-2 in readme (#1325)
  • d924045 Integrate with improved throws helper
  • 5e7ea9a Print error message before formatted assertion

There are 65 commits in total. See the full diff.

Not sure how things should work exactly? There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html) and of course you may always [ask my humans](https://github.com/greenkeeperio/greenkeeper/issues/new).

Your Greenkeeper Bot :palm_tree: