Automate docs with eslint-doc-generator (#348)

Author: bmish

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 coverage
+yarn.lock

docs/new-rule.md

@@ -18,11 +18,11 @@ Use the [`astexplorer` site](https://astexplorer.net) with the `espree` parser a
 - Add the correct [`meta.type`](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics) to the rule.
 - 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.
 - Add the rule in alphabetically sorted order to:
-	- [The recommended config](https://github.com/avajs/eslint-plugin-ava/blob/0ded4b5c3cd09504e846309760566c9499a24196/index.js#L19)
-	- [The recommended config in the readme](https://github.com/avajs/eslint-plugin-ava/blame/0ded4b5c3cd09504e846309760566c9499a24196/readme.md#L35)
-	- [The rule listing in the readme](https://github.com/avajs/eslint-plugin-ava/blame/0ded4b5c3cd09504e846309760566c9499a24196/readme.md#L73)\
+  - [The recommended config](https://github.com/avajs/eslint-plugin-ava/blob/0ded4b5c3cd09504e846309760566c9499a24196/index.js#L19)
+  - [The recommended config in the readme](https://github.com/avajs/eslint-plugin-ava/blame/0ded4b5c3cd09504e846309760566c9499a24196/readme.md#L35)
 	*(The description should be the same as the heading of the documentation file).*
 - Run `$ npm test` to ensure the tests pass.
 - Run `$ npm run integration` to run the rules against real projects to ensure your rule does not fail on real-world code.
+- Run `$ npm run update:eslint-docs` to update the readme rules list and standardized rule doc title/notices.
 - Open a pull request with a title in exactly the format `` Add `rule-name` rule ``, for example, `` Add `no-unused-properties` rule ``.
 - The pull request description should include the issue it fixes, for example, `Fixes #123`.

docs/rules/assertion-arguments.md

@@ -1,4 +1,10 @@
-# Enforce passing correct arguments to assertions
+# Enforce passing correct arguments to assertions (`ava/assertion-arguments`)
+
+✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
 
 Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/assertion-arguments.md)
 

docs/rules/hooks-order.md

@@ -1,4 +1,10 @@
-# Enforce test hook ordering
+# Enforce test hook ordering (`ava/hooks-order`)
+
+✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
 
 Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/hooks-order.md)
 

docs/rules/max-asserts.md

@@ -1,4 +1,8 @@
-# Limit the number of assertions in a test
+# Enforce a limit on the number of assertions in a test (`ava/max-asserts`)
+
+✅ This rule is _disabled_ in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
+
+<!-- end auto-generated rule header -->
 
 Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/max-asserts.md)
 

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

@@ -1,4 +1,8 @@
-# Ensure that async tests use `await`
+# Ensure that async tests use `await` (`ava/no-async-fn-without-await`)
+
+✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
+
+<!-- end auto-generated rule header -->
 
 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)
 

docs/rules/no-duplicate-modifiers.md

@@ -1,4 +1,8 @@
-# Ensure tests do not have duplicate modifiers
+# Ensure tests do not have duplicate modifiers (`ava/no-duplicate-modifiers`)
+
+✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
+
+<!-- end auto-generated rule header -->
 
 Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-duplicate-modifiers.md)
 

docs/rules/no-identical-title.md

@@ -1,4 +1,8 @@
-# Ensure no tests have the same title
+# Ensure no tests have the same title (`ava/no-identical-title`)
+
+✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
+
+<!-- end auto-generated rule header -->
 
 Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-identical-title.md)
 

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

@@ -1,4 +1,8 @@
-# Ensure no tests are written in ignored files
+# Ensure no tests are written in ignored files (`ava/no-ignored-test-files`)
+
+✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
+
+<!-- end auto-generated rule header -->
 
 Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-ignored-test-files.md)
 

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

@@ -1,4 +1,8 @@
-# Ensure no test files are imported anywhere
+# Ensure no test files are imported anywhere (`ava/no-import-test-files`)
+
+✅ This rule is enabled in the `recommended` [config](https://github.com/avajs/eslint-plugin-ava#recommended-config).
+
+<!-- end auto-generated rule header -->
 
 Translations: [Français](https://github.com/avajs/ava-docs/blob/main/fr_FR/related/eslint-plugin-ava/docs/rules/no-import-test-files.md)