chore: postprocess with prettier in eslint-doc-generator (#435)

JoshuaKGoldberg · web-flow · commit 015c207caeef · 2024-02-05T13:18:38.000-05:00
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -1,5 +1,7 @@
 'use strict';
 
+const prettier = require('prettier');
+
 /** @type {import('eslint-doc-generator').GenerateOptions} */
 module.exports = {
   ignoreConfig: [
@@ -9,6 +11,11 @@ module.exports = {
     'tests',
     'tests-recommended',
   ],
+  postprocess: async (content, path) =>
+    prettier.format(content, {
+      ...(await prettier.resolveConfig(path)),
+      parser: 'markdown',
+    }),
   ruleDocSectionInclude: ['Rule Details'],
   ruleListSplit: 'meta.docs.category',
   urlConfigs:
diff --git a/README.md b/README.md
diff --git a/docs/rules/consistent-output.md b/docs/rules/consistent-output.md
@@ -66,8 +66,8 @@ new RuleTester().run('example-rule', rule, {
 
 This rule takes an optional string enum option with one of the following values:
 
-* `"consistent"` - (default) if any invalid test cases have output assertions, then all invalid test cases must have output assertions
-* `"always"` - always require invalid test cases to have output assertions
+- `"consistent"` - (default) if any invalid test cases have output assertions, then all invalid test cases must have output assertions
+- `"always"` - always require invalid test cases to have output assertions
 
 ## When Not To Use It
 
@@ -77,4 +77,4 @@ As mentioned in the introduction, the need for this rule is reduced as of ESLint
 
 ## Further Reading
 
-* [`RuleTester` documentation](http://eslint.org/docs/developer-guide/working-with-plugins#testing)
+- [`RuleTester` documentation](http://eslint.org/docs/developer-guide/working-with-plugins#testing)
diff --git a/docs/rules/meta-property-ordering.md b/docs/rules/meta-property-ordering.md
@@ -12,7 +12,7 @@ This rule enforces that meta properties of a rule are placed in a consistent ord
 
 This rule has an array option:
 
-* `['type', 'docs', 'fixable', 'hasSuggestions', 'schema', 'messages', 'deprecated', 'replacedBy']` (default): The order that the properties of `meta` should be placed in.
+- `['type', 'docs', 'fixable', 'hasSuggestions', 'schema', 'messages', 'deprecated', 'replacedBy']` (default): The order that the properties of `meta` should be placed in.
 
 Examples of **incorrect** code for this rule:
 
diff --git a/docs/rules/no-deprecated-context-methods.md b/docs/rules/no-deprecated-context-methods.md
@@ -10,26 +10,26 @@ This rule disallows the use of deprecated methods on rule `context` objects.
 
 The deprecated methods are:
 
-* `getSource`
-* `getSourceLines`
-* `getAllComments`
-* `getNodeByRangeIndex`
-* `getComments`
-* `getCommentsBefore`
-* `getCommentsAfter`
-* `getCommentsInside`
-* `getJSDocComment`
-* `getFirstToken`
-* `getFirstTokens`
-* `getLastToken`
-* `getLastTokens`
-* `getTokenAfter`
-* `getTokenBefore`
-* `getTokenByRangeStart`
-* `getTokens`
-* `getTokensAfter`
-* `getTokensBefore`
-* `getTokensBetween`
+- `getSource`
+- `getSourceLines`
+- `getAllComments`
+- `getNodeByRangeIndex`
+- `getComments`
+- `getCommentsBefore`
+- `getCommentsAfter`
+- `getCommentsInside`
+- `getJSDocComment`
+- `getFirstToken`
+- `getFirstTokens`
+- `getLastToken`
+- `getLastTokens`
+- `getTokenAfter`
+- `getTokenBefore`
+- `getTokenByRangeStart`
+- `getTokens`
+- `getTokensAfter`
+- `getTokensBefore`
+- `getTokensBetween`
 
 Instead of using these methods, you should use the equivalent methods on [`SourceCode`](https://eslint.org/docs/developer-guide/working-with-rules#contextgetsourcecode), e.g. `context.getSourceCode().getText()` instead of `context.getSource()`.
 
@@ -71,4 +71,4 @@ If you need to support very old versions of ESLint where `SourceCode` doesn't ex
 
 ## Further Reading
 
-* [`SourceCode` API](https://eslint.org/docs/developer-guide/working-with-rules#contextgetsourcecode)
+- [`SourceCode` API](https://eslint.org/docs/developer-guide/working-with-rules#contextgetsourcecode)
diff --git a/docs/rules/no-deprecated-report-api.md b/docs/rules/no-deprecated-report-api.md
@@ -8,8 +8,8 @@
 
 ESLint has two APIs that rules can use to report problems.
 
-* The [deprecated API](http://eslint.org/docs/developer-guide/working-with-rules-deprecated) accepts multiple arguments: `context.report(node, [loc], message)`.
-* The ["new API"](http://eslint.org/docs/developer-guide/working-with-rules#contextreport) accepts a single argument: an object containing information about the reported problem.
+- The [deprecated API](http://eslint.org/docs/developer-guide/working-with-rules-deprecated) accepts multiple arguments: `context.report(node, [loc], message)`.
+- The ["new API"](http://eslint.org/docs/developer-guide/working-with-rules#contextreport) accepts a single argument: an object containing information about the reported problem.
 
 It is recommended that all rules use the new API.
 
@@ -41,5 +41,5 @@ module.exports = {
 
 ## Further Reading
 
-* [Deprecated rule API](http://eslint.org/docs/developer-guide/working-with-rules-deprecated)
-* [New rule API](http://eslint.org/docs/developer-guide/working-with-rules)
+- [Deprecated rule API](http://eslint.org/docs/developer-guide/working-with-rules-deprecated)
+- [New rule API](http://eslint.org/docs/developer-guide/working-with-rules)
diff --git a/docs/rules/no-missing-message-ids.md b/docs/rules/no-missing-message-ids.md
@@ -58,6 +58,6 @@ module.exports = {
 
 ## Further Reading
 
-* [messageIds API](https://eslint.org/docs/developer-guide/working-with-rules#messageids)
-* [no-unused-message-ids](./no-unused-message-ids.md) rule
-* [prefer-message-ids](./prefer-message-ids.md) rule
+- [messageIds API](https://eslint.org/docs/developer-guide/working-with-rules#messageids)
+- [no-unused-message-ids](./no-unused-message-ids.md) rule
+- [prefer-message-ids](./prefer-message-ids.md) rule
diff --git a/docs/rules/no-missing-placeholders.md b/docs/rules/no-missing-placeholders.md
@@ -74,4 +74,4 @@ If you want to use rule messages that actually contain double-curly bracket text
 
 ## Further Reading
 
-* [context.report() API](http://eslint.org/docs/developer-guide/working-with-rules#contextreport)
+- [context.report() API](http://eslint.org/docs/developer-guide/working-with-rules#contextreport)
diff --git a/docs/rules/no-unused-message-ids.md b/docs/rules/no-unused-message-ids.md
@@ -59,6 +59,6 @@ module.exports = {
 
 ## Further Reading
 
-* [messageIds API](https://eslint.org/docs/developer-guide/working-with-rules#messageids)
-* [no-missing-message-ids](./no-missing-message-ids.md) rule
-* [prefer-message-ids](./prefer-message-ids.md) rule
+- [messageIds API](https://eslint.org/docs/developer-guide/working-with-rules#messageids)
+- [no-missing-message-ids](./no-missing-message-ids.md) rule
+- [prefer-message-ids](./prefer-message-ids.md) rule
diff --git a/docs/rules/no-unused-placeholders.md b/docs/rules/no-unused-placeholders.md
@@ -57,5 +57,5 @@ If you want to allow unused placeholders, you should turn off this rule.
 
 ## Further Reading
 
-* [context.report() API](http://eslint.org/docs/developer-guide/working-with-rules#contextreport)
-* [no-missing-placeholders](https://github.com/eslint-community/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-missing-placeholders.md)
+- [context.report() API](http://eslint.org/docs/developer-guide/working-with-rules#contextreport)
+- [no-missing-placeholders](https://github.com/eslint-community/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-missing-placeholders.md)
diff --git a/docs/rules/no-useless-token-range.md b/docs/rules/no-useless-token-range.md
@@ -44,8 +44,8 @@ module.exports = {
 
 ## Known Limitations
 
-* To ensure that your `SourceCode` instances can be detected, your rule must assign `context.getSourceCode()` to a variable somewhere.
+- To ensure that your `SourceCode` instances can be detected, your rule must assign `context.getSourceCode()` to a variable somewhere.
 
 ## Further Reading
 
-* [`SourceCode` API](https://eslint.org/docs/developer-guide/working-with-rules#contextgetsourcecode)
+- [`SourceCode` API](https://eslint.org/docs/developer-guide/working-with-rules#contextgetsourcecode)
diff --git a/docs/rules/prefer-message-ids.md b/docs/rules/prefer-message-ids.md
@@ -6,9 +6,9 @@
 
 When reporting a rule violation, it's preferred to provide the violation message with the `messageId` property instead of the `message` property. Message IDs provide the following benefits:
 
-* Rule violation messages can be stored in a central `meta.messages` object for convenient management
-* Rule violation messages do not need to be repeated in both the rule file and rule test file
-* As a result, the barrier for changing rule violation messages is lower, encouraging more frequent contributions to improve and optimize them for the greatest clarity and usefulness
+- Rule violation messages can be stored in a central `meta.messages` object for convenient management
+- Rule violation messages do not need to be repeated in both the rule file and rule test file
+- As a result, the barrier for changing rule violation messages is lower, encouraging more frequent contributions to improve and optimize them for the greatest clarity and usefulness
 
 ## Rule Details
 
@@ -59,6 +59,6 @@ module.exports = {
 
 ## Further Reading
 
-* [messageIds API](https://eslint.org/docs/developer-guide/working-with-rules#messageids)
-* [no-invalid-message-ids](./no-invalid-message-ids.md) rule
-* [no-missing-message-ids](./no-missing-message-ids.md) rule
+- [messageIds API](https://eslint.org/docs/developer-guide/working-with-rules#messageids)
+- [no-invalid-message-ids](./no-invalid-message-ids.md) rule
+- [no-missing-message-ids](./no-missing-message-ids.md) rule
diff --git a/docs/rules/prefer-object-rule.md b/docs/rules/prefer-object-rule.md
@@ -34,7 +34,9 @@ Examples of **correct** code for this rule:
 /* eslint eslint-plugin/prefer-object-rule: error */
 
 module.exports = {
-  meta: { /* ... */ },
+  meta: {
+    /* ... */
+  },
   create(context) {
     return {
       Program() {
diff --git a/docs/rules/prefer-placeholders.md b/docs/rules/prefer-placeholders.md
@@ -14,8 +14,8 @@ context.report({
 
 Using placeholders is often preferred over using dynamic report messages, for a few reasons:
 
-* They can help enforce a separation of the message and the data.
-* It will be easier to migrate when ESLint starts supporting placing lint messages in metadata (see [#6740](https://github.com/eslint/eslint/issues/6740))
+- They can help enforce a separation of the message and the data.
+- It will be easier to migrate when ESLint starts supporting placing lint messages in metadata (see [#6740](https://github.com/eslint/eslint/issues/6740))
 
 ## Rule Details
 
@@ -63,4 +63,4 @@ If you need to use string concatenation in your report messages for some reason,
 
 ## Further Reading
 
-* [context.report() API](http://eslint.org/docs/developer-guide/working-with-rules#contextreport)
+- [context.report() API](http://eslint.org/docs/developer-guide/working-with-rules#contextreport)
diff --git a/docs/rules/prefer-replace-text.md b/docs/rules/prefer-replace-text.md
@@ -53,4 +53,4 @@ module.exports = {
 
 ## Further Reading
 
-* [Applying Fixes](https://eslint.org/docs/developer-guide/working-with-rules#applying-fixes)
+- [Applying Fixes](https://eslint.org/docs/developer-guide/working-with-rules#applying-fixes)
diff --git a/docs/rules/report-message-format.md b/docs/rules/report-message-format.md
@@ -16,16 +16,14 @@ For example, in order to mandate that all report messages begin with a capital l
 
 ```json
 {
-    "rules": {
-        "eslint-plugin/report-message-format": ["error", "^[A-Z].*\\.$"]
-    },
-    "plugins": [
-        "eslint-plugin"
-    ]
+  "rules": {
+    "eslint-plugin/report-message-format": ["error", "^[A-Z].*\\.$"]
+  },
+  "plugins": ["eslint-plugin"]
 }
 ```
 
-Note that since this rule uses static analysis and does not actually run your code, it will attempt to match report messages *before* placeholders are inserted.
+Note that since this rule uses static analysis and does not actually run your code, it will attempt to match report messages _before_ placeholders are inserted.
 
 Examples of **incorrect** code for this rule:
 
diff --git a/docs/rules/require-meta-docs-description.md b/docs/rules/require-meta-docs-description.md
@@ -6,9 +6,9 @@ Defining a clear and consistent description for each rule helps developers under
 
 In particular, each rule description should begin with an allowed prefix:
 
-* `enforce`
-* `require`
-* `disallow`
+- `enforce`
+- `require`
+- `disallow`
 
 ## Rule Details
 
@@ -59,4 +59,4 @@ module.exports = {
 
 ## Further Reading
 
-* [working-with-rules#options-schemas](https://eslint.org/docs/developer-guide/working-with-rules#options-schemas)
+- [working-with-rules#options-schemas](https://eslint.org/docs/developer-guide/working-with-rules#options-schemas)
diff --git a/docs/rules/require-meta-docs-url.md b/docs/rules/require-meta-docs-url.md
@@ -87,9 +87,12 @@ module.exports = {
 
 ```json
 {
-  "eslint-plugin/require-meta-docs-url": ["error", {
-    "pattern": "https://github.com/eslint-community/eslint-plugin-eslint-plugin/blob/master/docs/rules/{{name}}.md"
-  }]
+  "eslint-plugin/require-meta-docs-url": [
+    "error",
+    {
+      "pattern": "https://github.com/eslint-community/eslint-plugin-eslint-plugin/blob/master/docs/rules/{{name}}.md"
+    }
+  ]
 }
 ```
 
diff --git a/docs/rules/require-meta-fixable.md b/docs/rules/require-meta-fixable.md
@@ -102,5 +102,5 @@ module.exports = {
 
 ## Further Reading
 
-* [ESLint's autofix API](http://eslint.org/docs/developer-guide/working-with-rules#applying-fixes)
-* [ESLint's rule basics mentioning `meta.fixable`](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics)
+- [ESLint's autofix API](http://eslint.org/docs/developer-guide/working-with-rules#applying-fixes)
+- [ESLint's rule basics mentioning `meta.fixable`](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics)
diff --git a/docs/rules/require-meta-has-suggestions.md b/docs/rules/require-meta-has-suggestions.md
@@ -88,5 +88,5 @@ module.exports = {
 
 ## Further Reading
 
-* [ESLint's suggestion API](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
-* [ESLint rule basics describing the `meta.hasSuggestions` property](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics)
+- [ESLint's suggestion API](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+- [ESLint rule basics describing the `meta.hasSuggestions` property](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics)
diff --git a/docs/rules/require-meta-schema.md b/docs/rules/require-meta-schema.md
@@ -89,4 +89,4 @@ As mentioned in the introduction, the need for this rule is reduced as of ESLint
 
 ## Further Reading
 
-* [working-with-rules#options-schemas](https://eslint.org/docs/developer-guide/working-with-rules#options-schemas)
+- [working-with-rules#options-schemas](https://eslint.org/docs/developer-guide/working-with-rules#options-schemas)
diff --git a/docs/rules/require-meta-type.md b/docs/rules/require-meta-type.md
@@ -12,9 +12,9 @@ Fixes in custom rules will not be applied when using `--fix-type` unless they in
 
 This rule aims to require ESLint rules to have a valid `meta.type` property with one of the following values:
 
-* `"problem"` means the rule is identifying code that either will cause an error or may cause a confusing behavior. Developers should consider this a high priority to resolve.
-* `"suggestion"` means the rule is identifying something that could be done in a better way but no errors will occur if the code isn't changed.
-* `"layout"` means the rule cares primarily about whitespace, semicolons, commas, and parentheses, all the parts of the program that determine how the code looks rather than how it executes. These rules work on parts of the code that aren't specified in the AST.
+- `"problem"` means the rule is identifying code that either will cause an error or may cause a confusing behavior. Developers should consider this a high priority to resolve.
+- `"suggestion"` means the rule is identifying something that could be done in a better way but no errors will occur if the code isn't changed.
+- `"layout"` means the rule cares primarily about whitespace, semicolons, commas, and parentheses, all the parts of the program that determine how the code looks rather than how it executes. These rules work on parts of the code that aren't specified in the AST.
 
 Examples of **incorrect** code for this rule:
 
@@ -51,6 +51,6 @@ module.exports = {
 
 ## Further Reading
 
-* [command-line-interface#--fix-type](https://eslint.org/docs/user-guide/command-line-interface#--fix-type)
-* [working-with-rules#rule-basics](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics)
-* [ESLint v5.9.0 released](https://eslint.org/blog/2018/11/eslint-v5.9.0-released#the-fix-type-option)
+- [command-line-interface#--fix-type](https://eslint.org/docs/user-guide/command-line-interface#--fix-type)
+- [working-with-rules#rule-basics](https://eslint.org/docs/developer-guide/working-with-rules#rule-basics)
+- [ESLint v5.9.0 released](https://eslint.org/blog/2018/11/eslint-v5.9.0-released#the-fix-type-option)
diff --git a/docs/rules/test-case-property-ordering.md b/docs/rules/test-case-property-ordering.md
@@ -12,7 +12,7 @@ This rule enforces that the properties of RuleTester test cases are arranged in
 
 This rule has an array option:
 
-* `["code", "output", "options", "parserOptions", "errors"]` (default): The properties of a test case should be placed in a consistent order.
+- `["code", "output", "options", "parserOptions", "errors"]` (default): The properties of a test case should be placed in a consistent order.
 
 Examples of **incorrect** code for this rule:
 
diff --git a/docs/rules/test-case-shorthand-strings.md b/docs/rules/test-case-shorthand-strings.md
@@ -33,10 +33,10 @@ This rule aims to enforce or disallow the use of strings as test cases.
 
 This rule has a string option:
 
-* `as-needed` (default): Requires the use of shorthand strings wherever possible.
-* `never`: Disallows the use of shorthand strings.
-* `consistent`: Requires that either all valid test cases use shorthand strings, or that no valid test cases use them.
-* `consistent-as-needed`: Requires that all valid test cases use the longer object form if there are any valid test cases that require the object form. Otherwise, requires all valid test cases to use shorthand strings.
+- `as-needed` (default): Requires the use of shorthand strings wherever possible.
+- `never`: Disallows the use of shorthand strings.
+- `consistent`: Requires that either all valid test cases use shorthand strings, or that no valid test cases use them.
+- `consistent-as-needed`: Requires that all valid test cases use the longer object form if there are any valid test cases that require the object form. Otherwise, requires all valid test cases to use shorthand strings.
 
 #### `as-needed`
 
@@ -237,15 +237,15 @@ ruleTester.run('example-rule', rule, {
 
 ## Known Limitations
 
-* Test cases which are neither object literals nor string literals are ignored by this rule.
-* In order to find your test cases, your test file needs to match the following common pattern:
-  * `new RuleTester()` or `new (require('eslint')).RuleTester()` is called at the top level of the file
-  * `ruleTester.run` is called at the top level with the same variable (or in the same expression) as the `new RuleTester` instantiation
+- Test cases which are neither object literals nor string literals are ignored by this rule.
+- In order to find your test cases, your test file needs to match the following common pattern:
+  - `new RuleTester()` or `new (require('eslint')).RuleTester()` is called at the top level of the file
+  - `ruleTester.run` is called at the top level with the same variable (or in the same expression) as the `new RuleTester` instantiation
 
 ## When Not To Use It
 
 If you don't care about consistent usage of shorthand strings, you should not turn on this rule.
 
 ## Further Reading
 
-* [`RuleTester` documentation](http://eslint.org/docs/developer-guide/working-with-plugins#testing)
+- [`RuleTester` documentation](http://eslint.org/docs/developer-guide/working-with-plugins#testing)

Original file line number	Diff line number	Diff line change
`@@ -74,4 +74,4 @@ If you want to use rule messages that actually contain double-curly bracket text`
`74`	`74`
`75`	`75`	`## Further Reading`
`76`	`76`
`77`		`-* [context.report() API](http://eslint.org/docs/developer-guide/working-with-rules#contextreport)`
	`77`	`+- [context.report() API](http://eslint.org/docs/developer-guide/working-with-rules#contextreport)`