eslint-plugin-no-jquery 2.4.0 → 2.7.0

package/src/utils.js

@@ -26,7 +26,7 @@ function traverse( context, node, variableTest, constructorTest ) {
 						return false;
 					} else {
 						if (
-							nonCollectionReturningMethods.indexOf( name ) !== -1 ||
+							nonCollectionReturningMethods.includes( name ) ||
 							collectionReturningPlugins[ name ] === 'never'
 						) {
 							// e.g. $foo.toArray()
@@ -35,7 +35,7 @@ function traverse( context, node, variableTest, constructorTest ) {
 
 						if (
 							(
-								nonCollectionReturningAccessors.indexOf( name ) !== -1 ||
+								nonCollectionReturningAccessors.includes( name ) ||
 								collectionReturningPlugins[ name ] === 'accessor'
 							) &&
 							node.arguments.length === 0
@@ -46,7 +46,7 @@ function traverse( context, node, variableTest, constructorTest ) {
 
 						if (
 							(
-								nonCollectionReturningValueAccessors.indexOf( name ) !== -1 ||
+								nonCollectionReturningValueAccessors.includes( name ) ||
 								collectionReturningPlugins[ name ] === 'valueAccessor'
 							) &&
 							(
@@ -97,7 +97,7 @@ function traverse( context, node, variableTest, constructorTest ) {
 						}
 
 						if (
-							allKnownMethods.indexOf( name ) === -1 &&
+							!allKnownMethods.includes( name ) &&
 							!( name in collectionReturningPlugins )
 						) {
 							// The method is not core jQuery, so we don't know if it returns
@@ -113,7 +113,7 @@ function traverse( context, node, variableTest, constructorTest ) {
 
 				break;
 			case 'MemberExpression':
-				if ( node.property && node.parent.type !== 'CallExpression' ) {
+				if ( node.property && !( node.parent.type === 'CallExpression' && node.parent.callee === node ) ) {
 					if ( node.property.type === 'Identifier' ) {
 						if ( node.computed ) {
 							// e.g. foo[bar] can't be determined, returns false
@@ -132,7 +132,7 @@ function traverse( context, node, variableTest, constructorTest ) {
 				node = node.object;
 				break;
 			case 'Identifier':
-				if ( node.parent && node.parent.type === 'CallExpression' ) {
+				if ( node.parent && node.parent.type === 'CallExpression' && node.parent.callee === node ) {
 					return constructorTest( node );
 				} else {
 					return variableTest( node ) || constructorTest( node );
@@ -141,13 +141,15 @@ function traverse( context, node, variableTest, constructorTest ) {
 				return false;
 		}
 	}
+	/* istanbul ignore next */
+	throw new Error( 'Invalid node' );
 }
 
 function isjQueryConstructor( context, name ) {
 	const constructorAliases =
 		( context.settings && context.settings[ 'no-jquery' ] && context.settings[ 'no-jquery' ].constructorAliases ) ||
 		[ '$', 'jQuery' ];
-	return constructorAliases.indexOf( name ) !== -1;
+	return constructorAliases.includes( name );
 }
 
 // Traverses from a node up to its root parent to determine if it
@@ -193,9 +195,10 @@ function isjQuery( context, node ) {
  * @param {string} [fixable] Fixable mode, e.g. 'code'
  * @param {string[]|boolean} [deprecated] Rule is deprecated.
  *  If a string list, the replacedBy rules.
+ * @param {Array} schema Schema
  * @return {Object} Rule
  */
-function createRule( create, description, fixable, deprecated ) {
+function createRule( create, description, fixable, deprecated, schema ) {
 	return {
 		meta: {
 			type: 'suggestion',
@@ -205,7 +208,7 @@ function createRule( create, description, fixable, deprecated ) {
 				replacedBy: Array.isArray( deprecated ) ? deprecated : undefined
 			},
 			fixable: fixable,
-			schema: []
+			schema: schema || []
 		},
 		create: create
 	};
@@ -296,6 +299,8 @@ function jQueryGlobalLink( name ) {
  * @param {Function} [options.fix] Fixing function. First argument is `node`.
  * @param {string[]|boolean} [options.deprecated] Rule is deprecated.
  *  If a string list, the replacedBy rules.
+ * @param {boolean} [options.getAndSetOptions] Create options to enabled getting and setting
+ *  separately.
  * @return {Object} Rule
  */
 function createCollectionMethodRule( methods, message, options ) {
@@ -310,30 +315,59 @@ function createCollectionMethodRule( methods, message, options ) {
 
 	description += messageSuffix( message );
 
+	let schema = [];
+	if ( options.getAndSetOptions ) {
+		schema = [
+			{
+				type: 'object',
+				properties: {
+					allowGetOrSet: {
+						enum: [ 'none', 'get', 'set' ]
+					}
+				},
+				additionalProperties: false
+			}
+		];
+
+		// TODO: nonCollectionReturningValueAccessors have 1 argument in getter mode
+		description += '\n\nUsing this method only as a getter or a setter can be allowed using the `allowGetOrSet` option:\n' +
+			'* `"none"` (default) the method can\'t be used at all\n' +
+			'* `"get"` the method can only be used as a getter i.e. with no arguments\n' +
+			'* `"set"` the method can only be used as a setter i.e. with arguments';
+	}
+
 	return createRule( function ( context ) {
 		return {
-			CallExpression: function ( node ) {
+			'CallExpression:exit': function ( node ) {
 				if ( node.callee.type !== 'MemberExpression' ) {
 					return;
 				}
 				const name = node.callee.property.name;
 				if (
-					methods.indexOf( name ) === -1 ||
+					!methods.includes( name ) ||
 					isjQueryConstructor( context, node.callee.object.name )
 				) {
 					return;
 				}
+				const allowGetOrSet = ( context.options[ 0 ] && context.options[ 0 ].allowGetOrSet ) || 'none';
+				// TODO: nonCollectionReturningValueAccessors have 1 argument in getter mode
+				if (
+					( allowGetOrSet === 'get' && !node.arguments.length ) ||
+					( allowGetOrSet === 'set' && node.arguments.length )
+				) {
+					return;
+				}
 
 				if ( isjQuery( context, node.callee ) ) {
 					context.report( {
 						node: node,
 						message: messageToPlainString( message, node, name, options ),
-						fix: options.fix && options.fix.bind( this, node )
+						fix: options.fix && options.fix.bind( this, node, context )
 					} );
 				}
 			}
 		};
-	}, description, options.fixable, options.deprecated );
+	}, description, options.fixable, options.deprecated, schema );
 }
 
 /**
@@ -355,7 +389,7 @@ function createCollectionPropertyRule( property, message, options ) {
 
 	return createRule( function ( context ) {
 		return {
-			MemberExpression: function ( node ) {
+			'MemberExpression:exit': function ( node ) {
 				const name = node.property.name;
 				if (
 					name !== property ||
@@ -367,7 +401,7 @@ function createCollectionPropertyRule( property, message, options ) {
 					context.report( {
 						node: node,
 						message: messageToPlainString( message, node, name, options ),
-						fix: options.fix && options.fix.bind( this, node )
+						fix: options.fix && options.fix.bind( this, node, context )
 					} );
 				}
 			}
@@ -397,13 +431,13 @@ function createUtilMethodRule( methods, message, options ) {
 
 	return createRule( function ( context ) {
 		return {
-			CallExpression: function ( node ) {
+			'CallExpression:exit': function ( node ) {
 				if ( node.callee.type !== 'MemberExpression' ) {
 					return;
 				}
 				const name = node.callee.property.name;
 				if (
-					methods.indexOf( name ) === -1 ||
+					!methods.includes( name ) ||
 					!isjQueryConstructor( context, node.callee.object.name )
 				) {
 					return;
@@ -412,7 +446,7 @@ function createUtilMethodRule( methods, message, options ) {
 				context.report( {
 					node: node,
 					message: messageToPlainString( message, node, name, options ),
-					fix: options.fix && options.fix.bind( this, node )
+					fix: options.fix && options.fix.bind( this, node, context )
 				} );
 			}
 		};
@@ -438,7 +472,7 @@ function createUtilPropertyRule( property, message, options ) {
 
 	return createRule( function ( context ) {
 		return {
-			MemberExpression: function ( node ) {
+			'MemberExpression:exit': function ( node ) {
 				if ( !isjQueryConstructor( context, node.object.name ) ) {
 					return;
 				}
@@ -450,7 +484,7 @@ function createUtilPropertyRule( property, message, options ) {
 				context.report( {
 					node: node,
 					message: messageToPlainString( message, node, name, options ),
-					fix: options.fix && options.fix.bind( this, node )
+					fix: options.fix && options.fix.bind( this, node, context )
 				} );
 			}
 		};
@@ -482,19 +516,19 @@ function createCollectionOrUtilMethodRule( methods, message, options ) {
 
 	return createRule( function ( context ) {
 		return {
-			CallExpression: function ( node ) {
+			'CallExpression:exit': function ( node ) {
 				if ( node.callee.type !== 'MemberExpression' ) {
 					return;
 				}
 				const name = node.callee.property.name;
-				if ( methods.indexOf( name ) === -1 ) {
+				if ( !methods.includes( name ) ) {
 					return;
 				}
 				if ( isjQuery( context, node.callee ) ) {
 					context.report( {
 						node: node,
 						message: messageToPlainString( message, node, name, options ),
-						fix: options.fix && options.fix.bind( this, node )
+						fix: options.fix && options.fix.bind( this, node, context )
 					} );
 				}
 			}
@@ -502,7 +536,7 @@ function createCollectionOrUtilMethodRule( methods, message, options ) {
 	}, description, options.fixable, options.deprecated );
 }
 
-function eventShorthandFixer( node, fixer ) {
+function eventShorthandFixer( node, context, fixer ) {
 	const name = node.callee.property.name;
 	if ( node.callee.parent.arguments.length ) {
 		return [
@@ -512,7 +546,7 @@ function eventShorthandFixer( node, fixer ) {
 	} else {
 		return [
 			fixer.replaceText( node.callee.property, 'trigger' ),
-			fixer.insertTextBeforeRange( [ node.end - 1 ], JSON.stringify( name ) )
+			fixer.insertTextBeforeRange( [ node.range[ 1 ] - 1 ], JSON.stringify( name ) )
 		];
 	}
 }