ESLint rules for AVA
npm install eslint-plugin-ava> 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 ➡
``sh`
npm install --save-dev eslint eslint-plugin-ava
Configure it in package.json.
`json`
{
"name": "my-awesome-project",
"eslintConfig": {
"env": {
"es6": true
},
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module"
},
"plugins": [
"ava"
],
"rules": {
"ava/assertion-arguments": "error",
"ava/...": "error"
}
}
}
The rules will only activate in test files.
💼 Configurations enabled in.\
⚠️ Configurations set to warn in.\
🚫 Configurations disabled in.\
✅ Set in the recommended configuration.\--fix
🔧 Automatically fixable by the CLI option.\
💡 Manually fixable by editor suggestions.
| Name | Description | 💼 | ⚠️ | 🚫 | 🔧 | 💡 |
| :------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------- | :- | :- | :- | :- | :- |
| assertion-arguments | Enforce passing correct arguments to assertions. | ✅ | | | 🔧 | |
| hooks-order | Enforce test hook ordering. | ✅ | | | 🔧 | |
| max-asserts | Enforce a limit on the number of assertions in a test. | | | ✅ | | |
| no-async-fn-without-await | Ensure that async tests use await. | ✅ | | | | |deepEqual
| no-duplicate-modifiers | Ensure tests do not have duplicate modifiers. | ✅ | | | | |
| no-identical-title | Ensure no tests have the same title. | ✅ | | | | |
| no-ignored-test-files | Ensure no tests are written in ignored files. | ✅ | | | | |
| no-import-test-files | Ensure no test files are imported anywhere. | ✅ | | | | |
| no-incorrect-deep-equal | Disallow using with primitives. | ✅ | | | 🔧 | |test.only()
| no-inline-assertions | Ensure assertions are not called from inline arrow functions. | ✅ | | | 🔧 | |
| no-nested-tests | Ensure no tests are nested. | ✅ | | | | |
| no-only-test | Ensure no are present. | ✅ | | | 🔧 | 💡 |test.todo()
| no-skip-assert | Ensure no assertions are skipped. | ✅ | | | | |
| no-skip-test | Ensure no tests are skipped. | ✅ | | | 🔧 | 💡 |
| no-todo-implementation | Ensure is not given an implementation function. | ✅ | | | | |test.todo()
| no-todo-test | Ensure no is used. | | ✅ | | | |t.regex()
| no-unknown-modifiers | Disallow the use of unknown test modifiers. | ✅ | | | | |
| prefer-async-await | Prefer using async/await instead of returning a Promise. | ✅ | | | | |
| prefer-power-assert | Enforce the use of the asserts that have no power-assert alternative. | | | ✅ | | |
| prefer-t-regex | Prefer using to test regular expressions. | ✅ | | | 🔧 | |t
| test-title | Ensure tests have a title. | ✅ | | | | |
| test-title-format | Ensure test titles have a certain format. | | | ✅ | | |
| use-t | Ensure test functions use as their parameter. | ✅ | | | | |t.throwsAsync()
| use-t-throws-async-well | Ensure that and t.notThrowsAsync() are awaited. | ✅ | | | 🔧 | |t
| use-t-well | Disallow the incorrect use of . | ✅ | | | 🔧 | |test
| use-test | Ensure that AVA is imported with as the variable name. | ✅ | | | | |t.true()
| use-true-false | Ensure that /t.false() are used instead of t.truthy()/t.falsy(). | ✅ | | | | |
This plugin exports a recommended config that enforces good practices.
Enable it in your package.json with the extends option:
`json``
{
"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.