Skip to content

Commit 0f0c6f0

Browse files
bmishbmish
authored
Automate docs with eslint-doc-generator (#348)
1 parent bd8c4c6 commit 0f0c6f0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+241
-147
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
node_modules
22
coverage
3+
yarn.lock

‎docs/new-rule.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Use the [`astexplorer` site](https://astexplorer.net) with the `espree` parser a
1818
- Add the correct [`meta.type`](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics) to the rule.
1919
- Go to the `docs/rules` directory and duplicate the `no-todo-test.md` file and rename it to the name of your rule. Then write some documentation.
2020
- Add the rule in alphabetically sorted order to:
21-
- [The recommended config](https://github.com/avajs/eslint-plugin-ava/blob/0ded4b5c3cd09504e846309760566c9499a24196/index.js#L19)
22-
- [The recommended config in the readme](https://github.com/avajs/eslint-plugin-ava/blame/0ded4b5c3cd09504e846309760566c9499a24196/readme.md#L35)
23-
- [The rule listing in the readme](https://github.com/avajs/eslint-plugin-ava/blame/0ded4b5c3cd09504e846309760566c9499a24196/readme.md#L73)\
21+
- [The recommended config](https://github.com/avajs/eslint-plugin-ava/blob/0ded4b5c3cd09504e846309760566c9499a24196/index.js#L19)
22+
- [The recommended config in the readme](https://github.com/avajs/eslint-plugin-ava/blame/0ded4b5c3cd09504e846309760566c9499a24196/readme.md#L35)
2423
*(The description should be the same as the heading of the documentation file).*
2524
- Run `$ npm test` to ensure the tests pass.
2625
- Run `$ npm run integration` to run the rules against real projects to ensure your rule does not fail on real-world code.
26+
- Run `$ npm run update:eslint-docs` to update the readme rules list and standardized rule doc title/notices.
2727
- Open a pull request with a title in exactly the format `` Add `rule-name` rule ``, for example, `` Add `no-unused-properties` rule ``.
2828
- The pull request description should include the issue it fixes, for example, `Fixes #123`.

‎docs/rules/assertion-arguments.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Enforce passing correct arguments to assertions
1+
# Enforce passing correct arguments to assertions (`ava/assertion-arguments`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
6+
7+
<!-- end auto-generated rule header -->
28

39
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/assertion-arguments.md)
410

‎docs/rules/hooks-order.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Enforce test hook ordering
1+
# Enforce test hook ordering (`ava/hooks-order`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
6+
7+
<!-- end auto-generated rule header -->
28

39
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/hooks-order.md)
410

‎docs/rules/max-asserts.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Limit the number of assertions in a test
1+
# Enforce a limit on the number of assertions in a test (`ava/max-asserts`)
2+
3+
✅ This rule is _disabled_ in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/max-asserts.md)
48

‎docs/rules/no-async-fn-without-await.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure that async tests use `await`
1+
# Ensure that async tests use `await` (`ava/no-async-fn-without-await`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-async-fn-without-await.md)
48

‎docs/rules/no-duplicate-modifiers.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure tests do not have duplicate modifiers
1+
# Ensure tests do not have duplicate modifiers (`ava/no-duplicate-modifiers`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-duplicate-modifiers.md)
48

‎docs/rules/no-identical-title.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure no tests have the same title
1+
# Ensure no tests have the same title (`ava/no-identical-title`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-identical-title.md)
48

‎docs/rules/no-ignored-test-files.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure no tests are written in ignored files
1+
# Ensure no tests are written in ignored files (`ava/no-ignored-test-files`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-ignored-test-files.md)
48

‎docs/rules/no-import-test-files.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure no test files are imported anywhere
1+
# Ensure no test files are imported anywhere (`ava/no-import-test-files`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-import-test-files.md)
48

‎docs/rules/no-incorrect-deep-equal.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
# Avoid using `deepEqual` with primitives
1+
# Disallow using `deepEqual` with primitives (`ava/no-incorrect-deep-equal`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
6+
7+
<!-- end auto-generated rule header -->
28

39
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-incorrect-deep-equal.md)
410

511
The `deepEqual` and `notDeepEqual` assertions are unnecessary when comparing primitives. Use `is` or `not` instead.
612

7-
This rule is fixable.
8-
913
## Fail
1014

1115
```js

‎docs/rules/no-inline-assertions.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Ensure assertions are not called from inline arrow functions
1+
# Ensure assertions are not called from inline arrow functions (`ava/no-inline-assertions`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
6+
7+
<!-- end auto-generated rule header -->
28

39
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-inline-assertions.md)
410

‎docs/rules/no-nested-tests.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure no tests are nested
1+
# Ensure no tests are nested (`ava/no-nested-tests`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-nested-tests.md)
48

‎docs/rules/no-only-test.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Ensure no `test.only()` are present
1+
# Ensure no `test.only()` are present (`ava/no-only-test`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
6+
7+
<!-- end auto-generated rule header -->
28

39
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-only-test.md)
410

‎docs/rules/no-skip-assert.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure no assertions are skipped
1+
# Ensure no assertions are skipped (`ava/no-skip-assert`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-skip-assert.md)
48

‎docs/rules/no-skip-test.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Ensure no tests are skipped
1+
# Ensure no tests are skipped (`ava/no-skip-test`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
6+
7+
<!-- end auto-generated rule header -->
28

39
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-skip-test.md)
410

‎docs/rules/no-todo-implementation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure `test.todo()` is not given an implementation function
1+
# Ensure `test.todo()` is not given an implementation function (`ava/no-todo-implementation`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-todo-implementation.md)
48

‎docs/rules/no-todo-test.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure no `test.todo()` is used
1+
# Ensure no `test.todo()` is used (`ava/no-todo-test`)
2+
3+
✅ This rule will _warn_ in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-todo-test.md)
48

‎docs/rules/no-unknown-modifiers.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Prevent the use of unknown test modifiers
1+
# Disallow the use of unknown test modifiers (`ava/no-unknown-modifiers`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-unknown-modifiers.md)
48

‎docs/rules/prefer-async-await.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Prefer using async/await instead of returning a Promise
1+
# Prefer using async/await instead of returning a Promise (`ava/prefer-async-await`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/prefer-async-await.md)
48

‎docs/rules/prefer-power-assert.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Allow only use of the asserts that have no power-assert alternative.
1+
# Enforce the use of the asserts that have no [power-assert](https://github.com/power-assert-js/power-assert) alternative (`ava/prefer-power-assert`)
2+
3+
✅ This rule is _disabled_ in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/prefer-power-assert.md)
48

‎docs/rules/prefer-t-regex.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Prefer using `t.regex()` to test regular expressions
1+
# Prefer using `t.regex()` to test regular expressions (`ava/prefer-t-regex`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
6+
7+
<!-- end auto-generated rule header -->
28

39
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/prefer-t-regex.md)
410

‎docs/rules/test-title-format.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure test titles have a certain format
1+
# Ensure test titles have a certain format (`ava/test-title-format`)
2+
3+
✅ This rule is _disabled_ in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/test-title-format.md)
48

‎docs/rules/test-title.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure tests have a title
1+
# Ensure tests have a title (`ava/test-title`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/test-title.md)
48

‎docs/rules/use-t-throws-async-well.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Ensure that `t.throwsAsync()` and `t.notThrowsAsync()` are awaited
1+
# Ensure that `t.throwsAsync()` and `t.notThrowsAsync()` are awaited (`ava/use-t-throws-async-well`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
6+
7+
<!-- end auto-generated rule header -->
28

39
When you use the `t.throwsAsync()` and `t.notThrowsAsync()` assertions, you must await the promise they return. If the test function completes before the assertions do, the test will fail.
410

‎docs/rules/use-t-well.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Prevent the incorrect use of `t`
1+
# Disallow the incorrect use of `t` (`ava/use-t-well`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
6+
7+
<!-- end auto-generated rule header -->
28

39
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/use-t-well.md)
410

‎docs/rules/use-t.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure test functions use `t` as their parameter
1+
# Ensure test functions use `t` as their parameter (`ava/use-t`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/use-t.md)
48

‎docs/rules/use-test.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure that AVA is imported with `test` as the variable name
1+
# Ensure that AVA is imported with `test` as the variable name (`ava/use-test`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/use-test.md)
48

‎docs/rules/use-true-false.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Ensure that `t.true()`/`t.false()` are used instead of `t.truthy()`/`t.falsy()`
1+
# Ensure that `t.true()`/`t.false()` are used instead of `t.truthy()`/`t.falsy()` (`ava/use-true-false`)
2+
3+
✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
4+
5+
<!-- end auto-generated rule header -->
26

37
Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/use-true-false.md)
48

‎package.json

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,13 @@
88
"node": ">=14.17 <15 || >=16.4"
99
},
1010
"scripts": {
11-
"test": "xo && c8 ava",
12-
"integration": "node ./test/integration/test.js"
11+
"integration": "node ./test/integration/test.js",
12+
"lint": "npm-run-all \"lint:*\"",
13+
"lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
14+
"lint:js": "xo",
15+
"test": "npm-run-all lint test:unit",
16+
"test:unit": "c8 ava",
17+
"update:eslint-docs": "eslint-doc-generator --rule-doc-section-include Pass --rule-doc-section-include Fail --url-configs \"https://github.com/avajs/eslint-plugin-ava#recommended-config\""
1318
},
1419
"files": [
1520
"index.js",
@@ -47,9 +52,11 @@
4752
"del": "^6.0.0",
4853
"eslint": "^8.26.0",
4954
"eslint-ava-rule-tester": "^4.0.0",
55+
"eslint-doc-generator": "^0.16.0",
5056
"eslint-plugin-eslint-plugin": "^5.0.6",
5157
"execa": "^5.1.1",
5258
"listr": "^0.14.3",
59+
"npm-run-all": "^4.1.5",
5360
"outdent": "^0.8.0",
5461
"pify": "^5.0.0",
5562
"tempy": "^1.0.1",
@@ -86,7 +93,12 @@
8693
"strict": "error",
8794
"ava/no-ignored-test-files": "off",
8895
"eslint-plugin/prefer-message-ids": "off",
89-
"eslint-plugin/require-meta-docs-description": "off",
96+
"eslint-plugin/require-meta-docs-description": [
97+
"error",
98+
{
99+
"pattern": "^(Enforce|Ensure|Require|Disallow|Prevent|Prefer)"
100+
}
101+
],
90102
"eslint-plugin/require-meta-has-suggestions": "off",
91103
"eslint-plugin/prefer-placeholders": "off",
92104
"import/extensions": "off",

0 commit comments

Comments
 (0)