eslint 8.18.0 → 8.21.0

package/lib/rules/no-template-curly-in-string.js

@@ -14,7 +14,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow template literal placeholder syntax in regular strings",
+            description: "Disallow template literal placeholder syntax in regular strings",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-template-curly-in-string"
         },

package/lib/rules/no-ternary.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow ternary operators",
+            description: "Disallow ternary operators",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-ternary"
         },

package/lib/rules/no-this-before-super.js

@@ -40,7 +40,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow `this`/`super` before calling `super()` in constructors",
+            description: "Disallow `this`/`super` before calling `super()` in constructors",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-this-before-super"
         },

package/lib/rules/no-throw-literal.js

@@ -17,7 +17,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow throwing literals as exceptions",
+            description: "Disallow throwing literals as exceptions",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-throw-literal"
         },

package/lib/rules/no-trailing-spaces.js

@@ -20,7 +20,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "disallow trailing whitespace at the end of lines",
+            description: "Disallow trailing whitespace at the end of lines",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-trailing-spaces"
         },

package/lib/rules/no-undef-init.js

@@ -17,7 +17,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow initializing variables to `undefined`",
+            description: "Disallow initializing variables to `undefined`",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-undef-init"
         },

package/lib/rules/no-undef.js

@@ -29,7 +29,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow the use of undeclared variables unless mentioned in `/*global */` comments",
+            description: "Disallow the use of undeclared variables unless mentioned in `/*global */` comments",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-undef"
         },

package/lib/rules/no-undefined.js

@@ -14,7 +14,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow the use of `undefined` as an identifier",
+            description: "Disallow the use of `undefined` as an identifier",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-undefined"
         },

package/lib/rules/no-underscore-dangle.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow dangling underscores in identifiers",
+            description: "Disallow dangling underscores in identifiers",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-underscore-dangle"
         },

package/lib/rules/no-unexpected-multiline.js

@@ -20,7 +20,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow confusing multiline expressions",
+            description: "Disallow confusing multiline expressions",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-unexpected-multiline"
         },

package/lib/rules/no-unmodified-loop-condition.js

@@ -162,7 +162,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow unmodified loop conditions",
+            description: "Disallow unmodified loop conditions",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-unmodified-loop-condition"
         },

package/lib/rules/no-unneeded-ternary.js

@@ -29,7 +29,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow ternary operators when simpler alternatives exist",
+            description: "Disallow ternary operators when simpler alternatives exist",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-unneeded-ternary"
         },

package/lib/rules/no-unreachable-loop.js

@@ -59,7 +59,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow loops with a body that allows only one iteration",
+            description: "Disallow loops with a body that allows only one iteration",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-unreachable-loop"
         },

package/lib/rules/no-unreachable.js

@@ -111,7 +111,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow unreachable code after `return`, `throw`, `continue`, and `break` statements",
+            description: "Disallow unreachable code after `return`, `throw`, `continue`, and `break` statements",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-unreachable"
         },

package/lib/rules/no-unsafe-finally.js

@@ -24,7 +24,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow control flow statements in `finally` blocks",
+            description: "Disallow control flow statements in `finally` blocks",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-unsafe-finally"
         },

package/lib/rules/no-unsafe-negation.js

@@ -52,7 +52,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow negating the left operand of relational operators",
+            description: "Disallow negating the left operand of relational operators",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-unsafe-negation"
         },

package/lib/rules/no-unsafe-optional-chaining.js

@@ -24,7 +24,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow use of optional chaining in contexts where the `undefined` value is not allowed",
+            description: "Disallow use of optional chaining in contexts where the `undefined` value is not allowed",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-unsafe-optional-chaining"
         },

package/lib/rules/no-unused-expressions.js

@@ -30,7 +30,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow unused expressions",
+            description: "Disallow unused expressions",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-unused-expressions"
         },

package/lib/rules/no-unused-labels.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow unused labels",
+            description: "Disallow unused labels",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-unused-labels"
         },

package/lib/rules/no-unused-private-class-members.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow unused private class members",
+            description: "Disallow unused private class members",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-unused-private-class-members"
         },

package/lib/rules/no-unused-vars.js

@@ -33,7 +33,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow unused variables",
+            description: "Disallow unused variables",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-unused-vars"
         },

package/lib/rules/no-use-before-define.js

@@ -226,7 +226,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow the use of variables before they are defined",
+            description: "Disallow the use of variables before they are defined",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-use-before-define"
         },

package/lib/rules/no-useless-backreference.js

@@ -64,7 +64,7 @@ module.exports = {
         type: "problem",
 
         docs: {
-            description: "disallow useless backreferences in regular expressions",
+            description: "Disallow useless backreferences in regular expressions",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-useless-backreference"
         },

package/lib/rules/no-useless-call.js

@@ -55,7 +55,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow unnecessary calls to `.call()` and `.apply()`",
+            description: "Disallow unnecessary calls to `.call()` and `.apply()`",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-useless-call"
         },

