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

azat-io · azat-io · commit d668e89d23a4 · 2025-10-05T18:58:00.000+03:00
diff --git a/e2e/fixtures/all-typed-config/rule.js b/e2e/fixtures/all-typed-config/rule.js
@@ -4,7 +4,7 @@ const rule = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'enforce a test',
+      description: 'Enforce a test',
       recommended: false,
       url: 'https://test.org',
     },
diff --git a/e2e/fixtures/all/rule.js b/e2e/fixtures/all/rule.js
@@ -4,7 +4,7 @@ const rule = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'enforce a test',
+      description: 'Enforce a test',
       recommended: false,
       url: 'https://test.org',
     },
diff --git a/lib/rules/consistent-output.ts b/lib/rules/consistent-output.ts
@@ -17,7 +17,7 @@ const rule: Rule.RuleModule = {
     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.ts b/lib/rules/fixer-return.ts
@@ -36,7 +36,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/meta-property-ordering.ts
@@ -27,7 +27,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/no-deprecated-context-methods.ts
@@ -38,7 +38,7 @@ const rule: Rule.RuleModule = {
     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.ts b/lib/rules/no-deprecated-report-api.ts
@@ -15,7 +15,7 @@ const rule: Rule.RuleModule = {
     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-missing-message-ids.ts b/lib/rules/no-missing-message-ids.ts
@@ -19,7 +19,7 @@ const rule: Rule.RuleModule = {
     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.ts b/lib/rules/no-missing-placeholders.ts
@@ -23,7 +23,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/no-only-tests.ts
@@ -11,7 +11,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/no-property-in-node.ts
@@ -51,7 +51,7 @@ const rule: Rule.RuleModule = {
     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,
       // @ts-expect-error -- need to augment the type of `Rule.RuleMetaData` to include `requiresTypeChecking`
diff --git a/lib/rules/no-unused-message-ids.ts b/lib/rules/no-unused-message-ids.ts
@@ -20,7 +20,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/no-unused-placeholders.ts
@@ -23,7 +23,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/no-useless-token-range.ts
@@ -15,7 +15,7 @@ const rule: Rule.RuleModule = {
     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.ts b/lib/rules/prefer-message-ids.ts
@@ -18,7 +18,7 @@ const rule: Rule.RuleModule = {
     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.ts b/lib/rules/prefer-object-rule.ts
@@ -12,7 +12,7 @@ const rule: Rule.RuleModule = {
   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-placeholders.ts b/lib/rules/prefer-placeholders.ts
@@ -20,7 +20,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/prefer-replace-text.ts
@@ -27,7 +27,7 @@ const rule: Rule.RuleModule = {
     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.ts b/lib/rules/report-message-format.ts
@@ -20,7 +20,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/require-meta-docs-description.ts
@@ -3,14 +3,14 @@ import type { Rule } from 'eslint';
 
 import { getMetaDocsProperty, getRuleInfo } from '../utils.ts';
 
-const DEFAULT_PATTERN = new RegExp('^(enforce|require|disallow)');
+const DEFAULT_PATTERN = new RegExp('^(Enforce|Require|Disallow)');
 
 const rule: Rule.RuleModule = {
   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',
@@ -24,13 +24,13 @@ const rule: Rule.RuleModule = {
             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,
       },
     ],
-    defaultOptions: [{ pattern: '^(enforce|require|disallow)' }],
+    defaultOptions: [{ pattern: '^(Enforce|Require|Disallow)' }],
     messages: {
       extraWhitespace:
         '`meta.docs.description` must not have leading nor trailing whitespace.',
diff --git a/lib/rules/require-meta-docs-url.ts b/lib/rules/require-meta-docs-url.ts
@@ -21,7 +21,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/require-meta-fixable.ts
@@ -20,7 +20,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/require-meta-has-suggestions.ts
@@ -18,7 +18,7 @@ const rule: Rule.RuleModule = {
     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.ts b/lib/rules/require-meta-schema-description.ts
@@ -16,7 +16,7 @@ const rule: Rule.RuleModule = {
     type: 'suggestion',
     docs: {
       description:
-        'require rules `meta.schema` properties to include descriptions',
+        'Require rules `meta.schema` properties to include descriptions',
       category: 'Rules',
       recommended: true,
       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.ts b/lib/rules/require-meta-schema.ts
@@ -17,7 +17,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/require-meta-type.ts
@@ -16,7 +16,7 @@ const rule: Rule.RuleModule = {
   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.ts b/lib/rules/test-case-property-ordering.ts
@@ -30,7 +30,7 @@ const rule: Rule.RuleModule = {
     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.ts b/lib/rules/test-case-shorthand-strings.ts
@@ -15,7 +15,7 @@ const rule: Rule.RuleModule = {
     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',
diff --git a/tests/lib/rules/require-meta-docs-description.ts b/tests/lib/rules/require-meta-docs-description.ts
@@ -19,29 +19,29 @@ ruleTester.run('require-meta-docs-description', rule, {
     'module.exports = {};', // No rule.
     `
       module.exports = {
-        meta: { docs: { description: 'disallow unused variables' } },
+        meta: { docs: { description: 'Disallow unused variables' } },
         create(context) {}
       };
     `,
     {
       // ESM
       code: `
         export default {
-          meta: { docs: { description: 'disallow unused variables' } },
+          meta: { docs: { description: 'Disallow unused variables' } },
           create(context) {}
         };
       `,
       languageOptions: { sourceType: 'module' },
     },
     `
       module.exports = {
-        meta: { docs: { description: 'enforce a maximum line length' } },
+        meta: { docs: { description: 'Enforce a maximum line length' } },
         create(context) {}
       };
     `,
     `
       module.exports = {
-        meta: { docs: { description: 'require or disallow newline at the end of files' } },
+        meta: { docs: { description: 'Require or disallow newline at the end of files' } },
         create(context) {}
       };
     `,
@@ -53,24 +53,24 @@ ruleTester.run('require-meta-docs-description', rule, {
     `,
     `
       module.exports = {
-        meta: { docs: { description: \`enforce with template literal\` } },
+        meta: { docs: { description: \`Enforce with template literal\` } },
         create(context) {}
       };
     `,
     `
       module.exports = {
-        meta: { docs: { description: "enforce" + " " + "something" } },
+        meta: { docs: { description: "Enforce" + " " + "something" } },
         create(context) {}
       };
     `,
     `
       module.exports = {
-        meta: { docs: { description: "enforce " + generateSomething() } },
+        meta: { docs: { description: "Enforce " + generateSomething() } },
         create(context) {}
       };
     `,
     `
-      const DESCRIPTION = 'require foo';
+      const DESCRIPTION = 'Require foo';
       module.exports = {
         meta: { docs: { description: DESCRIPTION } },
         create(context) {}
@@ -103,15 +103,15 @@ ruleTester.run('require-meta-docs-description', rule, {
     },
     // `meta` in variable, `description` present.
     `
-      const meta = { docs: { description: 'enforce foo' } };
+      const meta = { docs: { description: 'Enforce foo' } };
       module.exports = {
         meta,
         create(context) {}
       };
     `,
     // Spread.
     `
-      const extraDocs = { description: 'enforce foo' };
+      const extraDocs = { description: 'Enforce foo' };
       const extraMeta = { docs: { ...extraDocs } };
       module.exports = {
         meta: { ...extraMeta },
@@ -236,7 +236,7 @@ ruleTester.run('require-meta-docs-description', rule, {
     {
       code: `
         module.exports = {
-          meta: { docs: { description: 'enforce something with trailing whitespace ' } },
+          meta: { docs: { description: 'Enforce something with trailing whitespace ' } },
           create(context) {}
         };
       `,
@@ -254,7 +254,7 @@ ruleTester.run('require-meta-docs-description', rule, {
       errors: [
         {
           message:
-            '`meta.docs.description` must match the regexp /^(enforce|require|disallow)/.',
+            '`meta.docs.description` must match the regexp /^(Enforce|Require|Disallow)/.',
           type: 'Literal',
         },
       ],
@@ -270,7 +270,7 @@ ruleTester.run('require-meta-docs-description', rule, {
       errors: [
         {
           message:
-            '`meta.docs.description` must match the regexp /^(enforce|require|disallow)/.',
+            '`meta.docs.description` must match the regexp /^(Enforce|Require|Disallow)/.',
           type: 'BinaryExpression',
         },
       ],
@@ -304,7 +304,7 @@ ruleTesterTypeScript.run('require-meta-docs-description (TypeScript)', rule, {
   valid: [
     `
       export default createESLintRule<Options, MessageIds>({
-        meta: { docs: { description: 'disallow unused variables' } },
+        meta: { docs: { description: 'Disallow unused variables' } },
         create(context) {}
       });
     `,
diff --git a/tests/lib/utils.ts b/tests/lib/utils.ts
