Repository files navigation

Please 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 theDiscussions for updates.

Read ourcontributing guide if you're looking to contribute (issues / PRs / etc).

Translations:Español,Français,Italiano,日本語,한국어,Português,Русский,简体中文

• 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

To install and set up AVA, run:

npm init ava

Yourpackage.json will then look like this (exact version notwithstanding):

{"name":"awesome-package","type":"module","scripts": {"test":"ava"},"devDependencies": {"ava":"^5.0.0"}}

Or if you prefer using Yarn:

yarn add ava --dev

Alternatively you can installava manually:

npm install --save-dev ava

Make sure to install AVA locally. AVA cannot be run globally.

Don't forget to configure thetest script in yourpackage.json as per above.

Create a file namedtest.js in the project root directory.

Note that AVA's documentation assumes you're using ES modules.

importtestfrom'ava';test('foo',t=>{t.pass();});test('bar',asynct=>{constbar=Promise.resolve('bar');t.is(awaitbar,'bar');});

npm test

Or withnpx:

npx ava

Run with the--watch flag to enable AVA'swatch mode:

npx ava --watch

AVA supports the latest release of any major version thatis supported by Node.js itself. Read more in oursupport statement.

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.

AVA automatically removes unrelated lines in stack traces, allowing you to find the source of an error much faster, as seen above.

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 theci-parallel-vars package for a list of supported CI environments.

Please see thefiles in thedocs directory:

• Writing tests
• Execution context
• Assertions
• Snapshot testing
• Command line (CLI)
• Configuration
• Test timeouts

We have a growing list ofcommon pitfalls you may experience while using AVA. If you encounter any issues you think are common, comment inthis issue.

• Test setup
• TypeScript
• Shared workers
• Watch mode
• When to uset.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

AVA, not Ava or ava. Pronounced/ˈeɪvə/: Ay (face, made) V (vie, have) A (comma,ago)

It's theAndromeda galaxy.

Concurrency is not parallelism. It enables parallelism.

• GitHub Discussions

• 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

• AVA stickers, t-shirts, etc
• Awesome list
• Do you like AVA? Donate here!
• More…

Mark Wubben	Sindre Sorhus

• Kevin Mårtensson
• James Talmage
• Juan Soto
• Jeroen Engels
• Vadim Demedes