chore: add a few todos

eslint-community · Dec 10, 2023 · d485783 · d485783
1 parent e4759a7
commit d485783
Show file tree

Hide file tree

Showing 26 changed files with 33 additions and 33 deletions.
diff --git a/lib/rules/fixer-return.js b/lib/rules/fixer-return.js
@@ -76,13 +76,12 @@ 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 =
-        (context.sourceCode || context.getSourceCode()).getScope?.(node) ||
-        context.getScope(); // TODO: just use sourceCode.getScope() when we drop support for ESLint < 9.0.0
+      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.
@@ -100,7 +99,7 @@ module.exports = {
 
     return {
       Program(ast) {
-        const sourceCode = context.sourceCode || context.getSourceCode();
+        const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
         contextIdentifiers = utils.getContextIdentifiers(
           sourceCode.scopeManager,
           ast
@@ -150,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.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.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.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     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();
+    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.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) {

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

diff --git a/lib/rules/no-only-tests.js b/lib/rules/no-only-tests.js
@@ -52,7 +52,7 @@ module.exports = {
                       messageId: 'removeOnly',
                       *fix(fixer) {
                         const sourceCode =
-                          context.sourceCode || context.getSourceCode();
+                          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.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) {

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

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();
+    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.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-object-rule.js b/lib/rules/prefer-object-rule.js
@@ -32,7 +32,7 @@ module.exports = {
     // Public
     // ----------------------------------------------------------------------
 
-    const sourceCode = context.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.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.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     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();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     let funcInfo = {
       upper: null,
       codePath: null,

diff --git a/lib/rules/report-message-format.js b/lib/rules/report-message-format.js
@@ -57,7 +57,7 @@ module.exports = {
       }
     }
 
-    const sourceCode = context.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/require-meta-docs-description.js b/lib/rules/require-meta-docs-description.js
@@ -45,7 +45,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.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/require-meta-docs-url.js b/lib/rules/require-meta-docs-url.js
@@ -54,7 +54,7 @@ module.exports = {
    */
   create(context) {
     const options = context.options[0] || {};
-    const filename = context.filename || context.getFilename();
+    const filename = context.filename || context.getFilename(); // TODO: just use context.filename when dropping eslint < v9
     const ruleName =
       filename === '<input>'
         ? undefined
@@ -76,7 +76,7 @@ module.exports = {
       );
     }
 
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     const ruleInfo = util.getRuleInfo(sourceCode);
     if (!ruleInfo) {
       return {};

diff --git a/lib/rules/require-meta-fixable.js b/lib/rules/require-meta-fixable.js
@@ -49,7 +49,7 @@ module.exports = {
     const catchNoFixerButFixableProperty =
       context.options[0] && context.options[0].catchNoFixerButFixableProperty;
 
-    const sourceCode = context.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);
     let contextIdentifiers;

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();
+    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) {

diff --git a/lib/rules/require-meta-schema.js b/lib/rules/require-meta-schema.js
@@ -43,7 +43,7 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.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) {

diff --git a/lib/rules/require-meta-type.js b/lib/rules/require-meta-type.js
@@ -38,7 +38,7 @@ module.exports = {
     // Public
     // ----------------------------------------------------------------------
 
-    const sourceCode = context.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/test-case-property-ordering.js b/lib/rules/test-case-property-ordering.js
@@ -50,7 +50,7 @@ module.exports = {
       'env',
       'errors',
     ];
-    const sourceCode = context.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/test-case-shorthand-strings.js b/lib/rules/test-case-shorthand-strings.js
@@ -34,7 +34,7 @@ module.exports = {
 
   create(context) {
     const shorthandOption = context.options[0] || 'as-needed';
-    const sourceCode = context.sourceCode || context.getSourceCode();
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
 
     // ----------------------------------------------------------------------
     // Helpers

diff --git a/lib/utils.js b/lib/utils.js
@@ -444,6 +444,7 @@ module.exports = {
     statements,
     variableIdentifiers = new Set()
   ) {
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: just use context.sourceCode when dropping eslint < v9
     const runCalls = [];
 
     for (const statement of statements) {
@@ -612,9 +613,8 @@ module.exports = {
     }
 
     let keys;
-    const scope =
-      (context.sourceCode || context.getSourceCode()).getScope?.(node) ||
-      context.getScope(); // TODO: just use sourceCode.getScope() when dropping eslint < v9
+    const sourceCode = context.sourceCode || context.getSourceCode(); // TODO: use context.sourceCode when dropping eslint < v9
+    const scope = sourceCode.getScope?.(node) || context.getScope(); // TODO: just use sourceCode.getScope() when dropping eslint < v9
     const secondArgStaticValue = getStaticValue(reportArgs[1], scope);
 
     if (