docs: Remove duplicate rule descriptions (#16052)

* chore: remove hardcoded markdown desc * chore: capitalize rule description * chore: capitalize rule description * chore: removed unwanted changes * docs: restore description in removed rules
eslint · Jun 30, 2022 · 3ae0574 · 3ae0574
1 parent b6aee95
commit 3ae0574
Show file tree

Hide file tree

Showing 576 changed files with 832 additions and 1,280 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -82,7 +82,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",
+                "eslint-plugin/require-meta-docs-description": ["error", { pattern: "^(Enforce|Require|Disallow)" }],
                 "internal-rules/no-invalid-meta": "error"
             }
         },

diff --git a/docs/src/_data/rules.json b/docs/src/_data/rules.json
diff --git a/docs/src/_data/rules_meta.json b/docs/src/_data/rules_meta.json
diff --git a/docs/src/rules/accessor-pairs.md b/docs/src/rules/accessor-pairs.md
@@ -12,7 +12,6 @@ further_reading:
 - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Working_with_Objects
 ---
 
-Enforces getter/setter pairs in objects and classes.
 
 It's a common mistake in JavaScript to create an object with just a setter for a property but never have a corresponding getter defined for it. Without a getter, you cannot read the property, so it ends up not being used.
 

diff --git a/docs/src/rules/array-bracket-newline.md b/docs/src/rules/array-bracket-newline.md
@@ -9,8 +9,6 @@ related_rules:
 
 
 
-Enforces line breaks after opening and before closing array brackets.
-
 A number of style guides require or disallow line breaks inside of array brackets.
 
 ## Rule Details

diff --git a/docs/src/rules/array-bracket-spacing.md b/docs/src/rules/array-bracket-spacing.md
@@ -11,8 +11,6 @@ related_rules:
 
 
 
-Disallows or enforce spaces inside of brackets.
-
 A number of style guides require or disallow spaces between array brackets and other tokens. This rule
 applies to both array literals and destructuring assignments (ECMAScript 6).
 

diff --git a/docs/src/rules/array-callback-return.md b/docs/src/rules/array-callback-return.md
@@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/array-callb
 rule_type: problem
 ---
 
-Enforces return statements in callbacks of array's methods.
 
 `Array` has several methods for filtering, mapping, and folding.
 If we forget to write `return` statement in a callback of those, it's probably a mistake. If you don't want to use a return or don't need the returned results, consider using [.forEach](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach) instead.

diff --git a/docs/src/rules/array-element-newline.md b/docs/src/rules/array-element-newline.md
@@ -16,8 +16,6 @@ related_rules:
 
 
 
-Enforces line breaks between array elements.
-
 A number of style guides require or disallow line breaks between array elements.
 
 ## Rule Details

diff --git a/docs/src/rules/arrow-parens.md b/docs/src/rules/arrow-parens.md
@@ -9,8 +9,6 @@ further_reading:
 
 
 
-Requires parens in arrow function arguments.
-
 Arrow functions can omit parentheses when they have exactly one parameter. In all other cases the parameter(s) must
 be wrapped in parentheses. This rule enforces the consistent use of parentheses in arrow functions.
 

diff --git a/docs/src/rules/arrow-spacing.md b/docs/src/rules/arrow-spacing.md
@@ -7,8 +7,6 @@ rule_type: layout
 
 
 
