Home

Awesome

eslint-plugin-ava Coverage Status

ESLint rules for AVA

Translations: Français

This plugin is bundled in XO. No need to do anything if you're using it.

Propose or contribute a new rule ➑

Install

npm install --save-dev eslint eslint-plugin-ava

Usage

Configure it in package.json.

{
	"name": "my-awesome-project",
	"eslintConfig": {
		"env": {
			"es6": true
		},
		"parserOptions": {
			"ecmaVersion": "latest",
			"sourceType": "module"
		},
		"plugins": [
			"ava"
		],
		"rules": {
			"ava/assertion-arguments": "error",
			"ava/...": "error"
        }
    }
}

Rules

The rules will only activate in test files.

<!-- begin auto-generated rules list -->

πŸ’Ό Configurations enabled in.
⚠️ Configurations set to warn in.
🚫 Configurations disabled in.
βœ… Set in the recommended configuration.
πŸ”§ Automatically fixable by the --fix CLI option.
πŸ’‘ Manually fixable by editor suggestions.

NameΒ Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β DescriptionπŸ’Όβš οΈπŸš«πŸ”§πŸ’‘
assertion-argumentsEnforce passing correct arguments to assertions.βœ…πŸ”§
hooks-orderEnforce test hook ordering.βœ…πŸ”§
max-assertsEnforce a limit on the number of assertions in a test.βœ…
no-async-fn-without-awaitEnsure that async tests use await.βœ…
no-duplicate-modifiersEnsure tests do not have duplicate modifiers.βœ…
no-identical-titleEnsure no tests have the same title.βœ…
no-ignored-test-filesEnsure no tests are written in ignored files.βœ…
no-import-test-filesEnsure no test files are imported anywhere.βœ…
no-incorrect-deep-equalDisallow using deepEqual with primitives.βœ…πŸ”§
no-inline-assertionsEnsure assertions are not called from inline arrow functions.βœ…πŸ”§
no-nested-testsEnsure no tests are nested.βœ…
no-only-testEnsure no test.only() are present.βœ…πŸ”§πŸ’‘
no-skip-assertEnsure no assertions are skipped.βœ…
no-skip-testEnsure no tests are skipped.βœ…πŸ”§πŸ’‘
no-todo-implementationEnsure test.todo() is not given an implementation function.βœ…
no-todo-testEnsure no test.todo() is used.βœ…
no-unknown-modifiersDisallow the use of unknown test modifiers.βœ…
prefer-async-awaitPrefer using async/await instead of returning a Promise.βœ…
prefer-power-assertEnforce the use of the asserts that have no power-assert alternative.βœ…
prefer-t-regexPrefer using t.regex() to test regular expressions.βœ…πŸ”§
test-titleEnsure tests have a title.βœ…
test-title-formatEnsure test titles have a certain format.βœ…
use-tEnsure test functions use t as their parameter.βœ…
use-t-throws-async-wellEnsure that t.throwsAsync() and t.notThrowsAsync() are awaited.βœ…πŸ”§
use-t-wellDisallow the incorrect use of t.βœ…πŸ”§
use-testEnsure that AVA is imported with test as the variable name.βœ…
use-true-falseEnsure that t.true()/t.false() are used instead of t.truthy()/t.falsy().βœ…
<!-- end auto-generated rules list -->

Recommended config

This plugin exports a recommended config that enforces good practices.

Enable it in your package.json with the extends option:

{
	"name": "my-awesome-project",
	"eslintConfig": {
		"extends": "plugin:ava/recommended"
	}
}

See the ESLint docs for more information about extending config files.

Note: This config will also enable the correct parser options and environment.