eslint 8.34.0 → 8.39.0

package/lib/rules/id-denylist.js

@@ -121,6 +121,7 @@ module.exports = {
 
         const denyList = new Set(context.options);
         const reportedNodes = new Set();
+        const sourceCode = context.getSourceCode();
 
         let globalScope;
 
@@ -210,8 +211,8 @@ module.exports = {
 
         return {
 
-            Program() {
-                globalScope = context.getScope();
+            Program(node) {
+                globalScope = sourceCode.getScope(node);
             },
 
             [[

package/lib/rules/id-match.js

@@ -67,6 +67,7 @@ module.exports = {
             onlyDeclarations = !!options.onlyDeclarations,
             ignoreDestructuring = !!options.ignoreDestructuring;
 
+        const sourceCode = context.getSourceCode();
         let globalScope;
 
         //--------------------------------------------------------------------------
@@ -170,8 +171,8 @@ module.exports = {
 
         return {
 
-            Program() {
-                globalScope = context.getScope();
+            Program(node) {
+                globalScope = sourceCode.getScope(node);
             },
 
             Identifier(node) {

package/lib/rules/lines-around-comment.js

@@ -113,6 +113,10 @@ module.exports = {
                     },
                     applyDefaultIgnorePatterns: {
                         type: "boolean"
+                    },
+                    afterHashbangComment: {
+                        type: "boolean",
+                        default: false
                     }
                 },
                 additionalProperties: false
@@ -449,6 +453,13 @@ module.exports = {
                                 before: options.beforeBlockComment
                             });
                         }
+                    } else if (token.type === "Shebang") {
+                        if (options.afterHashbangComment) {
+                            checkForEmptyLine(token, {
+                                after: options.afterHashbangComment,
+                                before: false
+                            });
+                        }
                     }
                 });
             }

package/lib/rules/logical-assignment-operators.js

@@ -112,7 +112,7 @@ function isBooleanCast(expression, scope) {
 /**
  * Returns true for:
  * truthiness checks:  value, Boolean(value), !!value
- * falsyness checks:   !value, !Boolean(value)
+ * falsiness checks:   !value, !Boolean(value)
  * nullish checks:     value == null, value === undefined || value === null
  * @param {ASTNode} expression Test condition
  * @param {import('eslint-scope').Scope} scope Scope of the expression
@@ -159,7 +159,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "Require or disallow logical assignment logical operator shorthand",
+            description: "Require or disallow logical assignment operator shorthand",
             recommended: false,
             url: "https://eslint.org/docs/rules/logical-assignment-operators"
         },
@@ -206,7 +206,7 @@ module.exports = {
         const mode = context.options[0] === "never" ? "never" : "always";
         const checkIf = mode === "always" && context.options.length > 1 && context.options[1].enforceForIfStatements;
         const sourceCode = context.getSourceCode();
-        const isStrict = context.getScope().isStrict;
+        const isStrict = sourceCode.getScope(sourceCode.ast).isStrict;
 
         /**
          * Returns false if the access could be a getter
@@ -409,7 +409,7 @@ module.exports = {
                 }
 
                 const body = hasBody ? ifNode.consequent.body[0] : ifNode.consequent;
-                const scope = context.getScope();
+                const scope = sourceCode.getScope(ifNode);
                 const existence = getExistence(ifNode.test, scope);
 
                 if (

package/lib/rules/multiline-comment-style.js

@@ -22,7 +22,37 @@ module.exports = {
         },
 
         fixable: "whitespace",
-        schema: [{ enum: ["starred-block", "separate-lines", "bare-block"] }],
+        schema: {
+            anyOf: [
+                {
+                    type: "array",
+                    items: [
+                        {
+                            enum: ["starred-block", "bare-block"]
+                        }
+                    ],
+                    additionalItems: false
+                },
+                {
+                    type: "array",
+                    items: [
+                        {
+                            enum: ["separate-lines"]
+                        },
+                        {
+                            type: "object",
+                            properties: {
+                                checkJSDoc: {
+                                    type: "boolean"
+                                }
+                            },
+                            additionalProperties: false
+                        }
+                    ],
+                    additionalItems: false
+                }
+            ]
+        },
         messages: {
             expectedBlock: "Expected a block comment instead of consecutive line comments.",
             expectedBareBlock: "Expected a block comment without padding stars.",
@@ -37,6 +67,8 @@ module.exports = {
     create(context) {
         const sourceCode = context.getSourceCode();
         const option = context.options[0] || "starred-block";
+        const params = context.options[1] || {};
+        const checkJSDoc = !!params.checkJSDoc;
 
         //----------------------------------------------------------------------
         // Helpers
@@ -333,11 +365,18 @@ module.exports = {
             "separate-lines"(commentGroup) {
                 const [firstComment] = commentGroup;
 
-                if (firstComment.type !== "Block" || isJSDocComment(commentGroup)) {
+                const isJSDoc = isJSDocComment(commentGroup);
+
+                if (firstComment.type !== "Block" || (!checkJSDoc && isJSDoc)) {
                     return;
                 }
 
-                const commentLines = getCommentLines(commentGroup);
+                let commentLines = getCommentLines(commentGroup);
+
+                if (isJSDoc) {
+                    commentLines = commentLines.slice(1, commentLines.length - 1);
+                }
+
                 const tokenAfter = sourceCode.getTokenAfter(firstComment, { includeComments: true });
 
                 if (tokenAfter && firstComment.loc.end.line === tokenAfter.loc.start.line) {

package/lib/rules/new-parens.js

@@ -31,20 +31,11 @@ module.exports = {
         },
 
         fixable: "code",
-        schema: {
-            anyOf: [
-                {
-                    type: "array",
-                    items: [
-                        {
-                            enum: ["always", "never"]
-                        }
-                    ],
-                    minItems: 0,
-                    maxItems: 1
-                }
-            ]
-        },
+        schema: [
+            {
+                enum: ["always", "never"]
+            }
+        ],
         messages: {
             missing: "Missing '()' invoking a constructor.",
             unnecessary: "Unnecessary '()' invoking a constructor with no arguments."

package/lib/rules/no-alert.js

@@ -101,10 +101,12 @@ module.exports = {
     },
 
     create(context) {
+        const sourceCode = context.getSourceCode();
+
         return {
             CallExpression(node) {
                 const callee = skipChainExpression(node.callee),
-                    currentScope = context.getScope();
+                    currentScope = sourceCode.getScope(node);
 
                 // without window.
                 if (callee.type === "Identifier") {

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

@@ -39,6 +39,8 @@ module.exports = {
 
     create(context) {
 
+        const sourceCode = context.getSourceCode();
+
         //--------------------------------------------------------------------------
         // Helpers
         //--------------------------------------------------------------------------
@@ -60,7 +62,7 @@ module.exports = {
         return {
 
             "CatchClause[param!=null]"(node) {
-                let scope = context.getScope();
+                let scope = sourceCode.getScope(node);
 
                 /*
                  * When ecmaVersion >= 6, CatchClause creates its own scope

package/lib/rules/no-class-assign.js

@@ -31,6 +31,8 @@ module.exports = {
 
     create(context) {
 
+        const sourceCode = context.getSourceCode();
+
         /**
          * Finds and reports references that are non initializer and writable.
          * @param {Variable} variable A variable to check.
@@ -49,7 +51,7 @@ module.exports = {
          * @returns {void}
          */
         function checkForClass(node) {
-            context.getDeclaredVariables(node).forEach(checkVariable);
+            sourceCode.getDeclaredVariables(node).forEach(checkVariable);
         }
 
         return {

package/lib/rules/no-console.js

@@ -51,6 +51,7 @@ module.exports = {
     create(context) {
         const options = context.options[0] || {};
         const allowed = options.allow || [];
+        const sourceCode = context.getSourceCode();
 
         /**
          * Checks whether the given reference is 'console' or not.
@@ -109,8 +110,8 @@ module.exports = {
         }
 
         return {
-            "Program:exit"() {
-                const scope = context.getScope();
+            "Program:exit"(node) {
+                const scope = sourceCode.getScope(node);
                 const consoleVar = astUtils.getVariableByName(scope, "console");
                 const shadowed = consoleVar && consoleVar.defs.length > 0;
 

package/lib/rules/no-const-assign.js

@@ -31,6 +31,8 @@ module.exports = {
 
     create(context) {
 
+        const sourceCode = context.getSourceCode();
+
         /**
          * Finds and reports references that are non initializer and writable.
          * @param {Variable} variable A variable to check.
@@ -45,7 +47,7 @@ module.exports = {
         return {
             VariableDeclaration(node) {
                 if (node.kind === "const") {
-                    context.getDeclaredVariables(node).forEach(checkVariable);
+                    sourceCode.getDeclaredVariables(node).forEach(checkVariable);
                 }
             }
         };

package/lib/rules/no-constant-binary-expression.js

@@ -14,6 +14,23 @@ const NUMERIC_OR_STRING_BINARY_OPERATORS = new Set(["+", "-", "*", "/", "%", "|"
 // Helpers
 //------------------------------------------------------------------------------
 
+/**
+ * Checks whether or not a node is `null` or `undefined`. Similar to the one
+ * found in ast-utils.js, but this one correctly handles the edge case that
+ * `undefined` has been redefined.
+ * @param {Scope} scope Scope in which the expression was found.
+ * @param {ASTNode} node A node to check.
+ * @returns {boolean} Whether or not the node is a `null` or `undefined`.
+ * @public
+ */
+function isNullOrUndefined(scope, node) {
+    return (
+        isNullLiteral(node) ||
+        (node.type === "Identifier" && node.name === "undefined" && isReferenceToGlobalVariable(scope, node)) ||
+        (node.type === "UnaryExpression" && node.operator === "void")
+    );
+}
+
 /**
  * Test if an AST node has a statically knowable constant nullishness. Meaning,
  * it will always resolve to a constant value of either: `null`, `undefined`
@@ -21,9 +38,14 @@ const NUMERIC_OR_STRING_BINARY_OPERATORS = new Set(["+", "-", "*", "/", "%", "|"
  * three states at runtime would return `false`.
  * @param {Scope} scope The scope in which the node was found.
  * @param {ASTNode} node The AST node being tested.
+ * @param {boolean} nonNullish if `true` then nullish values are not considered constant.
  * @returns {boolean} Does `node` have constant nullishness?
  */
-function hasConstantNullishness(scope, node) {
+function hasConstantNullishness(scope, node, nonNullish) {
+    if (nonNullish && isNullOrUndefined(scope, node)) {
+        return false;
+    }
+
     switch (node.type) {
         case "ObjectExpression": // Objects are never nullish
         case "ArrayExpression": // Arrays are never nullish
@@ -45,9 +67,12 @@ function hasConstantNullishness(scope, node) {
             return (functionName === "Boolean" || functionName === "String" || functionName === "Number") &&
                 isReferenceToGlobalVariable(scope, node.callee);
         }
+        case "LogicalExpression": {
+            return node.operator === "??" && hasConstantNullishness(scope, node.right, true);
+        }
         case "AssignmentExpression":
             if (node.operator === "=") {
-                return hasConstantNullishness(scope, node.right);
+                return hasConstantNullishness(scope, node.right, nonNullish);
             }
 
             /*
@@ -80,7 +105,7 @@ function hasConstantNullishness(scope, node) {
         case "SequenceExpression": {
             const last = node.expressions[node.expressions.length - 1];
 
-            return hasConstantNullishness(scope, last);
+            return hasConstantNullishness(scope, last, nonNullish);
         }
         case "Identifier":
             return node.name === "undefined" && isReferenceToGlobalVariable(scope, node);
@@ -348,7 +373,7 @@ function isAlwaysNew(scope, node) {
              * user-defined constructors could return a sentinel
              * object.
              *
-             * Catching these is especially useful for primitive constructures
+             * Catching these is especially useful for primitive constructors
              * which return boxed values, a surprising gotcha' in JavaScript.
              */
             return Object.hasOwnProperty.call(globals.builtin, node.callee.name) &&
@@ -378,24 +403,6 @@ function isAlwaysNew(scope, node) {
     }
 }
 
-/**
- * Checks whether or not a node is `null` or `undefined`. Similar to the one
- * found in ast-utils.js, but this one correctly handles the edge case that
- * `undefined` has been redefined.
- * @param {Scope} scope Scope in which the expression was found.
- * @param {ASTNode} node A node to check.
- * @returns {boolean} Whether or not the node is a `null` or `undefined`.
- * @public
- */
-function isNullOrUndefined(scope, node) {
-    return (
-        isNullLiteral(node) ||
-        (node.type === "Identifier" && node.name === "undefined" && isReferenceToGlobalVariable(scope, node)) ||
-        (node.type === "UnaryExpression" && node.operator === "void")
-    );
-}
-
-
 /**
  * Checks if one operand will cause the result to be constant.
  * @param {Scope} scope Scope in which the expression was found.
@@ -407,14 +414,14 @@ function isNullOrUndefined(scope, node) {
 function findBinaryExpressionConstantOperand(scope, a, b, operator) {
     if (operator === "==" || operator === "!=") {
         if (
-            (isNullOrUndefined(scope, a) && hasConstantNullishness(scope, b)) ||
+            (isNullOrUndefined(scope, a) && hasConstantNullishness(scope, b, false)) ||
             (isStaticBoolean(scope, a) && hasConstantLooseBooleanComparison(scope, b))
         ) {
             return b;
         }
     } else if (operator === "===" || operator === "!==") {
         if (
-            (isNullOrUndefined(scope, a) && hasConstantNullishness(scope, b)) ||
+            (isNullOrUndefined(scope, a) && hasConstantNullishness(scope, b, false)) ||
             (isStaticBoolean(scope, a) && hasConstantStrictBooleanComparison(scope, b))
         ) {
             return b;
@@ -446,19 +453,21 @@ module.exports = {
     },
 
     create(context) {
+        const sourceCode = context.getSourceCode();
+
         return {
             LogicalExpression(node) {
                 const { operator, left } = node;
-                const scope = context.getScope();
+                const scope = sourceCode.getScope(node);
 
                 if ((operator === "&&" || operator === "||") && isConstant(scope, left, true)) {
                     context.report({ node: left, messageId: "constantShortCircuit", data: { property: "truthiness", operator } });
-                } else if (operator === "??" && hasConstantNullishness(scope, left)) {
+                } else if (operator === "??" && hasConstantNullishness(scope, left, false)) {
                     context.report({ node: left, messageId: "constantShortCircuit", data: { property: "nullishness", operator } });
                 }
             },
             BinaryExpression(node) {
-                const scope = context.getScope();
+                const scope = sourceCode.getScope(node);
                 const { right, left, operator } = node;
                 const rightConstantOperand = findBinaryExpressionConstantOperand(scope, left, right, operator);
                 const leftConstantOperand = findBinaryExpressionConstantOperand(scope, right, left, operator);

package/lib/rules/no-constant-condition.js

@@ -48,6 +48,7 @@ module.exports = {
         const options = context.options[0] || {},
             checkLoops = options.checkLoops !== false,
             loopSetStack = [];
+        const sourceCode = context.getSourceCode();
 
         let loopsInCurrentScope = new Set();
 
@@ -62,7 +63,7 @@ module.exports = {
          * @private
          */
         function trackConstantConditionLoop(node) {
-            if (node.test && isConstant(context.getScope(), node.test, true)) {
+            if (node.test && isConstant(sourceCode.getScope(node), node.test, true)) {
                 loopsInCurrentScope.add(node);
             }
         }
@@ -87,7 +88,7 @@ module.exports = {
          * @private
          */
         function reportIfConstant(node) {
-            if (node.test && isConstant(context.getScope(), node.test, true)) {
+            if (node.test && isConstant(sourceCode.getScope(node), node.test, true)) {
                 context.report({ node: node.test, messageId: "unexpected" });
             }
         }

package/lib/rules/no-control-regex.js

@@ -5,7 +5,7 @@
 
 "use strict";
 
-const RegExpValidator = require("regexpp").RegExpValidator;
+const RegExpValidator = require("@eslint-community/regexpp").RegExpValidator;
 const collector = new (class {
     constructor() {
         this._source = "";

package/lib/rules/no-div-regex.js

@@ -15,7 +15,7 @@ module.exports = {
         type: "suggestion",
 
         docs: {
-            description: "Disallow division operators explicitly at the beginning of regular expressions",
+            description: "Disallow equal signs explicitly at the beginning of regular expressions",
             recommended: false,
             url: "https://eslint.org/docs/rules/no-div-regex"
         },

package/lib/rules/no-dupe-args.js

@@ -29,6 +29,8 @@ module.exports = {
 
     create(context) {
 
+        const sourceCode = context.getSourceCode();
+
         //--------------------------------------------------------------------------
         // Helpers
         //--------------------------------------------------------------------------
@@ -49,7 +51,7 @@ module.exports = {
          * @private
          */
         function checkParams(node) {
-            const variables = context.getDeclaredVariables(node);
+            const variables = sourceCode.getDeclaredVariables(node);
 
             for (let i = 0; i < variables.length; ++i) {
                 const variable = variables[i];

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

@@ -47,6 +47,8 @@ module.exports = {
 
     create(context) {
 
+        const sourceCode = context.getSourceCode();
+
         //--------------------------------------------------------------------------
         // Helpers
         //--------------------------------------------------------------------------
@@ -169,25 +171,24 @@ module.exports = {
 
         /**
          * Display the context report if rule is violated
-         * @param {Node} node The 'else' node
+         * @param {Node} elseNode The 'else' node
          * @returns {void}
          */
-        function displayReport(node) {
-            const currentScope = context.getScope();
+        function displayReport(elseNode) {
+            const currentScope = sourceCode.getScope(elseNode.parent);
 
             context.report({
-                node,
+                node: elseNode,
                 messageId: "unexpected",
                 fix(fixer) {
 
-                    if (!isSafeFromNameCollisions(node, currentScope)) {
+                    if (!isSafeFromNameCollisions(elseNode, currentScope)) {
                         return null;
                     }
 
-                    const sourceCode = context.getSourceCode();
-                    const startToken = sourceCode.getFirstToken(node);
+                    const startToken = sourceCode.getFirstToken(elseNode);
                     const elseToken = sourceCode.getTokenBefore(startToken);
-                    const source = sourceCode.getText(node);
+                    const source = sourceCode.getText(elseNode);
                     const lastIfToken = sourceCode.getTokenBefore(elseToken);
                     let fixedSource, firstTokenOfElseBlock;
 
@@ -203,14 +204,14 @@ module.exports = {
                      * safe to remove the else keyword, because ASI will not add a semicolon
                      * after the if block
                      */
-                    const ifBlockMaybeUnsafe = node.parent.consequent.type !== "BlockStatement" && lastIfToken.value !== ";";
+                    const ifBlockMaybeUnsafe = elseNode.parent.consequent.type !== "BlockStatement" && lastIfToken.value !== ";";
                     const elseBlockUnsafe = /^[([/+`-]/u.test(firstTokenOfElseBlock.value);
 
                     if (ifBlockMaybeUnsafe && elseBlockUnsafe) {
                         return null;
                     }
 
-                    const endToken = sourceCode.getLastToken(node);
+                    const endToken = sourceCode.getLastToken(elseNode);
                     const lastTokenOfElseBlock = sourceCode.getTokenBefore(endToken);
 
                     if (lastTokenOfElseBlock.value !== ";") {
@@ -244,8 +245,8 @@ module.exports = {
                      * Also, to avoid name collisions between two else blocks.
                      */
                     return new FixTracker(fixer, sourceCode)
-                        .retainEnclosingFunction(node)
-                        .replaceTextRange([elseToken.range[0], node.range[1]], fixedSource);
+                        .retainEnclosingFunction(elseNode)
+                        .replaceTextRange([elseToken.range[0], elseNode.range[1]], fixedSource);
                 }
             });
         }

package/lib/rules/no-eval.js

@@ -72,7 +72,7 @@ module.exports = {
         let funcInfo = null;
 
         /**
-         * Pushs a `this` scope (non-arrow function, class static block, or class field initializer) information to the stack.
+         * Pushes a `this` scope (non-arrow function, class static block, or class field initializer) information to the stack.
          * Top-level scopes are handled separately.
          *
          * This is used in order to check whether or not `this` binding is a
@@ -84,7 +84,7 @@ module.exports = {
          * @returns {void}
          */
         function enterThisScope(node) {
-            const strict = context.getScope().isStrict;
+            const strict = sourceCode.getScope(node).isStrict;
 
             funcInfo = {
                 upper: funcInfo,
@@ -221,7 +221,7 @@ module.exports = {
             },
 
             Program(node) {
-                const scope = context.getScope(),
+                const scope = sourceCode.getScope(node),
                     features = context.parserOptions.ecmaFeatures || {},
                     strict =
                         scope.isStrict ||
@@ -239,8 +239,8 @@ module.exports = {
                 };
             },
 
-            "Program:exit"() {
-                const globalScope = context.getScope();
+            "Program:exit"(node) {
+                const globalScope = sourceCode.getScope(node);
 
                 exitThisScope();
                 reportAccessingEval(globalScope);

package/lib/rules/no-ex-assign.js

@@ -31,6 +31,8 @@ module.exports = {
 
     create(context) {
 
+        const sourceCode = context.getSourceCode();
+
         /**
          * Finds and reports references that are non initializer and writable.
          * @param {Variable} variable A variable to check.
@@ -44,7 +46,7 @@ module.exports = {
 
         return {
             CatchClause(node) {
-                context.getDeclaredVariables(node).forEach(checkVariable);
+                sourceCode.getDeclaredVariables(node).forEach(checkVariable);
             }
         };
 

package/lib/rules/no-extend-native.js

@@ -51,6 +51,7 @@ module.exports = {
     create(context) {
 
         const config = context.options[0] || {};
+        const sourceCode = context.getSourceCode();
         const exceptions = new Set(config.exceptions || []);
         const modifiedBuiltins = new Set(
             Object.keys(globals.builtin)
@@ -159,8 +160,8 @@ module.exports = {
 
         return {
 
-            "Program:exit"() {
-                const globalScope = context.getScope();
+            "Program:exit"(node) {
+                const globalScope = sourceCode.getScope(node);
 
                 modifiedBuiltins.forEach(builtin => {
                     const builtinVar = globalScope.set.get(builtin);

package/lib/rules/no-extra-boolean-cast.js

@@ -10,7 +10,7 @@
 //------------------------------------------------------------------------------
 
 const astUtils = require("./utils/ast-utils");
-const eslintUtils = require("eslint-utils");
+const eslintUtils = require("@eslint-community/eslint-utils");
 
 const precedence = astUtils.getPrecedence;
 

package/lib/rules/no-extra-parens.js

@@ -8,7 +8,7 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
-const { isParenthesized: isParenthesizedRaw } = require("eslint-utils");
+const { isParenthesized: isParenthesizedRaw } = require("@eslint-community/eslint-utils");
 const astUtils = require("./utils/ast-utils.js");
 
 /** @type {import('../shared/types').Rule} */