Skip to content

Commit 9b5284e

Browse files
bmishaladdin-add
andauthored
docs: Clarify rationale for consistent-output rule (#222)
* Docs: Clarify rationale for `consistent-output` rule * Update docs/rules/consistent-output.md Co-authored-by: 唯然 <[email protected]> Co-authored-by: 唯然 <[email protected]>
1 parent 5ba20da commit 9b5284e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/rules/consistent-output.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
✔️ The `"extends": "plugin:eslint-plugin/recommended"` property in a configuration file enables this rule.
44

5-
When writing tests for a fixable rule with `RuleTester`, you can assert the autofix output of your test cases. However, it can be easy to forget to assert the output of a particular test case.
5+
When writing tests for fixable rules, it's a best practice to use the `output` property on each test case to assert what autofixed code is produced, or to assert that no autofix is produced using `output: null`.
66

7-
[As of ESLint 7](https://eslint.org/docs/user-guide/migrating-to-7.0.0#additional-validation-added-to-the-ruletester-class), test cases that trigger an autofix are required to provide the `output` property.
7+
Prior to ESLint 7, it was easy to forget to assert the autofix output of a particular test case, resulting in incomplete test coverage and a greater chance of unexpected behavior / bugs.
88

9-
Even test that do not trigger an autofix can benefit from asserting that they have no autofix using `output: null`.
9+
[As of ESLint 7](https://eslint.org/docs/user-guide/migrating-to-7.0.0#additional-validation-added-to-the-ruletester-class), test cases that trigger an autofix are required to provide the `output` property.
1010

1111
## Rule Details
1212

0 commit comments

Comments
 (0)