chore: stricter validation of meta.docs.description in core rules (#16529)

mdjermanovic · bmish · web-flow · commit e13f194f89f5 · 2022-11-10T10:13:36.000-05:00
Co-authored-by: Bryan Mishkin &lt;698306+bmish@users.noreply.github.com&gt;
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -101,7 +101,7 @@ module.exports = {
                 "eslint-plugin/prefer-placeholders": "error",
                 "eslint-plugin/prefer-replace-text": "error",
                 "eslint-plugin/report-message-format": ["error", "[^a-z].*\\.$"],
-                "eslint-plugin/require-meta-docs-description": ["error", { pattern: "^(Enforce|Require|Disallow)" }],
+                "eslint-plugin/require-meta-docs-description": ["error", { pattern: "^(Enforce|Require|Disallow) .+[^. ]$" }],
                 "internal-rules/no-invalid-meta": "error"
             }
         },
diff --git a/eslint.config.js b/eslint.config.js
@@ -134,7 +134,7 @@ module.exports = [
             "eslint-plugin/prefer-placeholders": "error",
             "eslint-plugin/prefer-replace-text": "error",
             "eslint-plugin/report-message-format": ["error", "[^a-z].*\\.$"],
-            "eslint-plugin/require-meta-docs-description": ["error", { pattern: "^(Enforce|Require|Disallow)" }],
+            "eslint-plugin/require-meta-docs-description": ["error", { pattern: "^(Enforce|Require|Disallow) .+[^. ]$" }],
             "internal-rules/no-invalid-meta": "error"
         }
     },
diff --git a/lib/rules/for-direction.js b/lib/rules/for-direction.js
@@ -15,7 +15,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "Enforce \"for\" loop update clause moving the counter in the right direction.",
+            description: "Enforce \"for\" loop update clause moving the counter in the right direction",
             recommended: true,
             url: "https://eslint.org/docs/rules/for-direction"
         },
diff --git a/lib/rules/prefer-object-spread.js b/lib/rules/prefer-object-spread.js
@@ -247,7 +247,7 @@ module.exports = {
 
         docs: {
             description:
-                "Disallow using Object.assign with an object literal as the first argument and prefer the use of object spread instead.",
+                "Disallow using Object.assign with an object literal as the first argument and prefer the use of object spread instead",
             recommended: false,
             url: "https://eslint.org/docs/rules/prefer-object-spread"
         },

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ module.exports = {`
`101`	`101`	`"eslint-plugin/prefer-placeholders": "error",`
`102`	`102`	`"eslint-plugin/prefer-replace-text": "error",`
`103`	`103`	`"eslint-plugin/report-message-format": ["error", "[^a-z].*\\.$"],`
`104`		`- "eslint-plugin/require-meta-docs-description": ["error", { pattern: "^(Enforce\|Require\|Disallow)" }],`
	`104`	`+ "eslint-plugin/require-meta-docs-description": ["error", { pattern: "^(Enforce\|Require\|Disallow) .+[^. ]$" }],`
`105`	`105`	`"internal-rules/no-invalid-meta": "error"`
`106`	`106`	`}`
`107`	`107`	`},`
Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ module.exports = [`
`134`	`134`	`"eslint-plugin/prefer-placeholders": "error",`
`135`	`135`	`"eslint-plugin/prefer-replace-text": "error",`
`136`	`136`	`"eslint-plugin/report-message-format": ["error", "[^a-z].*\\.$"],`
`137`		`- "eslint-plugin/require-meta-docs-description": ["error", { pattern: "^(Enforce\|Require\|Disallow)" }],`
	`137`	`+ "eslint-plugin/require-meta-docs-description": ["error", { pattern: "^(Enforce\|Require\|Disallow) .+[^. ]$" }],`
`138`	`138`	`"internal-rules/no-invalid-meta": "error"`
`139`	`139`	`}`
`140`	`140`	`},`