refactor: add utils.getSourceCode(), utils.getScope(), utils.getparse…

…rServices(), utils.getFilename()
eslint-community · Dec 18, 2024 · c53b4eb · c53b4eb
1 parent 8d32bf9
commit c53b4eb
Show file tree

Hide file tree

Showing 32 changed files with 78 additions and 56 deletions.
diff --git a/lib/rules/fixer-return.js b/lib/rules/fixer-return.js
@@ -76,12 +76,11 @@ 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 scope = sourceCode.getScope?.(node) || context.getScope(); // TODO: just use sourceCode.getScope() when we drop support for ESLint < 9.0.0
+      const scope = utils.getScope(context);
       const staticValue = getStaticValue(node, scope);
       if (!staticValue) {
         // If we can't find a static value, assume it's a real fix value.
@@ -99,7 +98,7 @@ module.exports = {
 
     return {
       Program(ast) {
-        const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+        const sourceCode = utils.getSourceCode(context);
         contextIdentifiers = utils.getContextIdentifiers(
           sourceCode.scopeManager,
           ast,
@@ -149,7 +148,7 @@ module.exports = {
       // Ensure the current (arrow) fixer function returned a fix.
       'ArrowFunctionExpression:exit'(node) {
         if (funcInfo.shouldCheck) {
-          const sourceCode = context.sourceCode || context.getSourceCode();
+          const sourceCode = utils.getSourceCode(context);
           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.

diff --git a/lib/rules/meta-property-ordering.js b/lib/rules/meta-property-ordering.js
@@ -4,7 +4,8 @@
 
 'use strict';
 
-const { getKeyName, getRuleInfo } = require('../utils');
+const utils = require('../utils');
+const { getKeyName, getRuleInfo } = utils;
 
 const defaultOrder = [
   'type',
@@ -48,7 +49,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
 
     // ----------------------------------------------------------------------
     // 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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     let contextIdentifiers;
 
     // ----------------------------------------------------------------------

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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
 
     // ----------------------------------------------------------------------
     // Helpers

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

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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const { scopeManager } = sourceCode;
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
@@ -48,7 +48,7 @@ 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
+        const scope = utils.getScope(context);
         // Check for messageId properties used in known calls to context.report();
         if (
           node.callee.type === 'MemberExpression' &&

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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const { scopeManager } = sourceCode;
 
     let contextIdentifiers;
@@ -48,7 +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
+        const scope = utils.getScope(context);
         if (
           node.callee.type === 'MemberExpression' &&
           contextIdentifiers.has(node.callee.object) &&

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

diff --git a/lib/rules/no-property-in-node.js b/lib/rules/no-property-in-node.js
@@ -1,5 +1,7 @@
 'use strict';
 
+const utils = require('../utils');
+
 const defaultTypedNodeSourceFileTesters = [
   /@types[/\\]estree[/\\]index\.d\.ts/,
   /@typescript-eslint[/\\]types[/\\]dist[/\\]generated[/\\]ast-spec\.d\.ts/,
@@ -88,7 +90,7 @@ module.exports = {
       'BinaryExpression[operator=in]'(node) {
         // TODO: Switch this to ESLintUtils.getParserServices with typescript-eslint@>=6
         // https://github.com/eslint-community/eslint-plugin-eslint-plugin/issues/269
-        const services = (context.sourceCode || context).parserServices;
+        const services = utils.getparserServices(context);
         if (!services.program) {
           throw new Error(
             'You have used a rule which requires parserServices to be generated. You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser.',

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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const { scopeManager } = sourceCode;
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
@@ -47,7 +47,7 @@ module.exports = {
         contextIdentifiers = utils.getContextIdentifiers(scopeManager, ast);
       },
 
-      'Program:exit'(ast) {
+      'Program:exit'() {
         if (hasSeenUnknownMessageId || !hasSeenViolationReport) {
           /*
           Bail out when the rule is likely to have false positives.
@@ -57,7 +57,7 @@ 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 scope = utils.getScope(context);
 
         const messageIdNodesUnused = messageIdNodes.filter(
           (node) => !messageIdsUsed.has(utils.getKeyName(node, scope)),

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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const { scopeManager } = sourceCode;
 
     let contextIdentifiers;
@@ -47,7 +47,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
+        const scope = utils.getScope(context);
         if (
           node.callee.type === 'MemberExpression' &&
           contextIdentifiers.has(node.callee.object) &&

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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
 
     // ----------------------------------------------------------------------
     // 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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
       return {};
@@ -43,7 +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
+        const scope = utils.getScope(context);
         contextIdentifiers = utils.getContextIdentifiers(
           sourceCode.scopeManager,
           ast,

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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
 
     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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const { scopeManager } = sourceCode;
 
     // ----------------------------------------------------------------------

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.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     let funcInfo = {
       upper: null,
       codePath: null,

diff --git a/lib/rules/report-message-format.js b/lib/rules/report-message-format.js
@@ -63,7 +63,7 @@ module.exports = {
       }
     }
 
-    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
       return {};
@@ -75,7 +75,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
+        const scope = utils.getScope(context);
         contextIdentifiers = utils.getContextIdentifiers(
           sourceCode.scopeManager,
           ast,
@@ -103,7 +103,7 @@ module.exports = {
           .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
+        const scope = utils.getScope(context);
         if (
           node.callee.type === 'MemberExpression' &&
           contextIdentifiers.has(node.callee.object) &&

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

diff --git a/lib/rules/require-meta-docs-description.js b/lib/rules/require-meta-docs-description.js
@@ -46,15 +46,15 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
       return {};
     }
 
     return {
-      Program(ast) {
-        const scope = sourceCode.getScope?.(ast) || context.getScope(); // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
+      Program() {
+        const scope = utils.getScope(context);
         const { scopeManager } = sourceCode;
 
         const {

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

diff --git a/lib/rules/require-meta-docs-url.js b/lib/rules/require-meta-docs-url.js
@@ -55,7 +55,7 @@ module.exports = {
    */
   create(context) {
     const options = context.options[0] || {};
-    const filename = context.filename || context.getFilename(); // TODO: just use context.filename when dropping eslint < v9
+    const filename = utils.getFilename(context);
     const ruleName =
       filename === '<input>'
         ? undefined
@@ -77,15 +77,15 @@ module.exports = {
       );
     }
 
-    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
       return {};
     }
 
     return {
-      Program(ast) {
-        const scope = sourceCode.getScope?.(ast) || context.getScope(); // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
+      Program() {
+        const scope = utils.getScope(context);
         const { scopeManager } = sourceCode;
 
         const {

diff --git a/lib/rules/require-meta-fixable.js b/lib/rules/require-meta-fixable.js
@@ -50,7 +50,7 @@ module.exports = {
     const catchNoFixerButFixableProperty =
       context.options[0] && context.options[0].catchNoFixerButFixableProperty;
 
-    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const { scopeManager } = sourceCode;
     const ruleInfo = utils.getRuleInfo(sourceCode);
     let contextIdentifiers;
@@ -79,8 +79,8 @@ module.exports = {
           usesFixFunctions = true;
         }
       },
-      'Program:exit'(ast) {
-        const scope = sourceCode.getScope?.(ast) || context.getScope(); // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
+      'Program:exit'() {
+        const scope = utils.getScope(context);
         const metaFixableProp =
           ruleInfo &&
           utils

diff --git a/lib/rules/require-meta-has-suggestions.js b/lib/rules/require-meta-has-suggestions.js
@@ -29,7 +29,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
+    const sourceCode = utils.getSourceCode(context);
     const { scopeManager } = sourceCode;
     const ruleInfo = utils.getRuleInfo(sourceCode);
     if (!ruleInfo) {
@@ -44,7 +44,7 @@ module.exports = {
      * @returns {boolean} whether this property should be considered to contain suggestions
      */
     function doesPropertyContainSuggestions(node) {
-      const scope = sourceCode.getScope?.(node) || context.getScope(); // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
+      const scope = utils.getScope(context);
       const staticValue = getStaticValue(node.value, scope);
       if (
         !staticValue ||
@@ -95,8 +95,8 @@ module.exports = {
           ruleReportsSuggestions = true;
         }
       },
-      'Program:exit'(node) {
-        const scope = sourceCode.getScope?.(node) || context.getScope(); // TODO: just use sourceCode.getScope() when we drop support for ESLint < v9.0.0
+      'Program:exit'() {
+        const scope = utils.getScope(context);
         const metaNode = ruleInfo && ruleInfo.meta;
         const hasSuggestionsProperty = utils
           .evaluateObjectProperties(metaNode, scopeManager)