-Requires space before/after arrow function's arrow.
-
 This rule normalize style of spacing before/after an arrow function's arrow(`=>`).
 
 ```js

diff --git a/docs/src/rules/block-scoped-var.md b/docs/src/rules/block-scoped-var.md
@@ -8,7 +8,6 @@ further_reading:
 - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/var#var_hoisting
 ---
 
-Enforces treating `var` as block scoped.
 
 The `block-scoped-var` rule generates warnings when variables are used outside of the block in which they were defined. This emulates C-style block scope.
 

diff --git a/docs/src/rules/block-spacing.md b/docs/src/rules/block-spacing.md
@@ -10,8 +10,6 @@ related_rules:
 
 
 
-Disallows or enforces spaces inside of blocks after opening blocks and before closing blocks.
-
 ## Rule Details
 
 This rule enforces consistent spacing inside an open block token and the next token on the same line. This rule also enforces consistent spacing inside a close block token and previous token on the same line.

diff --git a/docs/src/rules/brace-style.md b/docs/src/rules/brace-style.md
@@ -12,8 +12,6 @@ further_reading:
 
 
 
-Enforces consistent brace style for blocks.
-
 Brace style is closely related to [indent style](https://en.wikipedia.org/wiki/Indent_style) in programming and describes the placement of braces relative to their control statement and body. There are probably a dozen, if not more, brace styles in the world.
 
 The *one true brace style* is one of the most common brace styles in JavaScript, in which the opening brace of a block is placed on the same line as its corresponding statement or declaration. For example:

diff --git a/docs/src/rules/callback-return.md b/docs/src/rules/callback-return.md
@@ -10,7 +10,6 @@ further_reading:
 - https://web.archive.org/web/20171224042620/https://docs.nodejitsu.com/articles/errors/what-are-the-error-conventions/
 ---
 
-Enforces return after callback.
 
 This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node).
 

diff --git a/docs/src/rules/camelcase.md b/docs/src/rules/camelcase.md
@@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/camelcase.m
 rule_type: suggestion
 ---
 
-Enforces camelcase naming convention.
 
 When it comes to naming variables, style guides generally fall into one of two camps: camelcase (`variableName`) and underscores (`variable_name`). This rule focuses on using the camelcase approach. If your style guide calls for camelCasing your variable names, then this rule is for you!
 

diff --git a/docs/src/rules/capitalized-comments.md b/docs/src/rules/capitalized-comments.md
@@ -7,8 +7,6 @@ rule_type: suggestion
 
 
 
-Enforces or disallows capitalization of the first letter of a comment.
-
 Comments are useful for leaving information for future developers. In order for that information to be useful and not distracting, it is sometimes desirable for comments to follow a particular style. One element of comment formatting styles is whether the first word of a comment should be capitalized or lowercase.
 
 In general, no comment style is any more or less valid than any others, but many developers would agree that a consistent style can improve a project's maintainability.

diff --git a/docs/src/rules/class-methods-use-this.md b/docs/src/rules/class-methods-use-this.md
@@ -8,7 +8,6 @@ further_reading:
 - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/static
 ---
 
-Enforces that class methods utilize `this`.
 
 If a class method does not use `this`, it can *sometimes* be made into a static function. If you do convert the method into a static function, instances of the class that call that particular method have to be converted to a static call as well (`MyClass.callStaticMethod()`)
 

diff --git a/docs/src/rules/comma-dangle.md b/docs/src/rules/comma-dangle.md
@@ -7,8 +7,6 @@ rule_type: layout
 
 
 
-Requires or disallows trailing commas.
-
 Trailing commas in object literals are valid according to the ECMAScript 5 (and ECMAScript 3!) spec. However, IE8 (when not in IE8 document mode) and below will throw an error when it encounters trailing commas in JavaScript.
 
 ```js

diff --git a/docs/src/rules/comma-spacing.md b/docs/src/rules/comma-spacing.md
@@ -19,8 +19,6 @@ further_reading:
 
 
 
-Enforces spacing around commas.
-
 Spacing around commas improves readability of a list of items. Although most of the style guidelines for languages prescribe adding a space after a comma and not before it, it is subjective to the preferences of a project.
 
 ```js

diff --git a/docs/src/rules/comma-style.md b/docs/src/rules/comma-style.md
@@ -11,8 +11,6 @@ further_reading:
 
 
 
-Enforces consistent comma styles.
-
 The Comma Style rule enforces styles for comma-separated lists. There are two comma styles primarily used in JavaScript:
 
 * The standard style, in which commas are placed at the end of the current line

diff --git a/docs/src/rules/complexity.md b/docs/src/rules/complexity.md
@@ -19,7 +19,6 @@ further_reading:
 - https://github.com/eslint/eslint/issues/4808#issuecomment-167795140
 ---
 
-Enforces a maximum cyclomatic complexity.
 
 Cyclomatic complexity measures the number of linearly independent paths through a program's source code. This rule allows setting a cyclomatic complexity threshold.
 

diff --git a/docs/src/rules/computed-property-spacing.md b/docs/src/rules/computed-property-spacing.md
@@ -11,8 +11,6 @@ related_rules:
 
 
 
-Disallows or enforces spaces inside of computed properties.
-
 While formatting preferences are very personal, a number of style guides require
 or disallow spaces between computed properties in the following situations:
 

diff --git a/docs/src/rules/consistent-return.md b/docs/src/rules/consistent-return.md
@@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/consistent-
 rule_type: suggestion
 ---
 
-Requires `return` statements to either always or never specify values.
 
 Unlike statically-typed languages which enforce that a function returns a specified type of value, JavaScript allows different code paths in a function to return different types of values.
 

diff --git a/docs/src/rules/consistent-this.md b/docs/src/rules/consistent-this.md
@@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/consistent-
 rule_type: suggestion
 ---
 
-Enforces consistent naming when capturing the current execution context.
 
 It is often necessary to capture the current execution context in order to make it available subsequently. A prominent example of this are jQuery callbacks:
 

diff --git a/docs/src/rules/curly.md b/docs/src/rules/curly.md
@@ -7,8 +7,6 @@ rule_type: suggestion
 
 
 
-Requires following curly brace conventions.
-
 JavaScript allows the omission of curly braces when a block contains only one statement. However, it is considered by many to be best practice to _never_ omit curly braces around blocks, even when they are optional, because it can lead to bugs and reduces code clarity. So the following:
 
 ```js

