AVA Configuration

configuring AVA, the Node.js test runner

ava.config.json

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your ava.config.json and it validates in your browser — nothing is uploaded.

Validate a ava.config.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`files`	`array`	—
`ignoredByWatcher`	`array`	—
`match`	`array`	—
`cache`	`boolean`	Defaults to `true` to cache compiled files under `node_modules/.cache/ava.` If `false`, files are cached in a temporary directory instead default: `true`
`concurrency`	`number`	Max number of test files running at the same time (default: CPU cores)
`workerThreads`	`boolean`	Use worker threads to run tests (enabled by default). If `false`, tests will run in child processes default: `true`
`failFast`	`boolean`	Stop running further tests once a test fails default: `false`
`failWithoutAssertions`	`boolean`	If `false`, does not fail a test if it doesn't run assertions default: `true`
`environmentVariables`	`object`	Specifies environment variables to be made available to the tests. The environment variables defined here override the ones from `process.env`
`serial`	`boolean`	if `true`, prevents parallel execution of tests within a file default: `false`
`tap`	`boolean`	If `true`, enables the TAP reporter default: `false`
`verbose`	`boolean`	If `true`, enables verbose output (though currently non-verbose output is not supported) default: `false`
`snapshotDir`	`string`	—
`extensions`	`anyOf`	Extensions of test files. Setting this overrides the default `["cjs", "mjs", "js"]` value, so make sure to include those extensions in the list. Experimentally you can configure how files are loaded default: `["cjs", "mjs", "js"]`
`require`	`array`	—
`timeout`	`anyOf`	Timeouts in AVA behave differently than in other test frameworks. AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout. This can be used to handle stalled tests. See default: `"10s"`
`nodeArguments`	`array<string>`	—
`utilizeParallelBuilds`	`boolean`	If `false`, disable parallel builds (default: `true`) default: `true`
`typescript`	`object`	Configures @ava/typescript for projects that precompile TypeScript. Alternatively, you can use `ts-node` to do live testing without transpiling, in which case you shouldn't use the `typescript` property
`typescript.extensions`	`array`	—
`typescript.rewritePaths`	`object`	AVA searches your entire project for `.js`, `.cjs`, `.mjs` and `.ts` files (or other extensions you've configured). It will ignore such files found in the `rewritePaths` targets (e.g. `build/`). If you use more specific paths, for
`typescript.compile`	`enum`	If `false`, AVA will assume you have already compiled your project. If set to `'tsc'`, AVA will run the TypeScript compiler before running your tests. This can be inefficient when using AVA in watch mode default: `false` one of: `false, "tsc"`

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
Has 1 place(s) where keywords sit beside $ref. Under draft-07 those keywords are silently ignored by every conforming validator — first at #/properties/typescript/properties/extensions.
22 properties, 100% carrying a description, max nesting depth 7.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`anyOf`	JSON Schema Core, draft 2020-12	§10.2.1.2 — "anyOf"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`minLength`	JSON Schema Validation, draft 2020-12	§6.3.2 — "minLength"
`minimum`	JSON Schema Validation, draft 2020-12	§6.2.4 — "minimum"
`pattern`	JSON Schema Validation, draft 2020-12	§6.3.3 — "pattern"
`patternProperties`	JSON Schema Core, draft 2020-12	§10.3.2.2 — "patternProperties"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas