Skip to content

Commit b766668

Browse files
committed
Docs: prefer-output-null
1 parent ad10769 commit b766668

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Name | ✔️ | 🛠 | Description
5353
[no-identical-tests](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-identical-tests.md) | | 🛠 | Disallows identical tests
5454
[no-missing-placeholders](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-missing-placeholders.md) | ✔️ | | Disallows missing placeholders in rule report messages
5555
[no-useless-token-range](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-useless-token-range.md) | ✔️ | 🛠 | Disallows unnecessary calls to sourceCode.getFirstToken and sourceCode.getLastToken
56+
[prefer-output-null](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/prefer-output-null.md) | | | Disallows invalid RuleTester test cases with the output the same as the code.
5657
[prefer-placeholders](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/prefer-placeholders.md) | | | Disallows template literals as report messages
5758
[report-message-format](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/report-message-format.md) | | | Enforces a consistent format for report messages
5859
[require-meta-fixable](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-fixable.md) | ✔️ | | Requires a `meta.fixable` property for fixable rules

docs/rules/prefer-output-null.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Disallows invalid RuleTester test cases with the output the same as the code. (prefer-output-null)
2+
3+
## Rule Details
4+
5+
This rule aims to enforce `output: null` for invalid test cases to indicate that no output is produced.
6+
7+
Examples of **incorrect** code for this rule:
8+
9+
```js
10+
/* eslint eslint-plugin/prefer-output-null: error */
11+
12+
new RuleTester().run('foo', bar, {
13+
valid: [],
14+
invalid: [
15+
{ code: 'foo', errors: [{message: 'bar'}]},
16+
]
17+
});
18+
```
19+
20+
Examples of **correct** code for this rule:
21+
22+
```js
23+
/* eslint eslint-plugin/prefer-output-null: error */
24+
25+
new RuleTester().run('foo', bar, {
26+
valid: [],
27+
invalid: [
28+
{ code: 'foo', output: null, errors: [{message: 'bar'}]},
29+
]
30+
});
31+
```

0 commit comments

Comments
 (0)