Handle local jquery vars in no-jquery-methods

Author: nlfurniss

lib/rules/no-jquery-methods.js

@@ -3,7 +3,7 @@
  */
 'use strict';
 
-const { get } = require('../utils/get');
+const { get, getParent } = require('../utils/get');
 const { isJQueryCallee, isVariableAssigmentJquery } = require('../utils/jquery');
 
 function getMessage(blackListName) {
@@ -28,26 +28,35 @@ module.exports = {
   },
   create(context) {
     const BLACKLIST = context.options[0] || [];
-    let jQueryLocalName = null;
+    let funcScopeJqueryVariables = [];
+    let moduleScopeJqueryVariables = [];
 
     return {
 
       ImportDeclaration(node) {
         let localName = getLocalImportName(node, 'jquery');
         if (localName.length > 0) {
-          jQueryLocalName = localName[0];
+          moduleScopeJqueryVariables.push(localName[0]);
         }
       },
 
       VariableDeclarator(node) {
-        const varName = get(node, 'id.name');
-        jQueryLocalName = isVariableAssigmentJquery(node) ? varName : null;
+        if (isVariableAssigmentJquery(node)) {
+          const varName = get(node, 'id.name');
+          const isFuncScope = !!getParent(node, (parent) => parent.type === 'FunctionDeclaration'); // Determine if variable is in function scope or global scope.
+
+          if (isFuncScope) {
+            funcScopeJqueryVariables.push(varName);
+          } else {
+            moduleScopeJqueryVariables.push(varName);
+          }
+        }
       },
 
       CallExpression(node) {
         const calleeName = get(node, 'callee.property.name');
         const parentCalleeName = get(node, 'callee.object.property.name');
-        if (BLACKLIST.includes(calleeName) && (parentCalleeName === '$' || isJQueryCallee(node, jQueryLocalName))) {
+        if (BLACKLIST.includes(calleeName) && (parentCalleeName === '$' || isJQueryCallee(node, moduleScopeJqueryVariables, funcScopeJqueryVariables))) {
           context.report({ node: node.callee.property, message: getMessage(`${parentCalleeName}.${calleeName}()`) });
         }
       },
@@ -61,9 +70,14 @@ module.exports = {
         let blackListName = BLACKLIST.includes(propertyName) ? propertyName : false;
         let isThisExpression = get(node, 'object.type').includes('ThisExpression');
 
-        if (!isThisExpression && blackListName && isJQueryCallee(node, jQueryLocalName)) {
+        if (!isThisExpression && blackListName && isJQueryCallee(node, moduleScopeJqueryVariables, funcScopeJqueryVariables)) {
           context.report({ node: node.property, message: getMessage(blackListName) });
         }
+      },
+
+      FunctionDeclaration() {
+        // Reset the function scope variables for each function declaration.
+        funcScopeJqueryVariables.length = 0;
       }
     };
   }

lib/utils/jquery.js

@@ -2,16 +2,24 @@ const { get } = require('../utils/get');
 
 const JQUERY_ALIASES = ['$', 'jQuery'];
 
-function isJQueryCallee(node, name = null) {
-  const calleePropertyNameisJquery = JQUERY_ALIASES.includes(get(node, 'object.callee.property.name'));
-  const calleeNameIsJquery = JQUERY_ALIASES.includes(get(node, 'object.callee.name'));
-  const calleeNameIsLocalJquery = get(node, 'object.callee.name') === name;
-  const objectNameisLocalJquery = get(node, 'object.name') === name;
+/**
+ * Determines whether a given node's callee is jQuery.
+ * @param {ASTNode} node
+ * @param {...Array} localJqueryVars Array(s) of local variables that have jQuery assigned to them.
+ * @return {Boolean}
+ */
+function isJQueryCallee(node, ...localJqueryVars) {
+  const allJqueryAliases = localJqueryVars.reduce((accumulator, newArray) => {
+    return accumulator.concat(newArray);
+  }, JQUERY_ALIASES);
+
+  const calleePropertyNameisJquery = allJqueryAliases.includes(get(node, 'object.callee.property.name'));
+  const calleeNameIsJquery = allJqueryAliases.includes(get(node, 'object.callee.name'));
+  const objectNameisJquery = allJqueryAliases.includes(get(node, 'object.name'));
 
   return calleePropertyNameisJquery
     || calleeNameIsJquery
-    || calleeNameIsLocalJquery
-    || objectNameisLocalJquery;
+    || objectNameisJquery;
 }
 
 /**
@@ -21,7 +29,7 @@ function isJQueryCallee(node, name = null) {
  */
 function getVarAssignmentName(node) {
   // Get the name of what was assigned to the variable.
-  return get(node, 'init.callee.property.name') || get(node, 'init.name');
+  return get(node, 'init.callee.property.name') || get(node, 'init.name') || get(node, 'init.property.name');
 }
 
 /**
@@ -31,7 +39,7 @@ function getVarAssignmentName(node) {
  */
 function isVarAssignmentCalleeEmber(node) {
   // A variable's callee object's name tells us whether this is a usage of Ember.$ or global $.
-  const isVarCalleeObjNameEmber = get(node, 'init.callee.object.name') === 'Ember';
+  const isVarCalleeObjNameEmber = get(node, 'init.callee.object.name') === 'Ember' || get(node, 'init.object.name') === 'Ember';
   // Whether or not the callee oject is `this.$`.
   const isVarCalleeObjThis = get(node, 'init.callee.object.type') === 'ThisExpression';
 

tests/lib/rules/no-jquery-methods.js

@@ -218,6 +218,67 @@ ruleTester.run('no-jquery-methods', rule, {
       errors: [{
         message: getMessage(`$.${BLACKLISTMETHOD}()`)
       }]
+    },
+    {
+      code: `
+        import jQ from 'jquery';
+        const jayQuery = Ember.$;
+
+        jayQuery('.class').add();
+        jQ('.class2').add();`,
+      options: [BLACKLISTMETHOD],
+      errors: [
+        { message: getMessage(BLACKLISTMETHOD) },
+        { message: getMessage(BLACKLISTMETHOD) }
+      ]
+    },
+    {
+      code: `
+        function func1() {
+          const jayQuery = Bar.foo;
+          jayQuery().add();
+        }
+
+        function func2() {
+          const jayQuery = Ember.$;
+          jayQuery().add();
+        }
+
+        function func3() {
+          const jayQuery = Obj.method;
+          jayQuery().add();
+        }
+
+        function func4() {
+          const jayQuery = $;
+          jayQuery().add();
+        }
+
+        function func5() {
+          const jayQuery = Foo.bar;
+          jayQuery().add();
+        }`,
+      options: [BLACKLISTMETHOD],
+      errors: [
+        { message: getMessage(BLACKLISTMETHOD) },
+        { message: getMessage(BLACKLISTMETHOD) }
+      ]
+    },
+    {
+      code: `
+        import jQ from 'jquery';
+        function func1() {
+          const jayQuery = Ember.$;
+          jayQuery().add();
+        }
+
+        jQ().add();
+      `,
+      options: [BLACKLISTMETHOD],
+      errors: [
+        { message: getMessage(BLACKLISTMETHOD) },
+        { message: getMessage(BLACKLISTMETHOD) }
+      ]
     }
   ]
 });