diff --git a/docs/src/rules/default-case-last.md b/docs/src/rules/default-case-last.md
@@ -9,7 +9,6 @@ further_reading:
 - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/switch
 ---
 
-Enforces default clauses in switch statements to be last.
 
 A `switch` statement can optionally have a `default` clause.
 

diff --git a/docs/src/rules/default-case.md b/docs/src/rules/default-case.md
@@ -7,7 +7,6 @@ related_rules:
 - no-fallthrough
 ---
 
-Requires a `default` case in switch statements.
 
 Some code conventions require that all `switch` statements have a `default` case, even if the default case is empty, such as:
 

diff --git a/docs/src/rules/default-param-last.md b/docs/src/rules/default-param-last.md
@@ -5,8 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/default-par
 rule_type: suggestion
 ---
 
-Enforces default parameters to be last.
-
 Putting default parameter at last allows function calls to omit optional tail arguments.
 
 ```js

diff --git a/docs/src/rules/dot-location.md b/docs/src/rules/dot-location.md
@@ -10,8 +10,6 @@ related_rules:
 
 
 
-Enforces newline before and after dots.
-
 JavaScript allows you to place newlines before or after a dot in a member expression.
 
 Consistency in placing a newline before or after the dot can greatly increase readability.

diff --git a/docs/src/rules/dot-notation.md b/docs/src/rules/dot-notation.md
@@ -7,8 +7,6 @@ rule_type: suggestion
 
 
 
-Enforces dot notation whenever possible.
-
 In JavaScript, one can access properties using the dot notation (`foo.bar`) or square-bracket notation (`foo["bar"]`). However, the dot notation is often preferred because it is easier to read, less verbose, and works better with aggressive JavaScript minimizers.
 
 ```js

diff --git a/docs/src/rules/eol-last.md b/docs/src/rules/eol-last.md
@@ -7,8 +7,6 @@ rule_type: layout
 
 
 
-Requires or disallows newline at the end of files.
-
 Trailing newlines in non-empty files are a common UNIX idiom. Benefits of
 trailing newlines include the ability to concatenate or append to files as well
 as output files to the terminal without interfering with shell prompts.

diff --git a/docs/src/rules/eqeqeq.md b/docs/src/rules/eqeqeq.md
@@ -7,8 +7,6 @@ rule_type: suggestion
 
 
 
