readme.md

---

Note du traducteur

C'est la traduction du fichier readme.md. Voici un lien vers les différences avec le master de eslint-plugin-ava (Si en cliquant sur le lien, vous ne trouvez pas le fichier readme.md parmi les fichiers modifiés, vous pouvez donc en déduire que la traduction est à jour).

---

eslint-plugin-ava

Règles ESLint pour AVA

Traductions : English

Ce plugin est intégré dans XO. Pas besoin de faire quoi que ce soit si vous utilisez XO.

Proposez ou contribuez à une nouvelle règle ➡

L'installation

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

L'utilisation

Configurez le dans le package.json.

{
	"name": "my-awesome-project",
	"eslintConfig": {
		"env": {
			"es6": true
		},
		"parserOptions": {
			"ecmaVersion": "latest",
			"sourceType": "module"
		},
		"plugins": [
			"ava"
		],
		"rules": {
			"ava/assertion-arguments": "error",
			"ava/hooks-order": "error",
			"ava/max-asserts": [
				"off",
				5
			],
			"ava/no-async-fn-without-await": "error",
			"ava/no-duplicate-modifiers": "error",
			"ava/no-identical-title": "error",
			"ava/no-ignored-test-files": "error",
			"ava/no-import-test-files": "error",
			"ava/no-incorrect-deep-equal": "error",
			"ava/no-inline-assertions": "error",
			"ava/no-nested-tests": "error",
			"ava/no-only-test": "error",
			"ava/no-skip-assert": "error",
			"ava/no-skip-test": "error",
			"ava/no-todo-implementation": "error",
			"ava/no-todo-test": "warn",
			"ava/no-unknown-modifiers": "error",
			"ava/prefer-async-await": "error",
			"ava/prefer-power-assert": "off",
			"ava/prefer-t-regex": "error",
			"ava/test-title": "error",
			"ava/test-title-format": "off",
			"ava/use-t": "error",
			"ava/use-t-throws-async-well": "error",
			"ava/use-t-well": "error",
			"ava/use-test": "error",
			"ava/use-true-false": "error"
		}
	}
}

Les règles

Les règles s'activeront uniquement dans les fichiers de test.

• assertion-arguments - Imposer le passage d'arguments corrects aux assertions.
• hooks-order - Imposer l'ordre des hooks de test. (réparable)
• max-asserts - Limiter le nombre d'assertions dans un test.
• no-async-fn-without-await - S'assurer que les tests async utilisent await.
• no-duplicate-modifiers - S'assurer qu'aucun test n'a de modificateur en doublon.
• no-identical-title - S'assurer que chaque test a un titre différent.
• no-ignored-test-files - S'assurer qu'aucun test ne soit écrit dans des fichiers ignorés.
• no-import-test-files - S'assurer qu'aucun fichier de test n'est importé de n'importe où.
• no-incorrect-deep-equal - Éviter d'utiliser deepEqual avec des primitives. (réparable)
• no-inline-assertions - S'assurer que les assertions ne sont pas appelées depuis des fonctions fléchées sur une ligne. (réparable)
• no-nested-tests - S'assurer qu'aucun test soit imbriqué.
• no-only-test - S'assurer qu'aucun test.only() soit présent.
• no-skip-assert - S'assurer qu'aucune assertion soit passée (skip).
• no-skip-test - S'assurer qu'aucun test soit passé (skip).
• no-todo-implementation - S'assurer que test.todo() n'a pas une fonction d'implémentation.
• no-todo-test - S'assurer qu'aucun test.todo() soit utilisé.
• no-unknown-modifiers - Empêcher l'utilisation de modificateurs de test inconnus.
• prefer-async-await - Préférer l'utilisation de async/await au lieu de retourner une Promesse.
• prefer-power-assert - Autoriser uniquement l'utilisation des assertions qui n'ont pas d'alternatives dans power-assert.
• prefer-t-regex - Préférer l'utilisation de t.regex() au lieu de tests d'expressions régulières. (réparable)
• test-title - S'assurer que les tests ont un titre.
• test-title-format - S'assurer que les titres des tests ont un certain format.
• use-t - S'assurer que les fonctions de test utilisent t comme paramètre.
• use-t-throws-async-well - S'assurer que t.throwsAsync() et t.notThrowsAsync() sont attendus. (correction partielle)
• use-t-well - Empêcher une mauvaise utilisation de t. (correction partielle)
• use-test - S'assurer que AVA est importé avec la variable nommée test.
• use-true-false - S'assurer que t.true()/t.false() sont utilisés à la place de t.truthy()/t.falsy().

Config recommandée

Ce plugin exporte une config recommandée (recommended) qui applique les bonnes pratiques.

Activez la dans votre package.json avec l'option extends :

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

Consulter les docs ESLint pour plus d'informations sur l'extension des fichier de config.

Remarque : Cette config activera aussi correctement les options du parser et de l'environnement.