feat: preparing for eslint v9 (#400)

eslint-community · Dec 11, 2023 · 35e14cd · 35e14cd
1 parent b8ed4ca
commit 35e14cd
Show file tree

Hide file tree

Showing 28 changed files with 133 additions and 98 deletions.
diff --git a/lib/rules/fixer-return.js b/lib/rules/fixer-return.js
@@ -76,12 +76,13 @@ module.exports = {
      * @returns {boolean}
      */
     function isFix(node) {
+      const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: use context.sourceCode when dropping eslint < v9
       if (node.type === 'ArrayExpression' && node.elements.length === 0) {
         // An empty array is not a fix.
         return false;
       }
-
-      const staticValue = getStaticValue(node, context.getScope());
+      const scope = sourceCode.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;
@@ -98,7 +99,7 @@ module.exports = {
 
     return {
       Program(ast) {
-        const sourceCode = context.getSourceCode();
+        const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
         contextIdentifiers = utils.getContextIdentifiers(
           sourceCode.scopeManager,
           ast
@@ -148,7 +149,8 @@ module.exports = {
       // Ensure the current (arrow) fixer function returned a fix.
       'ArrowFunctionExpression:exit'(node) {
         if (funcInfo.shouldCheck) {
-          const loc = context.getSourceCode().getTokenBefore(node.body).loc; // Show violation on arrow (=>).
+          const sourceCode = context.sourceCode || context.getSourceCode();
+          const loc = sourceCode.getTokenBefore(node.body).loc; // Show violation on arrow (=>).
           if (node.expression) {
             // When the return is implied (no curly braces around the body), we have to check the single body node directly.
             if (!isFix(node.body)) {

diff --git a/lib/rules/meta-property-ordering.js b/lib/rules/meta-property-ordering.js
@@ -34,7 +34,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     const ruleInfo = getRuleInfo(sourceCode);
     if (!ruleInfo) {
       return {};

diff --git a/lib/rules/no-deprecated-context-methods.js b/lib/rules/no-deprecated-context-methods.js
@@ -54,7 +54,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
 
     // ----------------------------------------------------------------------
     // Public

diff --git a/lib/rules/no-deprecated-report-api.js b/lib/rules/no-deprecated-report-api.js
@@ -30,7 +30,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     let contextIdentifiers;
 
     // ----------------------------------------------------------------------
@@ -60,7 +60,7 @@ module.exports = {
             fix(fixer) {
               const openingParen = sourceCode.getTokenBefore(node.arguments[0]);
               const closingParen = sourceCode.getLastToken(node);
-              const reportInfo = utils.getReportInfo(node.arguments, context);
+              const reportInfo = utils.getReportInfo(node, context);
 
               if (!reportInfo) {
                 return null;

diff --git a/lib/rules/no-identical-tests.js b/lib/rules/no-identical-tests.js
@@ -32,7 +32,7 @@ module.exports = {
     // ----------------------------------------------------------------------
     // Public
     // ----------------------------------------------------------------------
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
 
     // ----------------------------------------------------------------------
     // Helpers

diff --git a/lib/rules/no-missing-message-ids.js b/lib/rules/no-missing-message-ids.js
@@ -26,7 +26,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     const { scopeManager } = sourceCode;
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
@@ -48,14 +48,15 @@ module.exports = {
       },
 
       CallExpression(node) {
+        const scope = sourceCode.getScope?.(node) || context.getScope(); // TODO: just use sourceCode.getScope() when we drop support for ESLint < 9.0.0
         // Check for messageId properties used in known calls to context.report();
         if (
           node.callee.type === 'MemberExpression' &&
           contextIdentifiers.has(node.callee.object) &&
           node.callee.property.type === 'Identifier' &&
           node.callee.property.name === 'report'
         ) {
-          const reportInfo = utils.getReportInfo(node.arguments, context);
+          const reportInfo = utils.getReportInfo(node, context);
           if (!reportInfo) {
             return;
           }
@@ -80,7 +81,7 @@ module.exports = {
                   val.value,
                   ruleInfo,
                   scopeManager,
-                  context.getScope()
+                  scope
                 )
               )
                 // Couldn't find this messageId in `meta.messages`.

diff --git a/lib/rules/no-missing-placeholders.js b/lib/rules/no-missing-placeholders.js
@@ -31,7 +31,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     const { scopeManager } = sourceCode;
 
     let contextIdentifiers;
@@ -48,13 +48,14 @@ 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) &&
           node.callee.property.type === 'Identifier' &&
           node.callee.property.name === 'report'
         ) {
-          const reportInfo = utils.getReportInfo(node.arguments, context);
+          const reportInfo = utils.getReportInfo(node, context);
           if (!reportInfo) {
             return;
           }
@@ -75,7 +76,7 @@ module.exports = {
                   obj.messageId.value,
                   ruleInfo,
                   scopeManager,
-                  context.getScope()
+                  scope
                 );
                 if (correspondingMessage) {
                   obj.message = correspondingMessage.value;
@@ -89,10 +90,7 @@ module.exports = {
             messageId,
             data,
           } of reportMessagesAndDataArray.filter((obj) => obj.message)) {
-            const messageStaticValue = getStaticValue(
-              message,
-              context.getScope()
-            );
+            const messageStaticValue = getStaticValue(message, scope);
             if (
               ((message.type === 'Literal' &&
                 typeof message.value === 'string') ||

diff --git a/lib/rules/no-only-tests.js b/lib/rules/no-only-tests.js
@@ -51,7 +51,8 @@ module.exports = {
                     {
                       messageId: 'removeOnly',
                       *fix(fixer) {
-                        const sourceCode = context.getSourceCode();
+                        const sourceCode =
+                          context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
 
                         const tokenBefore =
                           sourceCode.getTokenBefore(onlyProperty);

diff --git a/lib/rules/no-unused-message-ids.js b/lib/rules/no-unused-message-ids.js
@@ -24,7 +24,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     const { scopeManager } = sourceCode;
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
@@ -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,10 @@ module.exports = {
           return;
         }
 
+        const scope = sourceCode.getScope?.(ast) || context.getScope(); // TODO: just use sourceCode.getScope() when we drop support for ESLint < 9.0.0
+
         const messageIdNodesUnused = messageIdNodes.filter(
-          (node) =>
-            !messageIdsUsed.has(utils.getKeyName(node, context.getScope()))
+          (node) => !messageIdsUsed.has(utils.getKeyName(node, scope))
         );
 
         // Report any messageIds that were never used.
@@ -68,7 +69,7 @@ module.exports = {
             node: messageIdNode,
             messageId: 'unusedMessage',
             data: {
-              messageId: utils.getKeyName(messageIdNode, context.getScope()),
+              messageId: utils.getKeyName(messageIdNode, scope),
             },
           });
         }
@@ -82,7 +83,7 @@ module.exports = {
           node.callee.property.type === 'Identifier' &&
           node.callee.property.name === 'report'
         ) {
-          const reportInfo = utils.getReportInfo(node.arguments, context);
+          const reportInfo = utils.getReportInfo(node, context);
           if (!reportInfo) {
             return;
           }

diff --git a/lib/rules/no-unused-placeholders.js b/lib/rules/no-unused-placeholders.js
@@ -31,7 +31,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     const { scopeManager } = sourceCode;
 
     let contextIdentifiers;
@@ -47,13 +47,14 @@ 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) &&
           node.callee.property.type === 'Identifier' &&
           node.callee.property.name === 'report'
         ) {
-          const reportInfo = utils.getReportInfo(node.arguments, context);
+          const reportInfo = utils.getReportInfo(node, context);
           if (!reportInfo) {
             return;
           }
@@ -74,7 +75,7 @@ module.exports = {
                   obj.messageId.value,
                   ruleInfo,
                   scopeManager,
-                  context.getScope()
+                  scope
                 );
                 if (correspondingMessage) {
                   obj.message = correspondingMessage.value;
@@ -86,10 +87,7 @@ module.exports = {
           for (const { message, data } of reportMessagesAndDataArray.filter(
             (obj) => obj.message
           )) {
-            const messageStaticValue = getStaticValue(
-              message,
-              context.getScope()
-            );
+            const messageStaticValue = getStaticValue(message, scope);
             if (
               ((message.type === 'Literal' &&
                 typeof message.value === 'string') ||

diff --git a/lib/rules/no-useless-token-range.js b/lib/rules/no-useless-token-range.js
@@ -30,7 +30,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
 
     // ----------------------------------------------------------------------
     // Helpers

diff --git a/lib/rules/prefer-message-ids.js b/lib/rules/prefer-message-ids.js
@@ -29,7 +29,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
       return {};
@@ -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
@@ -64,10 +65,7 @@ module.exports = {
           return;
         }
 
-        const staticValue = getStaticValue(
-          messagesNode.value,
-          context.getScope()
-        );
+        const staticValue = getStaticValue(messagesNode.value, scope);
         if (!staticValue) {
           return;
         }
@@ -90,7 +88,7 @@ module.exports = {
           node.callee.property.type === 'Identifier' &&
           node.callee.property.name === 'report'
         ) {
-          const reportInfo = utils.getReportInfo(node.arguments, context);
+          const reportInfo = utils.getReportInfo(node, context);
           if (!reportInfo) {
             return;
           }

diff --git a/lib/rules/prefer-object-rule.js b/lib/rules/prefer-object-rule.js
@@ -32,7 +32,7 @@ module.exports = {
     // Public
     // ----------------------------------------------------------------------
 
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
       return {};

diff --git a/lib/rules/prefer-output-null.js b/lib/rules/prefer-output-null.js
@@ -35,7 +35,7 @@ module.exports = {
     // Public
     // ----------------------------------------------------------------------
 
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
 
     return {
       Program(ast) {

diff --git a/lib/rules/prefer-placeholders.js b/lib/rules/prefer-placeholders.js
@@ -33,7 +33,7 @@ module.exports = {
   create(context) {
     let contextIdentifiers;
 
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     const { scopeManager } = sourceCode;
 
     // ----------------------------------------------------------------------
@@ -51,7 +51,7 @@ module.exports = {
           node.callee.property.type === 'Identifier' &&
           node.callee.property.name === 'report'
         ) {
-          const reportInfo = utils.getReportInfo(node.arguments, context);
+          const reportInfo = utils.getReportInfo(node, context);
 
           if (!reportInfo) {
             return;

diff --git a/lib/rules/prefer-replace-text.js b/lib/rules/prefer-replace-text.js
@@ -30,7 +30,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     let funcInfo = {
       upper: null,
       codePath: null,