[Refactor] extract getKeyValue, isAssignmentLHS to ast util

ljharb · ljharb · commit ef7f6eb306b7 · 2019-05-19T13:45:51.000-07:00
diff --git a/lib/rules/destructuring-assignment.js b/lib/rules/destructuring-assignment.js
@@ -6,6 +6,7 @@
 
 const Components = require('../util/Components');
 const docsUrl = require('../util/docsUrl');
+const isAssignmentLHS = require('../util/ast').isAssignmentLHS;
 
 const DEFAULT_OPTION = 'always';
 
@@ -38,19 +39,6 @@ module.exports = {
     const configuration = context.options[0] || DEFAULT_OPTION;
     const ignoreClassFields = context.options[1] && context.options[1].ignoreClassFields === true || false;
 
-    /**
-    * Checks if a prop is being assigned a value props.bar = 'bar'
-    * @param {ASTNode} node The AST node being checked.
-    * @returns {Boolean}
-    */
-
-    function isAssignmentToProp(node) {
-      return (
-        node.parent &&
-        node.parent.type === 'AssignmentExpression' &&
-        node.parent.left === node
-      );
-    }
     /**
      * @param {ASTNode} node We expect either an ArrowFunctionExpression,
      *   FunctionDeclaration, or FunctionExpression
@@ -74,7 +62,7 @@ module.exports = {
 
     function handleSFCUsage(node) {
       // props.aProp || context.aProp
-      const isPropUsed = (node.object.name === 'props' || node.object.name === 'context') && !isAssignmentToProp(node);
+      const isPropUsed = (node.object.name === 'props' || node.object.name === 'context') && !isAssignmentLHS(node);
       if (isPropUsed && configuration === 'always') {
         context.report({
           node,
@@ -99,7 +87,7 @@ module.exports = {
       const isPropUsed = (
         node.object.type === 'MemberExpression' && node.object.object.type === 'ThisExpression' &&
         (node.object.property.name === 'props' || node.object.property.name === 'context' || node.object.property.name === 'state') &&
-        !isAssignmentToProp(node)
+        !isAssignmentLHS(node)
       );
 
       if (
diff --git a/lib/rules/forbid-foreign-prop-types.js b/lib/rules/forbid-foreign-prop-types.js
@@ -6,6 +6,7 @@
 'use strict';
 
 const docsUrl = require('../util/docsUrl');
+const ast = require('../util/ast');
 
 module.exports = {
   meta: {
@@ -37,10 +38,6 @@ module.exports = {
     // Helpers
     // --------------------------------------------------------------------------
 
-    function isLeftSideOfAssignment(node) {
-      return node.parent.type === 'AssignmentExpression' && node.parent.left === node;
-    }
-
     function findParentAssignmentExpression(node) {
       let parent = node.parent;
 
@@ -101,12 +98,12 @@ module.exports = {
             !node.computed &&
             node.property.type === 'Identifier' &&
             node.property.name === 'propTypes' &&
-            !isLeftSideOfAssignment(node) &&
+            !ast.isAssignmentLHS(node) &&
             !isAllowedAssignment(node)
           ) || (
             (node.property.type === 'Literal' || node.property.type === 'JSXText') &&
             node.property.value === 'propTypes' &&
-            !isLeftSideOfAssignment(node) &&
+            !ast.isAssignmentLHS(node) &&
             !isAllowedAssignment(node)
           )
         ) {
diff --git a/lib/util/ast.js b/lib/util/ast.js
@@ -150,13 +150,54 @@ function isClass(node) {
   return node.type === 'ClassDeclaration' || node.type === 'ClassExpression';
 }
 
+/**
+ * Removes quotes from around an identifier.
+ * @param {string} string the identifier to strip
+ */
+function stripQuotes(string) {
+  return string.replace(/^'|'$/g, '');
+}
+
+/**
+ * Retrieve the name of a key node
+ * @param {Context} context The AST node with the key.
+ * @param {ASTNode} node The AST node with the key.
+ * @return {string} the name of the key
+ */
+function getKeyValue(context, node) {
+  if (node.type === 'ObjectTypeProperty') {
+    const tokens = context.getFirstTokens(node, 2);
+    return (tokens[0].value === '+' || tokens[0].value === '-' ?
+      tokens[1].value :
+      stripQuotes(tokens[0].value)
+    );
+  }
+  const key = node.key || node.argument;
+  return key.type === 'Identifier' ? key.name : key.value;
+}
+
+/**
+ * Checks if a node is being assigned a value: props.bar = 'bar'
+ * @param {ASTNode} node The AST node being checked.
+ * @returns {Boolean}
+ */
+function isAssignmentLHS(node) {
+  return (
+    node.parent &&
+    node.parent.type === 'AssignmentExpression' &&
+    node.parent.left === node
+  );
+}
+
 module.exports = {
   findReturnStatement,
   getFirstNodeInLine,
   getPropertyName,
   getPropertyNameNode,
   getComponentProperties,
+  getKeyValue,
   isArrowFunction,
+  isAssignmentLHS,
   isClass,
   isFunction,
   isFunctionLikeExpression,
diff --git a/lib/util/propTypes.js b/lib/util/propTypes.js
@@ -8,7 +8,8 @@ const annotations = require('./annotations');
 const propsUtil = require('./props');
 const variableUtil = require('./variable');
 const versionUtil = require('./version');
-const propWrapperUtil = require('../util/propWrapper');
+const propWrapperUtil = require('./propWrapper');
+const getKeyValue = require('./ast').getKeyValue;
 
 /**
  * Checks if we are declaring a props as a generic type in a flow-annotated class.
@@ -25,32 +26,6 @@ function isSuperTypeParameterPropsDeclaration(node) {
   return false;
 }
 
-/**
- * Removes quotes from around an identifier.
- * @param {string} string the identifier to strip
- */
-function stripQuotes(string) {
-  return string.replace(/^'|'$/g, '');
-}
-
-/**
- * Retrieve the name of a key node
- * @param {Context} context The AST node with the key.
- * @param {ASTNode} node The AST node with the key.
- * @return {string} the name of the key
- */
-function getKeyValue(context, node) {
-  if (node.type === 'ObjectTypeProperty') {
-    const tokens = context.getFirstTokens(node, 2);
-    return (tokens[0].value === '+' || tokens[0].value === '-' ?
-      tokens[1].value :
-      stripQuotes(tokens[0].value)
-    );
-  }
-  const key = node.key || node.argument;
-  return key.type === 'Identifier' ? key.name : key.value;
-}
-
 /**
  * Iterates through a properties node, like a customized forEach.
  * @param {Object} context Array of properties to iterate.
diff --git a/lib/util/usedPropTypes.js b/lib/util/usedPropTypes.js
@@ -6,6 +6,7 @@
 
 const astUtil = require('./ast');
 const versionUtil = require('./version');
+const ast = require('./ast');
 
 // ------------------------------------------------------------------------------
 // Constants
@@ -176,31 +177,6 @@ module.exports = function usedPropTypesInstructions(context, components, utils)
     return tokens.length && tokens[0].value === '...';
   }
 
-  /**
-   * Removes quotes from around an identifier.
-   * @param {string} string the identifier to strip
-   */
-  function stripQuotes(string) {
-    return string.replace(/^'|'$/g, '');
-  }
-
-  /**
-   * Retrieve the name of a key node
-   * @param {ASTNode} node The AST node with the key.
-   * @return {string} the name of the key
-   */
-  function getKeyValue(node) {
-    if (node.type === 'ObjectTypeProperty') {
-      const tokens = context.getFirstTokens(node, 2);
-      return (tokens[0].value === '+' || tokens[0].value === '-' ?
-        tokens[1].value :
-        stripQuotes(tokens[0].value)
-      );
-    }
-    const key = node.key || node.argument;
-    return key.type === 'Identifier' ? key.name : key.value;
-  }
-
   /**
    * Retrieve the name of a property node
    * @param {ASTNode} node The AST node with the property.
@@ -251,19 +227,6 @@ module.exports = function usedPropTypesInstructions(context, components, utils)
     }
   }
 
-  /**
-   * Checks if a prop is being assigned a value props.bar = 'bar'
-   * @param {ASTNode} node The AST node being checked.
-   * @returns {Boolean}
-   */
-  function isAssignmentToProp(node) {
-    return (
-      node.parent &&
-      node.parent.type === 'AssignmentExpression' &&
-      node.parent.left === node
-    );
-  }
-
   /**
    * Checks if we are using a prop
    * @param {ASTNode} node The AST node being checked.
@@ -276,7 +239,7 @@ module.exports = function usedPropTypesInstructions(context, components, utils)
       (utils.getParentES6Component() || utils.getParentES5Component()) &&
       (isThisPropsUsage || isPropArgumentInSetStateUpdater(node))
     );
-    const isStatelessFunctionUsage = node.object.name === 'props' && !isAssignmentToProp(node);
+    const isStatelessFunctionUsage = node.object.name === 'props' && !ast.isAssignmentLHS(node);
     return isClassUsage || isStatelessFunctionUsage || (isPropsUsage && inLifeCycleMethod());
   }
 
@@ -309,7 +272,7 @@ module.exports = function usedPropTypesInstructions(context, components, utils)
           node.parent.id &&
           node.parent.id.properties &&
           node.parent.id.properties.length &&
-          getKeyValue(node.parent.id.properties[0])
+          ast.getKeyValue(context, node.parent.id.properties[0])
         ) {
           type = 'destructuring';
           properties = node.parent.id.properties;
@@ -391,7 +354,7 @@ module.exports = function usedPropTypesInstructions(context, components, utils)
             ignoreUnusedPropTypesValidation = true;
             break;
           }
-          const propName = getKeyValue(properties[k]);
+          const propName = ast.getKeyValue(context, properties[k]);
 
           let currentNode = node;
           allNames = [];
