From 0e1e71dcb3e4ce60b563ab54e56cee48871314f9 Mon Sep 17 00:00:00 2001
From: Bryan Mishkin <698306+bmish@users.noreply.github.com>
Date: Fri, 11 Nov 2022 15:44:07 -0500
Subject: [PATCH] chore: enable `eslint-plugin/require-meta-docs-description`
 rule (#5969)

chore: enable eslint-plugin/require-meta-docs-description rule
---
 .eslintrc.js                                                 | 5 +++++
 .../src/rules/no-poorly-typed-ts-props.ts                    | 2 +-
 .../src/rules/no-typescript-default-import.ts                | 2 +-
 .../src/rules/no-typescript-estree-import.ts                 | 2 +-
 .../src/rules/plugin-test-formatting.ts                      | 2 +-
 .../src/rules/prefer-ast-types-enum.ts                       | 2 +-
 packages/eslint-plugin-tslint/src/rules/config.ts            | 2 +-
 7 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/.eslintrc.js b/.eslintrc.js
index da7ff36fd3b..6dfb0c35362 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -257,6 +257,11 @@ module.exports = {
         './packages/eslint-plugin/src/rules/**/*.ts',
       ],
       rules: {
+        'eslint-plugin/require-meta-docs-description': [
+          'error',
+          { pattern: '^(Enforce|Require|Disallow) .+[^. ]$' },
+        ],
+
         // specifically for rules - default exports makes the tooling easier
         'import/no-default-export': 'off',
       },
diff --git a/packages/eslint-plugin-internal/src/rules/no-poorly-typed-ts-props.ts b/packages/eslint-plugin-internal/src/rules/no-poorly-typed-ts-props.ts
index 6811c935bba..0c671d8432f 100644
--- a/packages/eslint-plugin-internal/src/rules/no-poorly-typed-ts-props.ts
+++ b/packages/eslint-plugin-internal/src/rules/no-poorly-typed-ts-props.ts
@@ -35,7 +35,7 @@ export default createRule({
     type: 'problem',
     docs: {
       description:
-        "Enforces rules don't use TS API properties with known bad type definitions",
+        "Enforce that rules don't use TS API properties with known bad type definitions",
       recommended: 'error',
       requiresTypeChecking: true,
     },
diff --git a/packages/eslint-plugin-internal/src/rules/no-typescript-default-import.ts b/packages/eslint-plugin-internal/src/rules/no-typescript-default-import.ts
index 34b911451e7..fd7279c3823 100644
--- a/packages/eslint-plugin-internal/src/rules/no-typescript-default-import.ts
+++ b/packages/eslint-plugin-internal/src/rules/no-typescript-default-import.ts
@@ -20,7 +20,7 @@ export default createRule({
     type: 'problem',
     docs: {
       description:
-        "Enforces that packages rules don't do `import ts from 'typescript';`",
+        "Enforce that packages rules don't do `import ts from 'typescript';`",
       recommended: 'error',
     },
     fixable: 'code',
diff --git a/packages/eslint-plugin-internal/src/rules/no-typescript-estree-import.ts b/packages/eslint-plugin-internal/src/rules/no-typescript-estree-import.ts
index 022fd98b7ca..28f7439472b 100644
--- a/packages/eslint-plugin-internal/src/rules/no-typescript-estree-import.ts
+++ b/packages/eslint-plugin-internal/src/rules/no-typescript-estree-import.ts
@@ -15,7 +15,7 @@ export default createRule({
   meta: {
     type: 'problem',
     docs: {
-      description: `Enforces that eslint-plugin rules don't require anything from ${TSESTREE_NAME} or ${TYPES_NAME}`,
+      description: `Enforce that eslint-plugin rules don't require anything from ${TSESTREE_NAME} or ${TYPES_NAME}`,
       recommended: 'error',
     },
     fixable: 'code',
diff --git a/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts b/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts
index 8cd85cce8e9..f86d4946836 100644
--- a/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts
+++ b/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts
@@ -107,7 +107,7 @@ export default createRule<Options, MessageIds>({
   meta: {
     type: 'problem',
     docs: {
-      description: `Enforces that eslint-plugin test snippets are correctly formatted`,
+      description: `Enforce that eslint-plugin test snippets are correctly formatted`,
       recommended: 'error',
       requiresTypeChecking: true,
     },
diff --git a/packages/eslint-plugin-internal/src/rules/prefer-ast-types-enum.ts b/packages/eslint-plugin-internal/src/rules/prefer-ast-types-enum.ts
index 4b74cbe09b9..4099e2f02be 100755
--- a/packages/eslint-plugin-internal/src/rules/prefer-ast-types-enum.ts
+++ b/packages/eslint-plugin-internal/src/rules/prefer-ast-types-enum.ts
@@ -15,7 +15,7 @@ export default createRule({
     docs: {
       recommended: 'error',
       description:
-        'Ensures consistent usage of `AST_NODE_TYPES`, `AST_TOKEN_TYPES` and `DefinitionType` enums.',
+        'Enforce consistent usage of `AST_NODE_TYPES`, `AST_TOKEN_TYPES` and `DefinitionType` enums',
     },
     messages: {
       preferEnum: 'Prefer {{ enumName }}.{{ literal }} over raw literal',
diff --git a/packages/eslint-plugin-tslint/src/rules/config.ts b/packages/eslint-plugin-tslint/src/rules/config.ts
index 5f20bcd4430..9fcfa844da1 100644
--- a/packages/eslint-plugin-tslint/src/rules/config.ts
+++ b/packages/eslint-plugin-tslint/src/rules/config.ts
@@ -64,7 +64,7 @@ export default createRule<Options, MessageIds>({
   meta: {
     docs: {
       description:
-        'Wraps a TSLint configuration and lints the whole source using TSLint',
+        'Wraps a TSLint configuration and lints the whole source using TSLint', // eslint-disable-line eslint-plugin/require-meta-docs-description
       recommended: false,
     },
     fixable: 'code',