feat: capitalize default pattern of require-meta-docs-description rule

eslint-community · Nov 17, 2024 · ecaf037 · ecaf037
1 parent 7b93c7a
commit ecaf037
Show file tree

Hide file tree

Showing 31 changed files with 46 additions and 45 deletions.
diff --git a/eslint.config.js b/eslint.config.js
@@ -25,6 +25,7 @@ module.exports = [
       '@eslint-community/eslint-comments/no-unused-disable': 'error',
       '@eslint-community/eslint-comments/require-description': 'error',
 
+      'unicorn/expiring-todo-comments': 'off',
       'unicorn/consistent-function-scoping': 'off',
       'unicorn/no-array-callback-reference': 'off',
       'unicorn/no-array-for-each': 'off',

diff --git a/lib/rules/consistent-output.js b/lib/rules/consistent-output.js
@@ -17,7 +17,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'enforce consistent use of `output` assertions in rule tests',
+        'Enforce consistent use of `output` assertions in rule tests',
       category: 'Tests',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/consistent-output.md',

diff --git a/lib/rules/fixer-return.js b/lib/rules/fixer-return.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'require fixer functions to return a fix',
+      description: 'Require fixer functions to return a fix',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/fixer-return.md',

diff --git a/lib/rules/meta-property-ordering.js b/lib/rules/meta-property-ordering.js
@@ -15,7 +15,7 @@ module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'enforce the order of meta properties',
+      description: 'Enforce the order of meta properties',
       category: 'Rules',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/meta-property-ordering.md',

diff --git a/lib/rules/no-deprecated-context-methods.js b/lib/rules/no-deprecated-context-methods.js
@@ -40,7 +40,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'disallow usage of deprecated methods on rule context objects',
+        'Disallow usage of deprecated methods on rule context objects',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-deprecated-context-methods.md',

diff --git a/lib/rules/no-deprecated-report-api.js b/lib/rules/no-deprecated-report-api.js
@@ -17,7 +17,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'disallow the version of `context.report()` with multiple arguments',
+        'Disallow the version of `context.report()` with multiple arguments',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-deprecated-report-api.md',

diff --git a/lib/rules/no-identical-tests.js b/lib/rules/no-identical-tests.js
@@ -16,7 +16,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'disallow identical tests',
+      description: 'Disallow identical tests',
       category: 'Tests',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-identical-tests.md',

diff --git a/lib/rules/no-missing-message-ids.js b/lib/rules/no-missing-message-ids.js
@@ -12,7 +12,7 @@ module.exports = {
     type: 'problem',
     docs: {
       description:
-        'disallow `messageId`s that are missing from `meta.messages`',
+        'Disallow `messageId`s that are missing from `meta.messages`',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-missing-message-ids.md',

diff --git a/lib/rules/no-missing-placeholders.js b/lib/rules/no-missing-placeholders.js
@@ -17,7 +17,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'disallow missing placeholders in rule report messages',
+      description: 'Disallow missing placeholders in rule report messages',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-missing-placeholders.md',

diff --git a/lib/rules/no-only-tests.js b/lib/rules/no-only-tests.js
@@ -12,7 +12,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'disallow the test case property `only`',
+      description: 'Disallow the test case property `only`',
       category: 'Tests',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-only-tests.md',

diff --git a/lib/rules/no-property-in-node.js b/lib/rules/no-property-in-node.js
@@ -50,7 +50,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'disallow using `in` to narrow node types instead of looking at properties',
+        'Disallow using `in` to narrow node types instead of looking at properties',
       category: 'Rules',
       recommended: false,
       requiresTypeChecking: true,

diff --git a/lib/rules/no-unused-message-ids.js b/lib/rules/no-unused-message-ids.js
@@ -11,7 +11,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'disallow unused `messageId`s in `meta.messages`',
+      description: 'Disallow unused `messageId`s in `meta.messages`',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-unused-message-ids.md',

diff --git a/lib/rules/no-unused-placeholders.js b/lib/rules/no-unused-placeholders.js
@@ -17,7 +17,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'disallow unused placeholders in rule report messages',
+      description: 'Disallow unused placeholders in rule report messages',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-unused-placeholders.md',

diff --git a/lib/rules/no-useless-token-range.js b/lib/rules/no-useless-token-range.js
@@ -17,7 +17,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()`',
+        'Disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()`',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-useless-token-range.md',

diff --git a/lib/rules/prefer-message-ids.js b/lib/rules/prefer-message-ids.js
@@ -13,7 +13,7 @@ module.exports = {
     type: 'problem',
     docs: {
       description:
-        'require using `messageId` instead of `message` or `desc` to report rule violations',
+        'Require using `messageId` instead of `message` or `desc` to report rule violations',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-message-ids.md',

diff --git a/lib/rules/prefer-object-rule.js b/lib/rules/prefer-object-rule.js
@@ -15,7 +15,7 @@ module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'disallow function-style rules',
+      description: 'Disallow function-style rules',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-object-rule.md',

diff --git a/lib/rules/prefer-output-null.js b/lib/rules/prefer-output-null.js
@@ -17,7 +17,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'disallow invalid RuleTester test cases where the `output` matches the `code`',
+        'Disallow invalid RuleTester test cases where the `output` matches the `code`',
       category: 'Tests',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-output-null.md',

diff --git a/lib/rules/prefer-placeholders.js b/lib/rules/prefer-placeholders.js
@@ -17,7 +17,7 @@ module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'require using placeholders for dynamic report messages',
+      description: 'Require using placeholders for dynamic report messages',
       category: 'Rules',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-placeholders.md',

diff --git a/lib/rules/prefer-replace-text.js b/lib/rules/prefer-replace-text.js
@@ -17,7 +17,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'require using `replaceText()` instead of `replaceTextRange()`',
+        'Require using `replaceText()` instead of `replaceTextRange()`',
       category: 'Rules',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-replace-text.md',

diff --git a/lib/rules/report-message-format.js b/lib/rules/report-message-format.js
@@ -17,7 +17,7 @@ module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'enforce a consistent format for rule report messages',
+      description: 'Enforce a consistent format for rule report messages',
       category: 'Rules',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/report-message-format.md',

diff --git a/lib/rules/require-meta-docs-description.js b/lib/rules/require-meta-docs-description.js
@@ -7,15 +7,15 @@ const utils = require('../utils');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
-const DEFAULT_PATTERN = new RegExp('^(enforce|require|disallow)');
+const DEFAULT_PATTERN = new RegExp('^(Enforce|Require|Disallow)');
 
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
       description:
-        'require rules to implement a `meta.docs.description` property with the correct format',
+        'Require rules to implement a `meta.docs.description` property with the correct format',
       category: 'Rules',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-docs-description.md',
@@ -29,7 +29,7 @@ module.exports = {
             type: 'string',
             description:
               "A regular expression that the description must match. Use `'.+'` to allow anything.",
-            default: '^(enforce|require|disallow)',
+            default: '^(Enforce|Require|Disallow)',
           },
         },
         additionalProperties: false,

diff --git a/lib/rules/require-meta-docs-recommended.js b/lib/rules/require-meta-docs-recommended.js
@@ -9,7 +9,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'require rules to implement a `meta.docs.recommended` property',
+        'Require rules to implement a `meta.docs.recommended` property',
       category: 'Rules',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-docs-recommended.md',

diff --git a/lib/rules/require-meta-docs-url.js b/lib/rules/require-meta-docs-url.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'require rules to implement a `meta.docs.url` property',
+      description: 'Require rules to implement a `meta.docs.url` property',
       category: 'Rules',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-docs-url.md',

diff --git a/lib/rules/require-meta-fixable.js b/lib/rules/require-meta-fixable.js
@@ -17,7 +17,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'require rules to implement a `meta.fixable` property',
+      description: 'Require rules to implement a `meta.fixable` property',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-fixable.md',

diff --git a/lib/rules/require-meta-has-suggestions.js b/lib/rules/require-meta-has-suggestions.js
@@ -13,7 +13,7 @@ module.exports = {
     type: 'problem',
     docs: {
       description:
-        'require suggestable rules to implement a `meta.hasSuggestions` property',
+        'Require suggestable rules to implement a `meta.hasSuggestions` property',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-has-suggestions.md',

diff --git a/lib/rules/require-meta-schema-description.js b/lib/rules/require-meta-schema-description.js
@@ -13,7 +13,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'require rules `meta.schema` properties to include descriptions',
+        'Require rules `meta.schema` properties to include descriptions',
       category: 'Rules',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-schema-description.md',

diff --git a/lib/rules/require-meta-schema.js b/lib/rules/require-meta-schema.js
@@ -11,7 +11,7 @@ module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'require rules to implement a `meta.schema` property',
+      description: 'Require rules to implement a `meta.schema` property',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-schema.md',

diff --git a/lib/rules/require-meta-type.js b/lib/rules/require-meta-type.js
@@ -18,7 +18,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'require rules to implement a `meta.type` property',
+      description: 'Require rules to implement a `meta.type` property',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-type.md',

diff --git a/lib/rules/test-case-property-ordering.js b/lib/rules/test-case-property-ordering.js
@@ -17,7 +17,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'require the properties of a test case to be placed in a consistent order',
+        'Require the properties of a test case to be placed in a consistent order',
       category: 'Tests',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/test-case-property-ordering.md',

diff --git a/lib/rules/test-case-shorthand-strings.js b/lib/rules/test-case-shorthand-strings.js
@@ -17,7 +17,7 @@ module.exports = {
     type: 'suggestion',
     docs: {
       description:
-        'enforce consistent usage of shorthand strings for test cases with no options',
+        'Enforce consistent usage of shorthand strings for test cases with no options',
       category: 'Tests',
       recommended: false,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/test-case-shorthand-strings.md',