fix: use sourceCode.getScope() when available

eslint-community · Dec 8, 2023 · 60ce5c6 · 60ce5c6
1 parent c5bfa68
commit 60ce5c6
Show file tree

Hide file tree

Showing 13 changed files with 40 additions and 29 deletions.
diff --git a/lib/rules/fixer-return.js b/lib/rules/fixer-return.js
@@ -80,8 +80,8 @@ module.exports = {
         // An empty array is not a fix.
         return false;
       }
-
-      const staticValue = getStaticValue(node, context.getScope());
+      const scope = (context.sourceCode || context.getSourceCode())?.getScope(node) || context.getScope() // TODO: just use sourceCode.getScope() when we drop support for ESLint < 9.0.0
+      const staticValue = getStaticValue(node, scope);
       if (!staticValue) {
         // If we can't find a static value, assume it's a real fix value.
         return true;

diff --git a/lib/rules/no-missing-message-ids.js b/lib/rules/no-missing-message-ids.js
@@ -80,7 +80,7 @@ module.exports = {
                   val.value,
                   ruleInfo,
                   scopeManager,
-                  context.getScope()
+                  sourceCode.getScope(node)
                 )
               )
                 // Couldn't find this messageId in `meta.messages`.

diff --git a/lib/rules/no-missing-placeholders.js b/lib/rules/no-missing-placeholders.js
@@ -48,6 +48,7 @@ module.exports = {
         contextIdentifiers = utils.getContextIdentifiers(scopeManager, ast);
       },
       CallExpression(node) {
+        const scope = sourceCode.getScope(node) || context.getScope() // TODO: just use sourceCode.getScope() when we drop support for ESLint < 9.0.0
         if (
           node.callee.type === 'MemberExpression' &&
           contextIdentifiers.has(node.callee.object) &&
@@ -75,7 +76,7 @@ module.exports = {
                   obj.messageId.value,
                   ruleInfo,
                   scopeManager,
-                  context.getScope()
+                  scope,
                 );
                 if (correspondingMessage) {
                   obj.message = correspondingMessage.value;
@@ -91,7 +92,7 @@ module.exports = {
           } of reportMessagesAndDataArray.filter((obj) => obj.message)) {
             const messageStaticValue = getStaticValue(
               message,
-              context.getScope()
+              scope,
             );
             if (
               ((message.type === 'Literal' &&

diff --git a/lib/rules/no-unused-message-ids.js b/lib/rules/no-unused-message-ids.js
@@ -47,7 +47,7 @@ module.exports = {
         contextIdentifiers = utils.getContextIdentifiers(scopeManager, ast);
       },
 
-      'Program:exit'() {
+      'Program:exit'(ast) {
         if (hasSeenUnknownMessageId || !hasSeenViolationReport) {
           /*
           Bail out when the rule is likely to have false positives.
@@ -57,9 +57,11 @@ module.exports = {
           return;
         }
 
+        const scope = sourceCode.getScope(ast)
+
         const messageIdNodesUnused = messageIdNodes.filter(
           (node) =>
-            !messageIdsUsed.has(utils.getKeyName(node, context.getScope()))
+            !messageIdsUsed.has(utils.getKeyName(node, scope))
         );
 
         // Report any messageIds that were never used.
@@ -68,7 +70,7 @@ module.exports = {
             node: messageIdNode,
             messageId: 'unusedMessage',
             data: {
-              messageId: utils.getKeyName(messageIdNode, context.getScope()),
+              messageId: utils.getKeyName(messageIdNode, scope),
             },
           });
         }

diff --git a/lib/rules/no-unused-placeholders.js b/lib/rules/no-unused-placeholders.js
@@ -74,7 +74,7 @@ module.exports = {
                   obj.messageId.value,
                   ruleInfo,
                   scopeManager,
-                  context.getScope()
+                  sourceCode.getScope(node)
                 );
                 if (correspondingMessage) {
                   obj.message = correspondingMessage.value;
@@ -88,7 +88,7 @@ module.exports = {
           )) {
             const messageStaticValue = getStaticValue(
               message,
-              context.getScope()
+              sourceCode.getScope(node)
             );
             if (
               ((message.type === 'Literal' &&

diff --git a/lib/rules/prefer-message-ids.js b/lib/rules/prefer-message-ids.js
@@ -43,6 +43,7 @@ module.exports = {
 
     return {
       Program(ast) {
+        const scope = sourceCode.getScope(ast) || context.getScope() // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
         contextIdentifiers = utils.getContextIdentifiers(
           sourceCode.scopeManager,
           ast
@@ -66,7 +67,7 @@ module.exports = {
 
         const staticValue = getStaticValue(
           messagesNode.value,
-          context.getScope()
+          scope
         );
         if (!staticValue) {
           return;

diff --git a/lib/rules/report-message-format.js b/lib/rules/report-message-format.js
@@ -38,8 +38,8 @@ module.exports = {
      * @param {ASTNode} message The message AST node
      * @returns {void}
      */
-    function processMessageNode(message) {
-      const staticValue = getStaticValue(message, context.getScope());
+    function processMessageNode(message, scope) {
+      const staticValue = getStaticValue(message, scope);
       if (
         (message.type === 'Literal' &&
           typeof message.value === 'string' &&
@@ -69,11 +69,13 @@ module.exports = {
 
     return {
       Program(ast) {
+        const scope = sourceCode.getScope(ast) || context.getScope() // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
         contextIdentifiers = utils.getContextIdentifiers(
           sourceCode.scopeManager,
           ast
         );
 
+
         const messagesObject =
           ruleInfo &&
           ruleInfo.meta &&
@@ -93,9 +95,10 @@ module.exports = {
         messagesObject.value.properties
           .filter((prop) => prop.type === 'Property')
           .map((prop) => prop.value)
-          .forEach(processMessageNode);
+          .forEach(it => processMessageNode(it, scope));
       },
       CallExpression(node) {
+        const scope = sourceCode.getScope(node) || context.getScope() // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
         if (
           node.callee.type === 'MemberExpression' &&
           contextIdentifiers.has(node.callee.object) &&
@@ -107,7 +110,7 @@ module.exports = {
           const suggest = reportInfo && reportInfo.suggest;
 
           if (message) {
-            processMessageNode(message);
+            processMessageNode(message, scope);
           }
 
           if (suggest && suggest.type === 'ArrayExpression') {
@@ -122,7 +125,7 @@ module.exports = {
                   prop.key.name === 'message'
               )
               .map((prop) => prop.value)
-              .forEach(processMessageNode);
+              .forEach(it => processMessageNode(it, scope));
           }
         }
       },

diff --git a/lib/rules/require-meta-docs-description.js b/lib/rules/require-meta-docs-description.js
@@ -49,7 +49,8 @@ module.exports = {
     }
 
     return {
-      Program() {
+      Program(ast) {
+        const scope = sourceCode.getScope(ast) || context.getScope() // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
         const { scopeManager } = sourceCode;
 
         const pattern =
@@ -79,7 +80,7 @@ module.exports = {
 
         const staticValue = getStaticValue(
           descriptionNode.value,
-          context.getScope()
+          scope,
         );
         if (!staticValue) {
           // Ignore non-static values since we can't determine what they look like.

diff --git a/lib/rules/require-meta-docs-url.js b/lib/rules/require-meta-docs-url.js
@@ -79,7 +79,8 @@ module.exports = {
     }
 
     return {
-      Program() {
+      Program(ast) {
+        const scope = sourceCode.getScope(ast) || context.getScope() // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
         const { scopeManager } = sourceCode;
 
         const metaNode = ruleInfo.meta;
@@ -94,7 +95,7 @@ module.exports = {
           .find((p) => p.type === 'Property' && util.getKeyName(p) === 'url');
 
         const staticValue = urlPropNode
-          ? getStaticValue(urlPropNode.value, context.getScope())
+          ? getStaticValue(urlPropNode.value, scope)
           : undefined;
         if (urlPropNode && !staticValue) {
           // Ignore non-static values since we can't determine what they look like.

diff --git a/lib/rules/require-meta-fixable.js b/lib/rules/require-meta-fixable.js
@@ -76,7 +76,9 @@ module.exports = {
           usesFixFunctions = true;
         }
       },
-      'Program:exit'() {
+      'Program:exit'(ast) {
+        const sourceCode = context.sourceCode || context.getSourceCode();
+        const scope = sourceCode.getScope(ast) || context.getScope() // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
         const metaFixableProp =
           ruleInfo &&
           utils
@@ -86,7 +88,7 @@ module.exports = {
         if (metaFixableProp) {
           const staticValue = getStaticValue(
             metaFixableProp.value,
-            context.getScope()
+            scope
           );
           if (!staticValue) {
             // Ignore non-static values since we can't determine what they look like.

diff --git a/lib/rules/require-meta-has-suggestions.js b/lib/rules/require-meta-has-suggestions.js
@@ -44,7 +44,8 @@ module.exports = {
      * @returns {boolean} whether this property should be considered to contain suggestions
      */
     function doesPropertyContainSuggestions(node) {
-      const staticValue = getStaticValue(node.value, context.getScope());
+      const scope = sourceCode.getScope(node) || context.getScope() // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
+      const staticValue = getStaticValue(node.value, scope);
       if (
         !staticValue ||
         (Array.isArray(staticValue.value) && staticValue.value.length > 0) ||

diff --git a/lib/rules/require-meta-type.js b/lib/rules/require-meta-type.js
@@ -45,7 +45,8 @@ module.exports = {
     }
 
     return {
-      Program() {
+      Program(node) {
+        const scope = sourceCode.getScope(node) || context.getScope() // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
         const { scopeManager } = sourceCode;
 
         const metaNode = ruleInfo.meta;
@@ -61,7 +62,7 @@ module.exports = {
           return;
         }
 
-        const staticValue = getStaticValue(typeNode.value, context.getScope());
+        const staticValue = getStaticValue(typeNode.value, scope);
         if (!staticValue) {
           // Ignore non-static values since we can't determine what they look like.
           return;

diff --git a/lib/utils.js b/lib/utils.js
@@ -610,11 +610,9 @@ module.exports = {
     }
 
     let keys;
+    const scope = (context.sourceCode || context.getSourceCode()).getScope?.(node) || context.getScope() // TODO: just use sourceCode.getScope() when dropping eslint < v9
+    const secondArgStaticValue = getStaticValue(reportArgs[1], scope);
 
-    const secondArgStaticValue = getStaticValue(
-      reportArgs[1],
-      (context.sourceCode || context.getSourceCode()).getScope?.(node) || context.getScope() // TODO: just use sourceCode.getScope() when dropping eslint < v9
-    );
     if (
       (secondArgStaticValue &&
         typeof secondArgStaticValue.value === 'string') ||