package/lib/rules/no-useless-catch.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow unnecessary `catch` clauses",
+            description: "Disallow unnecessary `catch` clauses",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-useless-catch"
         },

package/lib/rules/no-useless-computed-key.js

@@ -91,7 +91,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow unnecessary computed property keys in objects and classes",
+            description: "Disallow unnecessary computed property keys in objects and classes",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-useless-computed-key"
         },

package/lib/rules/no-useless-concat.js

@@ -70,7 +70,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow unnecessary concatenation of literals or template literals",
+            description: "Disallow unnecessary concatenation of literals or template literals",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-useless-concat"
         },

package/lib/rules/no-useless-constructor.js

@@ -138,7 +138,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow unnecessary constructors",
+            description: "Disallow unnecessary constructors",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-useless-constructor"
         },

package/lib/rules/no-useless-escape.js

@@ -84,7 +84,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow unnecessary escape characters",
+            description: "Disallow unnecessary escape characters",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-useless-escape"
         },

package/lib/rules/no-useless-rename.js

@@ -21,7 +21,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow renaming import, export, and destructured assignments to the same name",
+            description: "Disallow renaming import, export, and destructured assignments to the same name",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-useless-rename"
         },

package/lib/rules/no-useless-return.js

@@ -67,7 +67,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow redundant return statements",
+            description: "Disallow redundant return statements",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-useless-return"
         },

package/lib/rules/no-var.js

@@ -185,7 +185,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require `let` or `const` instead of `var`",
+            description: "Require `let` or `const` instead of `var`",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-var"
         },

package/lib/rules/no-void.js

@@ -14,7 +14,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow `void` operators",
+            description: "Disallow `void` operators",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-void"
         },

package/lib/rules/no-warning-comments.js

@@ -20,7 +20,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow specified warning terms in comments",
+            description: "Disallow specified warning terms in comments",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-warning-comments"
         },
@@ -64,59 +64,45 @@ module.exports = {
          */
         function convertToRegExp(term) {
             const escaped = escapeRegExp(term);
-            const wordBoundary = "\\b";
-            const eitherOrWordBoundary = `|${wordBoundary}`;
-            let prefix;
 
             /*
-             * If the term ends in a word character (a-z0-9_), ensure a word
-             * boundary at the end, so that substrings do not get falsely
-             * matched. eg "todo" in a string such as "mastodon".
-             * If the term ends in a non-word character, then \b won't match on
-             * the boundary to the next non-word character, which would likely
-             * be a space. For example `/\bFIX!\b/.test('FIX! blah') === false`.
-             * In these cases, use no bounding match. Same applies for the
-             * prefix, handled below.
+             * When matching at the start, ignore leading whitespace, and
+             * there's no need to worry about word boundaries.
+             *
+             * These expressions for the prefix and suffix are designed as follows:
+             * ^   handles any terms at the beginning of a comment.
+             *     e.g. terms ["TODO"] matches `//TODO something`
+             * $   handles any terms at the end of a comment
+             *     e.g. terms ["TODO"] matches `// something TODO`
+             * \s* handles optional leading spaces (for "start" location only)
+             *     e.g. terms ["TODO"] matches `//    TODO something`
+             * \b  handles terms preceded/followed by word boundary
+             *     e.g. terms: ["!FIX", "FIX!"] matches `// FIX!something` or `// something!FIX`
+             *          terms: ["FIX"] matches `// FIX!` or `// !FIX`, but not `// fixed or affix`
              */
-            const suffix = /\w$/u.test(term) ? "\\b" : "";
+            const wordBoundary = "\\b";
 
-            if (location === "start") {
+            let prefix = "";
 
-                /*
-                 * When matching at the start, ignore leading whitespace, and
-                 * there's no need to worry about word boundaries.
-                 */
+            if (location === "start") {
                 prefix = "^\\s*";
             } else if (/^\w/u.test(term)) {
                 prefix = wordBoundary;
-            } else {
-                prefix = "";
             }
 
-            if (location === "start") {
-
-                /*
-                 * For location "start" the regex should be
-                 * ^\s*TERM\b.  This checks the word boundary
-                 * at the beginning of the comment.
-                 */
-                return new RegExp(prefix + escaped + suffix, "iu");
-            }
+            const suffix = /\w$/u.test(term) ? wordBoundary : "";
+            const flags = "iu"; // Case-insensitive with Unicode case folding.
 
             /*
-             * For location "anywhere" the regex should be
-             * \bTERM\b|\bTERM\b, this checks the entire comment
-             * for the term.
+             * For location "start", the typical regex is:
+             *   /^\s*ESCAPED_TERM\b/iu.
+             *
+             * For location "anywhere" the typical regex is
+             *   /\bESCAPED_TERM\b/iu
+             *
+             * If it starts or ends with non-word character, the prefix and suffix empty, respectively.
              */
-            return new RegExp(
-                prefix +
-                    escaped +
-                    suffix +
-                    eitherOrWordBoundary +
-                    term +
-                    wordBoundary,
-                "iu"
-            );
+            return new RegExp(`${prefix}${escaped}${suffix}`, flags);
         }
 
         const warningRegExps = warningTerms.map(convertToRegExp);

package/lib/rules/no-whitespace-before-property.js

@@ -20,7 +20,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "disallow whitespace before properties",
+            description: "Disallow whitespace before properties",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-whitespace-before-property"
         },

package/lib/rules/no-with.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow `with` statements",
+            description: "Disallow `with` statements",
             recommended: true,
             url: "https://eslint.org/docs/rules/no-with"
         },

