Merge branch 'main' into require-meta-default-options

FloEdelmann · web-flow · commit 60eecd272f66 · 2024-11-25T19:23:38.000+01:00
diff --git a/README.md b/README.md
@@ -99,7 +99,7 @@ module.exports = [
 | [report-message-format](docs/rules/report-message-format.md)                     | enforce a consistent format for rule report messages                                       |     |     |     |     |
 | [require-meta-default-options](docs/rules/require-meta-default-options.md)       | require only rules with options to implement a `meta.defaultOptions` property              |     | 🔧  |     |     |
 | [require-meta-docs-description](docs/rules/require-meta-docs-description.md)     | require rules to implement a `meta.docs.description` property with the correct format      |     |     |     |     |
-| [require-meta-docs-recommended](docs/rules/require-meta-docs-recommended.md)     | require rules to implement a `meta.docs.recommended` property                              |     |     |     |     |
+| [require-meta-docs-recommended](docs/rules/require-meta-docs-recommended.md)     | require rules to implement a `meta.docs.recommended` property                              |     |     | 💡  |     |
 | [require-meta-docs-url](docs/rules/require-meta-docs-url.md)                     | require rules to implement a `meta.docs.url` property                                      |     | 🔧  |     |     |
 | [require-meta-fixable](docs/rules/require-meta-fixable.md)                       | require rules to implement a `meta.fixable` property                                       | ✅  |     |     |     |
 | [require-meta-has-suggestions](docs/rules/require-meta-has-suggestions.md)       | require suggestable rules to implement a `meta.hasSuggestions` property                    | ✅  | 🔧  |     |     |
diff --git a/docs/rules/consistent-output.md b/docs/rules/consistent-output.md
@@ -75,4 +75,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)
+- [ESLint plugin docs: Testing a Plugin](https://eslint.org/docs/latest/extend/plugins#testing-a-plugin)
diff --git a/docs/rules/fixer-return.md b/docs/rules/fixer-return.md
@@ -4,7 +4,7 @@
 
 <!-- end auto-generated rule header -->
 
-In a [fixable](https://eslint.org/docs/developer-guide/working-with-rules#applying-fixes) rule, a fixer function is useless if it never returns anything.
+In a [fixable](https://eslint.org/docs/latest/extend/custom-rules#applying-fixes) rule, a fixer function is useless if it never returns anything.
 
 ## Rule Details
 
diff --git a/docs/rules/no-deprecated-context-methods.md b/docs/rules/no-deprecated-context-methods.md
@@ -31,7 +31,7 @@ The deprecated methods are:
 - `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()`.
+Instead of using these methods, you should use the equivalent methods on [`SourceCode`](https://eslint.org/docs/latest/extend/custom-rules#accessing-the-source-code), e.g. `context.sourceCode.getText()` instead of `context.getSource()`.
 
 ## Rule Details
 
@@ -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)
+- [ESLint rule docs: Accessing the Source Code](https://eslint.org/docs/latest/extend/custom-rules#accessing-the-source-code)
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](https://eslint.org/docs/latest/extend/custom-rules-deprecated) accepts multiple arguments: `context.report(node, [loc], message)`.
+- The ["new API"](https://eslint.org/docs/latest/extend/custom-rules#reporting-problems) 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,4 @@ 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)
+- [ESLint rule docs: Reporting Problems](https://eslint.org/docs/latest/extend/custom-rules#reporting-problems)
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)
+- [ESLint rule docs: `messageId`s](https://eslint.org/docs/latest/extend/custom-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)
+- [ESLint rule docs: Using Message Placeholders](https://eslint.org/docs/latest/extend/custom-rules#using-message-placeholders)
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)
+- [ESLint rule docs: `messageId`s](https://eslint.org/docs/latest/extend/custom-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)
+- [ESLint rule docs: Using Message Placeholders](https://eslint.org/docs/latest/extend/custom-rules#using-message-placeholders)
 - [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
@@ -48,4 +48,4 @@ module.exports = {
 
 ## Further Reading
 
-- [`SourceCode` API](https://eslint.org/docs/developer-guide/working-with-rules#contextgetsourcecode)
+- [ESLint rule docs: Accessing the Source Code](https://eslint.org/docs/latest/extend/custom-rules#accessing-the-source-code)
diff --git a/docs/rules/prefer-message-ids.md b/docs/rules/prefer-message-ids.md
@@ -59,6 +59,6 @@ module.exports = {
 
 ## Further Reading
 
-- [messageIds API](https://eslint.org/docs/developer-guide/working-with-rules#messageids)
+- [ESLint rule docs: `messageId`s](https://eslint.org/docs/latest/extend/custom-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
@@ -6,7 +6,7 @@
 
 <!-- end auto-generated rule header -->
 
-Prior to ESLint v9, ESLint supported both [function-style](https://eslint.org/docs/developer-guide/working-with-rules-deprecated) and [object-style](https://eslint.org/docs/developer-guide/working-with-rules) rules. However, function-style rules have been deprecated since 2016, and do not support newer features like autofixing and suggestions.
+Prior to ESLint v9, ESLint supported both [function-style](https://eslint.org/docs/latest/extend/custom-rules-deprecated) and [object-style](https://eslint.org/docs/latest/extend/custom-rules) rules. However, function-style rules have been deprecated since 2016, and do not support newer features like autofixing and suggestions.
 
 As of [ESLint v9](https://github.com/eslint/rfcs/tree/main/designs/2021-schema-object-rules#motivation-for-requiring-object-style-rules), ESLint supports only object-style rules.
 
diff --git a/docs/rules/prefer-placeholders.md b/docs/rules/prefer-placeholders.md
@@ -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)
+- [ESLint rule docs: Using Message Placeholders](https://eslint.org/docs/latest/extend/custom-rules#using-message-placeholders)
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)
+- [ESLint rule docs: Applying Fixes](https://eslint.org/docs/latest/extend/custom-rules#applying-fixes)
diff --git a/docs/rules/require-meta-docs-description.md b/docs/rules/require-meta-docs-description.md
@@ -59,4 +59,4 @@ module.exports = {
 
 ## Further Reading
 
-- [working-with-rules#options-schemas](https://eslint.org/docs/developer-guide/working-with-rules#options-schemas)
+- [ESLint rule docs: Options Schemas](https://eslint.org/docs/latest/extend/custom-rules#options-schemas)
diff --git a/docs/rules/require-meta-docs-recommended.md b/docs/rules/require-meta-docs-recommended.md
@@ -1,5 +1,7 @@
 # Require rules to implement a `meta.docs.recommended` property (`eslint-plugin/require-meta-docs-recommended`)
 
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
+
 <!-- end auto-generated rule header -->
 
 Utilizing `meta.docs.recommended` makes it clear from each rule implementation whether a rule is part of the `recommended` config. Some plugins also have scripting for conveniently generating their config based on this flag.
@@ -72,4 +74,4 @@ module.exports = {
 
 ## Further Reading
 
-- [Rule Structure](https://eslint.org/docs/latest/extend/custom-rules#rule-structure)
+- [ESLint rule docs: Rule Structure](https://eslint.org/docs/latest/extend/custom-rules#rule-structure)
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 rule docs: Applying Fixes](https://eslint.org/docs/latest/extend/custom-rules#applying-fixes)
+- [ESLint rule docs: Rule Structure (mentioning `meta.fixable`)](https://eslint.org/docs/latest/extend/custom-rules#rule-structure)
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 rule docs: Providing Suggestions](https://eslint.org/docs/latest/extend/custom-rules#providing-suggestions)
+- [ESLint rule docs: Rule Structure (mentioning `meta.hasSuggestions`)](https://eslint.org/docs/latest/extend/custom-rules#rule-structure)
diff --git a/docs/rules/require-meta-schema-description.md b/docs/rules/require-meta-schema-description.md
@@ -85,4 +85,4 @@ If your rule options are very simple and well-named, and your rule isn't used by
 
 ## Further Reading
 
-- [working-with-rules#options-schemas](https://eslint.org/docs/developer-guide/working-with-rules#options-schemas)
+- [ESLint rule docs: Options Schemas](https://eslint.org/docs/latest/extend/custom-rules#options-schemas)
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)
+- [ESLint rule docs: Options Schemas](https://eslint.org/docs/latest/extend/custom-rules#options-schemas)
diff --git a/docs/rules/require-meta-type.md b/docs/rules/require-meta-type.md
@@ -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 CLI docs: `--fix-type`](https://eslint.org/docs/latest/use/command-line-interface#--fix-type)
+- [ESLint rule docs: Rule Structure](https://eslint.org/docs/latest/extend/custom-rules#rule-structure)
 - [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-shorthand-strings.md b/docs/rules/test-case-shorthand-strings.md
@@ -248,4 +248,4 @@ If you don't care about consistent usage of shorthand strings, you should not tu
 
 ## Further Reading
 
-- [`RuleTester` documentation](http://eslint.org/docs/developer-guide/working-with-plugins#testing)
+- [ESLint plugin docs: Testing a Plugin](https://eslint.org/docs/latest/extend/plugins#testing-a-plugin)
diff --git a/lib/rules/require-meta-docs-recommended.js b/lib/rules/require-meta-docs-recommended.js
@@ -3,6 +3,24 @@
 const { getStaticValue } = require('@eslint-community/eslint-utils');
 const utils = require('../utils');
 
+/**
+ * @param {import('eslint').Rule.RuleFixer} fixer
+ * @param {import('estree').ObjectExpression} objectNode
+ * @param {boolean} recommendedValue
+ */
+function insertRecommendedProperty(fixer, objectNode, recommendedValue) {
+  if (objectNode.properties.length === 0) {
+    return fixer.replaceText(
+      objectNode,
+      `{ recommended: ${recommendedValue} }`,
+    );
+  }
+  return fixer.insertTextAfter(
+    objectNode.properties.at(-1),
+    `, recommended: ${recommendedValue}`,
+  );
+}
+
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
   meta: {
@@ -15,6 +33,7 @@ module.exports = {
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-docs-recommended.md',
     },
     fixable: null,
+    hasSuggestions: true,
     schema: [
       {
         type: 'object',
@@ -32,6 +51,8 @@ module.exports = {
     messages: {
       incorrect: '`meta.docs.recommended` is required to be a boolean.',
       missing: '`meta.docs.recommended` is required.',
+      setRecommendedTrue: 'Set `meta.docs.recommended` to `true`.',
+      setRecommendedFalse: 'Set `meta.docs.recommended` to `false`.',
     },
   },
 
@@ -50,9 +71,26 @@ module.exports = {
     } = utils.getMetaDocsProperty('recommended', ruleInfo, scopeManager);
 
     if (!descriptionNode) {
+      const suggestions =
+        docsNode?.value?.type === 'ObjectExpression'
+          ? [
+              {
+                messageId: 'setRecommendedTrue',
+                fix: (fixer) =>
+                  insertRecommendedProperty(fixer, docsNode.value, true),
+              },
+              {
+                messageId: 'setRecommendedFalse',
+                fix: (fixer) =>
+                  insertRecommendedProperty(fixer, docsNode.value, false),
+              },
+            ]
+          : [];
+
       context.report({
         node: docsNode || metaNode || ruleInfo.create,
         messageId: 'missing',
+        suggest: suggestions,
       });
       return {};
     }
@@ -69,6 +107,16 @@ module.exports = {
       context.report({
         node: descriptionNode.value,
         messageId: 'incorrect',
+        suggest: [
+          {
+            messageId: 'setRecommendedTrue',
+            fix: (fixer) => fixer.replaceText(descriptionNode.value, 'true'),
+          },
+          {
+            messageId: 'setRecommendedFalse',
+            fix: (fixer) => fixer.replaceText(descriptionNode.value, 'false'),
+          },
+        ],
       });
       return {};
     }
diff --git a/tests/lib/rules/require-meta-docs-recommended.js b/tests/lib/rules/require-meta-docs-recommended.js

Original file line number	Diff line number	Diff line change
`@@ -75,4 +75,4 @@ As mentioned in the introduction, the need for this rule is reduced as of ESLint`
`75`	`75`
`76`	`76`	`## Further Reading`
`77`	`77`
`78`		-- [`RuleTester` documentation](http://eslint.org/docs/developer-guide/working-with-plugins#testing)
	`78`	`+- [ESLint plugin docs: Testing a Plugin](https://eslint.org/docs/latest/extend/plugins#testing-a-plugin)`
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`	`+- [ESLint rule docs: Using Message Placeholders](https://eslint.org/docs/latest/extend/custom-rules#using-message-placeholders)`
Original file line number	Diff line number	Diff line change
`@@ -48,4 +48,4 @@ module.exports = {`
`48`	`48`
`49`	`49`	`## Further Reading`
`50`	`50`
`51`		-- [`SourceCode` API](https://eslint.org/docs/developer-guide/working-with-rules#contextgetsourcecode)
	`51`	`+- [ESLint rule docs: Accessing the Source Code](https://eslint.org/docs/latest/extend/custom-rules#accessing-the-source-code)`