[Refactor] create getScope util; context.getScope is deprecated

Co-authored-by: Mateusz Łopaciński <[email protected]> Co-authored-by: Jordan Harband <[email protected]>
jsx-eslint · Apr 28, 2024 · 8e1a94b · 8e1a94b
1 parent d6e9059
commit 8e1a94b
Show file tree

Hide file tree

Showing 37 changed files with 218 additions and 158 deletions.
diff --git a/lib/rules/destructuring-assignment.js b/lib/rules/destructuring-assignment.js
@@ -10,6 +10,7 @@ const eslintUtil = require('../util/eslint');
 const isAssignmentLHS = require('../util/ast').isAssignmentLHS;
 const report = require('../util/report');
 
+const getScope = eslintUtil.getScope;
 const getText = eslintUtil.getText;
 
 const DEFAULT_OPTION = 'always';
@@ -105,7 +106,7 @@ module.exports = {
     function handleStatelessComponent(node) {
       const params = evalParams(node.params);
 
-      const SFCComponent = components.get(context.getScope(node).block);
+      const SFCComponent = components.get(getScope(context, node).block);
       if (!SFCComponent) {
         return;
       }
@@ -123,7 +124,7 @@ module.exports = {
     }
 
     function handleStatelessComponentExit(node) {
-      const SFCComponent = components.get(context.getScope(node).block);
+      const SFCComponent = components.get(getScope(context, node).block);
       if (SFCComponent) {
         sfcParams.pop();
       }
@@ -195,7 +196,7 @@ module.exports = {
       'FunctionExpression:exit': handleStatelessComponentExit,
 
       MemberExpression(node) {
-        let scope = context.getScope(node);
+        let scope = getScope(context, node);
         let SFCComponent = components.get(scope.block);
         while (!SFCComponent && scope.upper && scope.upper !== scope) {
           SFCComponent = components.get(scope.upper.block);
@@ -213,7 +214,7 @@ module.exports = {
 
       VariableDeclarator(node) {
         const classComponent = utils.getParentComponent(node);
-        const SFCComponent = components.get(context.getScope(node).block);
+        const SFCComponent = components.get(getScope(context, node).block);
 
         const destructuring = (node.init && node.id && node.id.type === 'ObjectPattern');
         // let {foo} = props;
@@ -251,7 +252,7 @@ module.exports = {
           && destructureInSignature === 'always'
           && node.init.name === 'props'
         ) {
-          const scopeSetProps = context.getScope().set.get('props');
+          const scopeSetProps = getScope(context, node).set.get('props');
           const propsRefs = scopeSetProps && scopeSetProps.references;
           if (!propsRefs) {
             return;

diff --git a/lib/rules/forbid-prop-types.js b/lib/rules/forbid-prop-types.js
@@ -163,7 +163,7 @@ module.exports = {
           checkProperties(node.properties);
           break;
         case 'Identifier': {
-          const propTypesObject = variableUtil.findVariableByName(context, node.name);
+          const propTypesObject = variableUtil.findVariableByName(context, node, node.name);
           if (propTypesObject && propTypesObject.properties) {
             checkProperties(propTypesObject.properties);
           }

diff --git a/lib/rules/jsx-fragments.js b/lib/rules/jsx-fragments.js
@@ -102,8 +102,8 @@ module.exports = {
       };
     }
 
-    function refersToReactFragment(name) {
-      const variableInit = variableUtil.findVariableByName(context, name);
+    function refersToReactFragment(node, name) {
+      const variableInit = variableUtil.findVariableByName(context, node, name);
       if (!variableInit) {
         return false;
       }
@@ -184,7 +184,7 @@ module.exports = {
           const openingEl = node.openingElement;
           const elName = elementType(openingEl);
 
-          if (fragmentNames.has(elName) || refersToReactFragment(elName)) {
+          if (fragmentNames.has(elName) || refersToReactFragment(node, elName)) {
             if (reportOnReactVersion(node)) {
               return;
             }

diff --git a/lib/rules/jsx-max-depth.js b/lib/rules/jsx-max-depth.js
@@ -150,7 +150,7 @@ module.exports = {
           return;
         }
 
-        const variables = variableUtil.variablesInScope(context);
+        const variables = variableUtil.variablesInScope(context, node);
         const element = findJSXElementOrFragment(variables, node.expression.name, []);
 
         if (element) {

diff --git a/lib/rules/jsx-no-constructed-context-values.js b/lib/rules/jsx-no-constructed-context-values.js
@@ -8,6 +8,7 @@
 
 const Components = require('../util/Components');
 const docsUrl = require('../util/docsUrl');
+const getScope = require('../util/eslint').getScope;
 const report = require('../util/report');
 
 // ------------------------------------------------------------------------------
@@ -180,7 +181,7 @@ module.exports = {
         }
 
         const valueExpression = valueNode.expression;
-        const invocationScope = context.getScope();
+        const invocationScope = getScope(context, node);
 
         // Check if the value prop is a construction
         const constructInfo = isConstruction(valueExpression, invocationScope);

diff --git a/lib/rules/jsx-no-leaked-render.js b/lib/rules/jsx-no-leaked-render.js
@@ -161,7 +161,7 @@ module.exports = {
           if (isCoerceValidLeftSide || getIsCoerceValidNestedLogicalExpression(leftSide)) {
             return;
           }
-          const variables = variableUtil.variablesInScope(context);
+          const variables = variableUtil.variablesInScope(context, node);
           const leftSideVar = variableUtil.getVariable(variables, leftSide.name);
           if (leftSideVar) {
             const leftSideValue = leftSideVar.defs

diff --git a/lib/rules/jsx-no-undef.js b/lib/rules/jsx-no-undef.js
@@ -51,7 +51,7 @@ module.exports = {
      * @returns {void}
      */
     function checkIdentifierInJSX(node) {
-      let scope = context.getScope();
+      let scope = eslintUtil.getScope(context, node);
       const sourceCode = eslintUtil.getSourceCode(context);
       const sourceType = sourceCode.ast.sourceType;
       const scopeUpperBound = !allowGlobals && sourceType === 'module' ? 'module' : 'global';

diff --git a/lib/rules/jsx-sort-default-props.js b/lib/rules/jsx-sort-default-props.js
@@ -91,11 +91,14 @@ module.exports = {
 
     /**
      * Find a variable by name in the current scope.
+     * @param  {ASTNode} node The node to look for.
      * @param  {string} name Name of the variable to look for.
      * @returns {ASTNode|null} Return null if the variable could not be found, ASTNode otherwise.
      */
-    function findVariableByName(name) {
-      const variable = variableUtil.variablesInScope(context).find((item) => item.name === name);
+    function findVariableByName(node, name) {
+      const variable = variableUtil
+        .variablesInScope(context, node)
+        .find((item) => item.name === name);
 
       if (!variable || !variable.defs[0] || !variable.defs[0].node) {
         return null;
@@ -151,7 +154,7 @@ module.exports = {
       if (node.type === 'ObjectExpression') {
         checkSorted(node.properties);
       } else if (node.type === 'Identifier') {
-        const propTypesObject = findVariableByName(node.name);
+        const propTypesObject = findVariableByName(node, node.name);
         if (propTypesObject && propTypesObject.properties) {
           checkSorted(propTypesObject.properties);
         }

diff --git a/lib/rules/no-access-state-in-setstate.js b/lib/rules/no-access-state-in-setstate.js
@@ -8,6 +8,7 @@
 const docsUrl = require('../util/docsUrl');
 const componentUtil = require('../util/componentUtil');
 const report = require('../util/report');
+const getScope = require('../util/eslint').getScope;
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -47,8 +48,15 @@ module.exports = {
       return current.arguments[0] === node;
     }
 
-    function isClassComponent() {
-      return !!(componentUtil.getParentES6Component(context) || componentUtil.getParentES5Component(context));
+    /**
+     * @param {ASTNode} node
+     * @returns {boolean}
+     */
+    function isClassComponent(node) {
+      return !!(
+        componentUtil.getParentES6Component(context, node)
+        || componentUtil.getParentES5Component(context, node)
+      );
     }
 
     // The methods array contains all methods or functions that are using this.state
@@ -58,7 +66,7 @@ module.exports = {
     const vars = [];
     return {
       CallExpression(node) {
-        if (!isClassComponent()) {
+        if (!isClassComponent(node)) {
           return;
         }
         // Appends all the methods that are calling another
@@ -103,7 +111,7 @@ module.exports = {
         if (
           node.property.name === 'state'
           && node.object.type === 'ThisExpression'
-          && isClassComponent()
+          && isClassComponent(node)
         ) {
           let current = node;
           while (current.type !== 'Program') {
@@ -134,7 +142,7 @@ module.exports = {
             if (current.type === 'VariableDeclarator') {
               vars.push({
                 node,
-                scope: context.getScope(),
+                scope: getScope(context, node),
                 variableName: current.id.name,
               });
               break;
@@ -158,7 +166,7 @@ module.exports = {
           while (current.type !== 'Program') {
             if (isFirstArgumentInSetStateCall(current, node)) {
               vars
-                .filter((v) => v.scope === context.getScope() && v.variableName === node.name)
+                .filter((v) => v.scope === getScope(context, node) && v.variableName === node.name)
                 .forEach((v) => {
                   report(context, messages.useCallback, 'useCallback', {
                     node: v.node,
@@ -176,7 +184,7 @@ module.exports = {
           if (property && property.key && property.key.name === 'state' && isDerivedFromThis) {
             vars.push({
               node: property.key,
-              scope: context.getScope(),
+              scope: getScope(context, node),
               variableName: property.key.name,
             });
           }

diff --git a/lib/rules/no-array-index-key.js b/lib/rules/no-array-index-key.js
@@ -28,7 +28,7 @@ function isCreateCloneElement(node, context) {
   }
 
   if (node.type === 'Identifier') {
-    const variable = variableUtil.findVariableByName(context, node.name);
+    const variable = variableUtil.findVariableByName(context, node, node.name);
     if (variable && variable.type === 'ImportSpecifier') {
       return variable.parent.source.value === 'react';
     }

diff --git a/lib/rules/no-danger-with-children.js b/lib/rules/no-danger-with-children.js
@@ -31,8 +31,9 @@ module.exports = {
     schema: [], // no options
   },
   create(context) {
-    function findSpreadVariable(name) {
-      return variableUtil.variablesInScope(context).find((item) => item.name === name);
+    function findSpreadVariable(node, name) {
+      return variableUtil.variablesInScope(context, node)
+        .find((item) => item.name === name);
     }
     /**
      * Takes a ObjectExpression and returns the value of the prop if it has it
@@ -50,7 +51,7 @@ module.exports = {
           return prop.key.name === propName;
         }
         if (prop.type === 'ExperimentalSpreadProperty' || prop.type === 'SpreadElement') {
-          const variable = findSpreadVariable(prop.argument.name);
+          const variable = findSpreadVariable(node, prop.argument.name);
           if (variable && variable.defs.length && variable.defs[0].node.init) {
             if (seenProps.indexOf(prop.argument.name) > -1) {
               return false;
@@ -73,7 +74,7 @@ module.exports = {
       const attributes = node.openingElement.attributes;
       return attributes.find((attribute) => {
         if (attribute.type === 'JSXSpreadAttribute') {
-          const variable = findSpreadVariable(attribute.argument.name);
+          const variable = findSpreadVariable(node, attribute.argument.name);
           if (variable && variable.defs.length && variable.defs[0].node.init) {
             return findObjectProp(variable.defs[0].node.init, propName, []);
           }
@@ -127,7 +128,8 @@ module.exports = {
           let props = node.arguments[1];
 
           if (props.type === 'Identifier') {
-            const variable = variableUtil.variablesInScope(context).find((item) => item.name === props.name);
+            const variable = variableUtil.variablesInScope(context, node)
+              .find((item) => item.name === props.name);
             if (variable && variable.defs.length && variable.defs[0].node.init) {
               props = variable.defs[0].node.init;
             }

diff --git a/lib/rules/no-direct-mutation-state.js b/lib/rules/no-direct-mutation-state.js
@@ -98,7 +98,7 @@ module.exports = {
       },
 
       AssignmentExpression(node) {
-        const component = components.get(utils.getParentComponent());
+        const component = components.get(utils.getParentComponent(node));
         if (shouldIgnoreComponent(component) || !node.left || !node.left.object) {
           return;
         }
@@ -114,7 +114,7 @@ module.exports = {
       },
 
       UpdateExpression(node) {
-        const component = components.get(utils.getParentComponent());
+        const component = components.get(utils.getParentComponent(node));
         if (shouldIgnoreComponent(component) || node.argument.type !== 'MemberExpression') {
           return;
         }

diff --git a/lib/rules/no-set-state.js b/lib/rules/no-set-state.js
@@ -68,7 +68,7 @@ module.exports = {
         ) {
           return;
         }
-        const component = components.get(utils.getParentComponent());
+        const component = components.get(utils.getParentComponent(node));
         const setStateUsages = (component && component.setStateUsages) || [];
         setStateUsages.push(callee);
         components.set(node, {

diff --git a/lib/rules/no-string-refs.js b/lib/rules/no-string-refs.js
@@ -50,7 +50,7 @@ module.exports = {
      */
     function isRefsUsage(node) {
       return !!(
-        (componentUtil.getParentES6Component(context) || componentUtil.getParentES5Component(context))
+        (componentUtil.getParentES6Component(context, node) || componentUtil.getParentES5Component(context, node))
         && node.object.type === 'ThisExpression'
         && node.property.name === 'refs'
       );

diff --git a/lib/rules/no-this-in-sfc.js b/lib/rules/no-this-in-sfc.js
@@ -34,7 +34,7 @@ module.exports = {
   create: Components.detect((context, components, utils) => ({
     MemberExpression(node) {
       if (node.object.type === 'ThisExpression') {
-        const component = components.get(utils.getParentStatelessComponent());
+        const component = components.get(utils.getParentStatelessComponent(node));
         if (!component || (component.node && component.node.parent && component.node.parent.type === 'Property')) {
           return;
         }

diff --git a/lib/rules/no-unstable-nested-components.js b/lib/rules/no-unstable-nested-components.js
@@ -306,7 +306,7 @@ module.exports = {
      * @returns {Boolean} True if node is inside class component's render block, false if not
      */
     function isInsideRenderMethod(node) {
-      const parentComponent = utils.getParentComponent();
+      const parentComponent = utils.getParentComponent(node);
 
       if (!parentComponent || parentComponent.type !== 'ClassDeclaration') {
         return false;
@@ -334,8 +334,8 @@ module.exports = {
      * @returns {Boolean} True if given node a function component declared inside class component, false if not
      */
     function isFunctionComponentInsideClassComponent(node) {
-      const parentComponent = utils.getParentComponent();
-      const parentStatelessComponent = utils.getParentStatelessComponent();
+      const parentComponent = utils.getParentComponent(node);
+      const parentStatelessComponent = utils.getParentStatelessComponent(node);
 
       return (
         parentComponent

diff --git a/lib/rules/no-unused-state.js b/lib/rules/no-unused-state.js
@@ -13,6 +13,7 @@ const docsUrl = require('../util/docsUrl');
 const ast = require('../util/ast');
 const componentUtil = require('../util/componentUtil');
 const report = require('../util/report');
+const getScope = require('../util/eslint').getScope;
 
 // Descend through all wrapping TypeCastExpressions and return the expression
 // that was cast.
@@ -107,7 +108,7 @@ module.exports = {
         'componentDidUpdate',
       ];
 
-      let scope = context.getScope();
+      let scope = getScope(context, node);
       while (scope) {
         const parent = scope.block && scope.block.parent;
         if (
@@ -368,7 +369,7 @@ module.exports = {
           return;
         }
 
-        const childScope = context.getScope().childScopes.find((x) => x.block === node.value);
+        const childScope = getScope(context, node).childScopes.find((x) => x.block === node.value);
         if (!childScope) {
           return;
         }

diff --git a/lib/rules/prefer-exact-props.js b/lib/rules/prefer-exact-props.js
@@ -149,7 +149,7 @@ module.exports = {
           reportPropTypesError(node);
         } else if (right.type === 'Identifier') {
           const identifier = right.name;
-          const propsDefinition = variableUtil.findVariableByName(context, identifier);
+          const propsDefinition = variableUtil.findVariableByName(context, node, identifier);
           if (isNonEmptyObjectExpression(propsDefinition)) {
             reportPropTypesError(node);
           } else if (isNonExactPropWrapperFunction(propsDefinition)) {

diff --git a/lib/rules/prefer-stateless-function.js b/lib/rules/prefer-stateless-function.js
@@ -17,6 +17,7 @@ const docsUrl = require('../util/docsUrl');
 const report = require('../util/report');
 const eslintUtil = require('../util/eslint');
 
+const getScope = eslintUtil.getScope;
 const getText = eslintUtil.getText;
 
 // ------------------------------------------------------------------------------
@@ -345,7 +346,7 @@ module.exports = {
       // Mark `render` that do not return some JSX
       ReturnStatement(node) {
         let blockNode;
-        let scope = context.getScope();
+        let scope = getScope(context, node);
         while (scope) {
           blockNode = scope.block && scope.block.parent;
           if (blockNode && (blockNode.type === 'MethodDefinition' || blockNode.type === 'Property')) {

diff --git a/lib/rules/react-in-jsx-scope.js b/lib/rules/react-in-jsx-scope.js
@@ -37,7 +37,7 @@ module.exports = {
     const pragma = pragmaUtil.getFromContext(context);
 
     function checkIfReactIsInScope(node) {
-      const variables = variableUtil.variablesInScope(context);
+      const variables = variableUtil.variablesInScope(context, node);
       if (variableUtil.findVariable(variables, pragma)) {
         return;
       }