package/lib/rules/nonblock-statement-body-position.js

@@ -16,7 +16,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce the location of single-line statements",
+            description: "Enforce the location of single-line statements",
             recommended: false,
             url: "https://eslint.org/docs/rules/nonblock-statement-body-position"
         },

package/lib/rules/object-curly-newline.js

@@ -150,7 +150,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent line breaks after opening and before closing braces",
+            description: "Enforce consistent line breaks after opening and before closing braces",
             recommended: false,
             url: "https://eslint.org/docs/rules/object-curly-newline"
         },

package/lib/rules/object-curly-spacing.js

@@ -16,7 +16,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent spacing inside braces",
+            description: "Enforce consistent spacing inside braces",
             recommended: false,
             url: "https://eslint.org/docs/rules/object-curly-spacing"
         },

package/lib/rules/object-property-newline.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce placing object properties on separate lines",
+            description: "Enforce placing object properties on separate lines",
             recommended: false,
             url: "https://eslint.org/docs/rules/object-property-newline"
         },

package/lib/rules/object-shorthand.js

@@ -28,7 +28,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require or disallow method and property shorthand syntax for object literals",
+            description: "Require or disallow method and property shorthand syntax for object literals",
             recommended: false,
             url: "https://eslint.org/docs/rules/object-shorthand"
         },

package/lib/rules/one-var-declaration-per-line.js

@@ -14,7 +14,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require or disallow newlines around variable declarations",
+            description: "Require or disallow newlines around variable declarations",
             recommended: false,
             url: "https://eslint.org/docs/rules/one-var-declaration-per-line"
         },

package/lib/rules/one-var.js

@@ -34,7 +34,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce variables to be declared either together or separately in functions",
+            description: "Enforce variables to be declared either together or separately in functions",
             recommended: false,
             url: "https://eslint.org/docs/rules/one-var"
         },

package/lib/rules/operator-assignment.js

@@ -63,7 +63,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require or disallow assignment operator shorthand where possible",
+            description: "Require or disallow assignment operator shorthand where possible",
             recommended: false,
             url: "https://eslint.org/docs/rules/operator-assignment"
         },

package/lib/rules/operator-linebreak.js

@@ -21,7 +21,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent linebreak style for operators",
+            description: "Enforce consistent linebreak style for operators",
             recommended: false,
             url: "https://eslint.org/docs/rules/operator-linebreak"
         },

package/lib/rules/padded-blocks.js

@@ -21,7 +21,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "require or disallow padding within blocks",
+            description: "Require or disallow padding within blocks",
             recommended: false,
             url: "https://eslint.org/docs/rules/padded-blocks"
         },

package/lib/rules/padding-line-between-statements.js

@@ -431,7 +431,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "require or disallow padding lines between statements",
+            description: "Require or disallow padding lines between statements",
             recommended: false,
             url: "https://eslint.org/docs/rules/padding-line-between-statements"
         },

package/lib/rules/prefer-arrow-callback.js

@@ -151,7 +151,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require using arrow functions for callbacks",
+            description: "Require using arrow functions for callbacks",
             recommended: false,
             url: "https://eslint.org/docs/rules/prefer-arrow-callback"
         },

package/lib/rules/prefer-const.js

@@ -332,7 +332,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require `const` declarations for variables that are never reassigned after declared",
+            description: "Require `const` declarations for variables that are never reassigned after declared",
             recommended: false,
             url: "https://eslint.org/docs/rules/prefer-const"
         },

package/lib/rules/prefer-destructuring.js

@@ -26,7 +26,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "require destructuring from arrays and/or objects",
+            description: "Require destructuring from arrays and/or objects",
             recommended: false,
             url: "https://eslint.org/docs/rules/prefer-destructuring"
         },

package/lib/rules/prefer-exponentiation-operator.js

@@ -90,7 +90,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "disallow the use of `Math.pow` in favor of the `**` operator",
+            description: "Disallow the use of `Math.pow` in favor of the `**` operator",
             recommended: false,
             url: "https://eslint.org/docs/rules/prefer-exponentiation-operator"
         },

package/lib/rules/prefer-named-capture-group.js

@@ -33,7 +33,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "enforce using named capture group in regular expression",
+            description: "Enforce using named capture group in regular expression",
             recommended: false,
             url: "https://eslint.org/docs/rules/prefer-named-capture-group"
         },