-Requires the use of `===` and `!==`.
-
 It is considered good practice to use the type-safe equality operators `===` and `!==` instead of their regular counterparts `==` and `!=`.
 
 The reason for this is that `==` and `!=` do type coercion which follows the rather obscure [Abstract Equality Comparison Algorithm](https://www.ecma-international.org/ecma-262/5.1/#sec-11.9.3).

diff --git a/docs/src/rules/for-direction.md b/docs/src/rules/for-direction.md
@@ -7,8 +7,6 @@ rule_type: problem
 
 
 
-Enforces `for` loop update clause moving the counter in the right direction.
-
 ## Rule Details
 
 A `for` loop with a stop condition that can never be reached, such as one with a counter that moves in the wrong direction, will run infinitely. While there are occasions when an infinite loop is intended, the convention is to construct such loops as `while` loops. More typically, an infinite for loop is a bug.

diff --git a/docs/src/rules/func-call-spacing.md b/docs/src/rules/func-call-spacing.md
@@ -9,8 +9,6 @@ related_rules:
 
 
 
-Requires or disallows spacing between function identifiers and their invocations.
-
 When calling a function, developers may insert optional whitespace between the function's name and the parentheses that invoke it. The following pairs of function calls are equivalent:
 
 ```js

diff --git a/docs/src/rules/func-name-matching.md b/docs/src/rules/func-name-matching.md
@@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/func-name-m
 rule_type: suggestion
 ---
 
-Requires function names to match the name of the variable or property to which they are assigned.
 
 ## Rule Details
 

diff --git a/docs/src/rules/func-names.md b/docs/src/rules/func-names.md
@@ -8,7 +8,6 @@ further_reading:
 - https://2ality.com/2015/09/function-names-es6.html
 ---
 
-Requires or disallows named `function` expressions.
 
 A pattern that's becoming more common is to give function expressions names to aid in debugging. For example:
 

diff --git a/docs/src/rules/func-style.md b/docs/src/rules/func-style.md
@@ -7,7 +7,6 @@ further_reading:
 - https://www.adequatelygood.com/JavaScript-Scoping-and-Hoisting.html
 ---
 
-Enforces the consistent use of either `function` declarations or expressions.
 
 There are two ways of defining functions in JavaScript: `function` declarations and `function` expressions. Declarations contain the `function` keyword first, followed by a name and then its arguments and the function body, for example:
 

diff --git a/docs/src/rules/function-call-argument-newline.md b/docs/src/rules/function-call-argument-newline.md
@@ -12,8 +12,6 @@ related_rules:
 
 
 
-Enforces line breaks between arguments of a function call.
-
 A number of style guides require or disallow line breaks between arguments of a function call.
 
 ## Rule Details

diff --git a/docs/src/rules/function-paren-newline.md b/docs/src/rules/function-paren-newline.md
@@ -7,8 +7,6 @@ rule_type: layout
 
 
 
-Enforces consistent line breaks inside function parentheses.
-
 Many style guides require or disallow newlines inside of function parentheses.
 
 ## Rule Details

diff --git a/docs/src/rules/generator-star-spacing.md b/docs/src/rules/generator-star-spacing.md
@@ -9,8 +9,6 @@ further_reading:
 
 
 
-Enforces spacing around the `*` in generator functions.
-
 Generators are a new type of function in ECMAScript 6 that can return multiple values over time.
 These special functions are indicated by placing an `*` after the `function` keyword.
 

diff --git a/docs/src/rules/getter-return.md b/docs/src/rules/getter-return.md
@@ -10,8 +10,6 @@ further_reading:
 
 
 
-Enforces that a `return` statement is present in property getters.
-
 The get syntax binds an object property to a function that will be called when that property is looked up. It was first introduced in ECMAScript 5:
 
 ```js

diff --git a/docs/src/rules/global-require.md b/docs/src/rules/global-require.md
@@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/global-requ
 rule_type: suggestion
 ---
 
-Enforces `require()` on the top-level module scope.
 
 This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node).
 

diff --git a/docs/src/rules/grouped-accessor-pairs.md b/docs/src/rules/grouped-accessor-pairs.md
@@ -13,7 +13,6 @@ further_reading:
 - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
 ---
 
-Requires grouped accessor pairs in object literals and classes.
 
 A getter and setter for the same property don't necessarily have to be defined adjacent to each other.
 

diff --git a/docs/src/rules/guard-for-in.md b/docs/src/rules/guard-for-in.md
@@ -10,7 +10,6 @@ further_reading:
 - https://2ality.com/2012/01/objects-as-maps.html
 ---
 
-Requires `for in` loops to include an `if` statement.
 
 Looping over objects with a `for in` loop will include properties that are inherited through the prototype chain. This behavior can lead to unexpected items in your for loop.
 

diff --git a/docs/src/rules/handle-callback-err.md b/docs/src/rules/handle-callback-err.md
@@ -8,7 +8,6 @@ further_reading:
 - https://web.archive.org/web/20171224042620/https://docs.nodejitsu.com/articles/errors/what-are-the-error-conventions/
 ---
 
-Enforces callback error handling.
 
 This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node).
 

diff --git a/docs/src/rules/id-blacklist.md b/docs/src/rules/id-blacklist.md
@@ -5,6 +5,5 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/id-blacklis
 rule_type: suggestion
 ---
 
-Disallows specified identifiers.
 
 This rule was **deprecated** in ESLint v7.5.0 and replaced by the [id-denylist](id-denylist) rule.
diff --git a/docs/src/rules/id-denylist.md b/docs/src/rules/id-denylist.md
@@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/id-denylist
 rule_type: suggestion
 ---
 
-Disallows specified identifiers.
 
 > "There are only two hard things in Computer Science: cache invalidation and naming things." — Phil Karlton
 

diff --git a/docs/src/rules/id-length.md b/docs/src/rules/id-length.md
@@ -10,7 +10,6 @@ related_rules:
 - camelcase
 ---
 
-Enforces minimum and maximum identifier lengths.
 
 Very short identifier names like `e`, `x`, `_t` or very long ones like `hashGeneratorResultOutputContainerObject` can make code harder to read and potentially less maintainable. To prevent this, one may enforce a minimum and/or maximum identifier length.
 

diff --git a/docs/src/rules/id-match.md b/docs/src/rules/id-match.md
@@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/id-match.md
 rule_type: suggestion
 ---
 
-Requires identifiers to match a specified regular expression.
 
 > "There are only two hard things in Computer Science: cache invalidation and naming things." — Phil Karlton