ava
v6.4.1TypeScript
Node.js test runner that lets you develop with confidence.
0/weekUpdated 7 months agoMITUnpacked: 289.4 KB
Published by sindresorhus
npm install avaPlease support our friend Vadim Demedes and the people in Ukraine.
---
AVA is a test runner for Node.js with a concise API, detailed error output, embrace of new language features and thread isolation that lets you develop with confidence 🚀
Watch this repository and follow the Discussions for updates.
Read our contributing guide if you're looking to contribute (issues / PRs / etc).
Translations: Español, Français, Italiano, 日本語, 한국어, Português, Русский, 简体中文
Why AVA?
- Minimal and fast
- Simple test syntax
- Runs tests concurrently
- Enforces writing atomic tests
- No implicit globals
- Includes TypeScript definitions
- Magic assert
- Isolated environment for each test file
- Promise support
- Async function support
- Observable support
- Enhanced assertion messages
- Automatic parallel test runs in CI
- TAP reporter
Usage
To install and set up AVA, run:
``console`
npm init ava
Your package.json will then look like this (exact version notwithstanding):
`json`
{
"name": "awesome-package",
"type": "module",
"scripts": {
"test": "ava"
},
"devDependencies": {
"ava": "^5.0.0"
}
}
Or if you prefer using Yarn:
`console`
yarn add ava --dev
Alternatively you can install ava manually:
`console`
npm install --save-dev ava
Make sure to install AVA locally. AVA cannot be run globally.
Don't forget to configure the test script in your package.json as per above.
$3
Create a file named test.js in the project root directory.
_Note that AVA's documentation assumes you're using ES modules._
`js
import test from 'ava';
test('foo', t => {
t.pass();
});
test('bar', async t => {
const bar = Promise.resolve('bar');
t.is(await bar, 'bar');
});
`
$3
`console`
npm test
Or with npx:
`console`
npx ava
Run with the --watch flag to enable AVA's watch mode:
`console`
npx ava --watch
Supported Node.js versions
AVA supports the latest release of any major version that is supported by Node.js itself. Read more in our support statement.
Highlights
$3
AVA adds code excerpts and clean diffs for actual and expected values. If values in the assertion are objects or arrays, only a diff is displayed, to remove the noise and focus on the problem. The diff is syntax-highlighted too! If you are comparing strings, both single and multi line, AVA displays a different kind of output, highlighting the added or missing characters.
$3
AVA automatically removes unrelated lines in stack traces, allowing you to find the source of an error much faster, as seen above.
$3
AVA automatically detects whether your CI environment supports parallel builds. Each build will run a subset of all test files, while still making sure all tests get executed. See the ci-parallel-vars package for a list of supported CI environments.
Documentation
Please see the files in the docs directory:
* Writing tests
* Execution context
* Assertions
* Snapshot testing
* Command line (CLI)
* Configuration
* Test timeouts
$3
We have a growing list of common pitfalls you may experience while using AVA. If you encounter any issues you think are common, comment in this issue.
$3
- Test setup
- TypeScript
- Shared workers
- Watch mode
- When to use t.plan()
- Passing arguments to your test files
- Splitting tests in CI
- Code coverage
- Endpoint testing
- Browser testing
- Testing Vue.js components
- Debugging tests with Chrome DevTools
- Debugging tests with VSCode
- Debugging tests with WebStorm
- Isolated MongoDB integration tests
- Testing web apps using Puppeteer
- Testing web apps using Selenium WebDriverJS
FAQ
$3
AVA, not Ava or ava. Pronounced /ˈeɪvə/`: Ay (face, made) V (vie, have) A (comma, ago)
$3
It's the Andromeda galaxy.
$3
Concurrency is not parallelism. It enables parallelism.
Support
Related
- eslint-plugin-ava — Lint rules for AVA tests
- @ava/typescript — Test TypeScript projects
- @ava/cooperate — Low-level primitives to enable cooperation between test files
- @ava/get-port — Reserve a port while testing
Links
- AVA stickers, t-shirts, etc
- Awesome list
- Do you like AVA? Donate here!
- More…
Team
 | 
---|---
Mark Wubben | Sindre Sorhus
###### Former
- Kevin Mårtensson
- James Talmage
- Juan Soto
- Jeroen Engels
- Vadim Demedes
