eslint-plugin-no-jquery 3.0.1 → 3.1.0

package/README.md

@@ -107,6 +107,7 @@ Where rules are included in the configs `recommended`, `slim`, `all` or `depreca
 * [`no-jquery/no-data`](docs/rules/no-data.md) `all`
 * [`no-jquery/no-deferred`](docs/rules/no-deferred.md) `all`
 * [`no-jquery/no-delegate`](docs/rules/no-delegate.md) `3.0`, `all`
+* [`no-jquery/no-done-fail`](docs/rules/no-done-fail.md) `all`
 * [`no-jquery/no-each`](docs/rules/no-each.md)
 * [`no-jquery/no-each-collection`](docs/rules/no-each-collection.md) `all`
 * [`no-jquery/no-each-util`](docs/rules/no-each-util.md) `all`
@@ -120,6 +121,7 @@ Where rules are included in the configs `recommended`, `slim`, `all` or `depreca
 * [`no-jquery/no-find`](docs/rules/no-find.md)
 * [`no-jquery/no-find-collection`](docs/rules/no-find-collection.md) `all`
 * [`no-jquery/no-find-util`](docs/rules/no-find-util.md) `all`
+* [`no-jquery/no-fx`](docs/rules/no-fx.md) `slim`
 * [`no-jquery/no-fx-interval`](docs/rules/no-fx-interval.md) `3.0`
 * [`no-jquery/no-global-eval`](docs/rules/no-global-eval.md) `all`
 * [`no-jquery/no-global-selector`](docs/rules/no-global-selector.md) ⚙️

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-no-jquery",
-	"version": "3.0.1",
+	"version": "3.1.0",
 	"description": "Disallow jQuery functions with native equivalents.",
 	"repository": {
 		"type": "git",
@@ -34,7 +34,7 @@
 	},
 	"devDependencies": {
 		"codecov": "^3.8.3",
-		"eslint-config-wikimedia": "^0.28.0",
+		"eslint-config-wikimedia": "^0.28.2",
 		"eslint-docgen": "^0.7.1",
 		"eslint-plugin-eslint-plugin": "^6.1.0",
 		"eslint-plugin-self": "^1.2.1",

package/src/index.js

@@ -25,6 +25,7 @@ module.exports = {
 		'no-deferred': require( './rules/no-deferred' ),
 		'no-delegate': require( './rules/no-delegate' ),
 		'no-die': require( './rules/no-die' ),
+		'no-done-fail': require( './rules/no-done-fail' ),
 		'no-each': require( './rules/no-each' ),
 		'no-each-collection': require( './rules/no-each-collection' ),
 		'no-each-util': require( './rules/no-each-util' ),
@@ -38,6 +39,7 @@ module.exports = {
 		'no-find': require( './rules/no-find' ),
 		'no-find-collection': require( './rules/no-find-collection' ),
 		'no-find-util': require( './rules/no-find-util' ),
+		'no-fx': require( './rules/no-fx' ),
 		'no-fx-interval': require( './rules/no-fx-interval' ),
 		'no-global-eval': require( './rules/no-global-eval' ),
 		'no-global-selector': require( './rules/no-global-selector' ),
@@ -117,6 +119,7 @@ module.exports = {
 				'no-jquery/no-animate-toggle': 'error',
 				'no-jquery/no-fade': 'error',
 				'no-jquery/no-slide': 'error',
+				'no-jquery/no-fx': 'error',
 				// Ajax
 				'no-jquery/no-ajax': 'error',
 				'no-jquery/no-ajax-events': 'error',
@@ -333,8 +336,10 @@ module.exports = {
 				'no-jquery/no-filter': 'warn',
 				'no-jquery/no-prop': 'warn',
 				'no-jquery/no-sub': 'warn',
-				'no-jquery/no-text': 'warn'
+				'no-jquery/no-text': 'warn',
 
+				// Other methods
+				'no-jquery/no-done-fail': 'warn'
 			}
 		}
 	}

package/src/rules/no-animate.js

@@ -2,13 +2,15 @@
 
 const utils = require( '../utils.js' );
 
+const methods = [ 'animate', 'stop', 'finish' ];
+
 module.exports = {
 	meta: {
 		type: 'suggestion',
 		docs: {
 			description:
-				'Disallows the ' + utils.jQueryCollectionLink( 'animate' ) +
-				' method. Use the `allowScroll` option to allow animations which are just used for scrolling. Prefer CSS transitions.'
+				'Disallows the ' + methods.map( utils.jQueryCollectionLink ).join( '/' ) +
+				' methods. Use the `allowScroll` option to allow animations which are just used for scrolling. Prefer CSS transitions.'
 		},
 		schema: [
 			{
@@ -27,12 +29,12 @@ module.exports = {
 		'CallExpression:exit': ( node ) => {
 			if (
 				node.callee.type !== 'MemberExpression' ||
-					node.callee.property.name !== 'animate'
+					!methods.includes( node.callee.property.name )
 			) {
 				return;
 			}
 			const allowScroll = context.options[ 0 ] && context.options[ 0 ].allowScroll;
-			if ( allowScroll ) {
+			if ( node.callee.property.name === 'animate' && allowScroll ) {
 				const arg = node.arguments[ 0 ];
 				// Check properties list has more than just scrollTop/scrollLeft
 				if ( arg && arg.type === 'ObjectExpression' ) {

package/src/rules/no-append-html.js

@@ -1,7 +1,11 @@
 'use strict';
 
 const utils = require( '../utils.js' );
-const methods = [ 'append', 'prepend', 'before', 'after', 'replaceWith', 'add', 'appendTo', 'prependTo' ];
+// htmlStrings or jQuery collections
+const htmlOrCollectionMethods = [ 'append', 'prepend', 'before', 'after', 'replaceWith' ];
+// htmlStrings, selectors or jQuery collections
+const htmlOrSelectorOrCollectionMethods = [ 'add', 'appendTo', 'prependTo', 'insertBefore', 'insertAfter' ];
+const allMethods = htmlOrCollectionMethods.concat( htmlOrSelectorOrCollectionMethods );
 
 function alljQueryOrEmpty( context, node ) {
 	if ( node.type === 'ConditionalExpression' ) {
@@ -22,7 +26,7 @@ module.exports = {
 	meta: {
 		type: 'suggestion',
 		docs: {
-			description: 'Disallows using ' + methods.map( utils.jQueryCollectionLink ).join( '/' ) +
+			description: 'Disallows using ' + allMethods.map( utils.jQueryCollectionLink ).join( '/' ) +
 			' to inject HTML, in order to prevent possible XSS bugs.'
 		},
 		schema: []
@@ -32,13 +36,18 @@ module.exports = {
 		'CallExpression:exit': ( node ) => {
 			if ( !(
 				node.callee.type === 'MemberExpression' &&
-					methods.includes( node.callee.property.name )
+				allMethods.includes( node.callee.property.name )
 			) ) {
 				return;
 			}
 			if ( node.arguments.every( ( arg ) => alljQueryOrEmpty( context, arg ) ) ) {
 				return;
 			}
+			if ( htmlOrSelectorOrCollectionMethods.includes( node.callee.property.name ) ) {
+				if ( node.arguments.every( ( arg ) => !utils.isHtmlString( arg ) ) ) {
+					return;
+				}
+			}
 
 			if ( utils.isjQuery( context, node.callee ) ) {
 				context.report( {

package/src/rules/no-done-fail.js

@@ -0,0 +1,11 @@
+'use strict';
+
+const utils = require( '../utils.js' );
+
+module.exports = utils.createUniversalMethodRule(
+	[ 'done', 'fail' ],
+	( node ) => node === true ?
+		'Prefer `.then`' :
+		`Prefer .then to .${ node.callee.property.name }`,
+	( method ) => `[\`.${ method }\`](https://api.jquery.com/deferred.${ method }/)`
+);

package/src/rules/no-event-shorthand.js

@@ -44,8 +44,9 @@ const rule = utils.createCollectionMethodRule(
 		'mousemove',
 		'mouseout',
 		'mouseover',
-		'mouseup'
-	].concat( ajaxEvents ),
+		'mouseup',
+		...ajaxEvents
+	],
 	( node ) => node === true ?
 		'Use the `allowAjaxEvents` option to allow `ajax*` methods. Prefer `.on` or `.trigger`' :
 		`Prefer .on or .trigger to .${ node.callee.property.name }`,

package/src/rules/no-extend.js

@@ -48,7 +48,9 @@ module.exports = {
 				node,
 				message: 'Prefer Object.assign or the spread operator to $.extend',
 				fix: function ( fixer ) {
-					if ( !isDeep ) {
+					// Only auto-fix if we are sure the first argument is an object.
+					// If it is undefined or null variable, then Object.assign will throw.
+					if ( !isDeep && node.arguments[ 0 ] && node.arguments[ 0 ].type === 'ObjectExpression' ) {
 						return fixer.replaceText( node.callee, 'Object.assign' );
 					}
 				}

package/src/rules/no-fx.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const utils = require( '../utils.js' );
+
+module.exports = {
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Disallows `$.fx`.'
+		},
+		schema: []
+	},
+
+	create: ( context ) => ( {
+		MemberExpression: ( node ) => {
+			if (
+				!utils.isjQueryConstructor( context, node.object.name ) ||
+					node.property.name !== 'fx'
+			) {
+				return;
+			}
+
+			context.report( {
+				node,
+				message: '$.fx is not allowed'
+			} );
+		}
+	} )
+};

package/src/rules/no-parse-html-literal.js

@@ -2,33 +2,11 @@
 
 const utils = require( '../utils.js' );
 
-// HTML regex (modified from jQuery)
-const rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*)$/;
 // Single tag regex (from jQuery)
 const rsingleTag = /^<([a-z][^/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;
 const rsingleTagMinimal = /^<([a-z][^/\0>:\x20\t\r\n\f]*)>$/i;
 const rsingleTagSelfClosing = /^<([a-z][^/\0>:\x20\t\r\n\f]*)\/>$/i;
 
-function allLiteral( node ) {
-	if ( node.type === 'BinaryExpression' ) {
-		return allLiteral( node.left ) && allLiteral( node.right );
-	} else {
-		return node.type === 'Literal';
-	}
-}
-
-function joinLiterals( node ) {
-	if ( node.type === 'BinaryExpression' ) {
-		return joinLiterals( node.left ) + joinLiterals( node.right );
-	}
-	/* istanbul ignore else */
-	if ( node.type === 'Literal' ) {
-		return node.value;
-	}
-	/* istanbul ignore next */
-	throw new Error( 'Non-literal node passed to joinLiteral' );
-}
-
 module.exports = {
 	meta: {
 		type: 'suggestion',
@@ -94,11 +72,10 @@ module.exports = {
 			let expectedTag;
 			const arg = node.arguments[ 0 ];
 			if ( allowSingle ) {
-				const value = arg && allLiteral( arg ) && joinLiterals( arg );
-				if ( !( typeof value === 'string' && value ) || !rquickExpr.exec( value ) ) {
-					// Empty or non-string, or non-HTML
+				if ( !utils.isHtmlString( arg ) ) {
 					return;
 				}
+				const value = utils.joinLiterals( arg );
 				let match;
 				if ( ( match = rsingleTag.exec( value ) ) ) {
 					// Single tag
@@ -122,7 +99,7 @@ module.exports = {
 						return;
 					}
 				}
-			} else if ( !( arg && allLiteral( arg ) ) ) {
+			} else if ( !( arg && utils.allLiteral( arg ) ) ) {
 				// Non literals passed to $.parseHTML
 				return;
 			}

package/src/rules/no-sizzle.js

@@ -2,19 +2,6 @@
 
 const utils = require( '../utils.js' );
 
-function collectLiterals( node ) {
-	if ( node.type === 'BinaryExpression' ) {
-		return collectLiterals( node.left ) + collectLiterals( node.right );
-	} else if ( node.type === 'Literal' ) {
-		return node.value;
-	} else if ( node.type === 'Identifier' ) {
-		// Dummy value for regex matching
-		return 'A0';
-	} else {
-		return '';
-	}
-}
-
 module.exports = {
 	meta: {
 		type: 'suggestion',
@@ -79,7 +66,7 @@ module.exports = {
 					context.options[ 0 ].allowPositional;
 				const allowOther = context.options[ 0 ] &&
 					context.options[ 0 ].allowOther;
-				const value = collectLiterals( node.arguments[ 0 ] );
+				const value = utils.joinLiterals( node.arguments[ 0 ] );
 
 				if ( !allowPositional && forbiddenPositional.test( value ) ) {
 					context.report( {

package/src/utils.js

@@ -173,6 +173,7 @@ function isjQueryConstructor( context, name ) {
 //
 // Returns true if the function call node is attached to a jQuery element set.
 function isjQuery( context, node ) {
+	// eslint-disable-next-line security/detect-non-literal-regexp
 	const variablePattern = new RegExp(
 		( context.settings && context.settings[ 'no-jquery' ] && context.settings[ 'no-jquery' ].variablePattern ) ||
 		'^\\$.'
@@ -311,7 +312,7 @@ function createCollectionMethodRule( methods, message, options ) {
 	methods = Array.isArray( methods ) ? methods : [ methods ];
 
 	let description = 'Disallows the ' + methods.map( jQueryCollectionLink ).join( '/' ) + ' ' +
-			( methods.length > 1 ? 'methods' : 'method' ) + '.';
+		( methods.length > 1 ? 'methods' : 'method' ) + '.';
 
 	description += messageSuffix( message );
 
@@ -369,7 +370,7 @@ function createCollectionMethodRule( methods, message, options ) {
 }
 
 /**
- * Create a rule for collection property
+ * Create a rule for collection properties
  *
  * @param {string} property Property name
  * @param {string|Function} [message] Message to report. See createCollectionMethodRule.
@@ -421,7 +422,7 @@ function createUtilMethodRule( methods, message, options ) {
 	methods = Array.isArray( methods ) ? methods : [ methods ];
 
 	let description = 'Disallows the ' + methods.map( jQueryGlobalLink ).join( '/' ) + ' ' +
-			( methods.length > 1 ? 'utilies' : 'utility' ) + '.';
+		( methods.length > 1 ? 'utilies' : 'utility' ) + '.';
 
 	description += messageSuffix( message );
 
@@ -448,7 +449,7 @@ function createUtilMethodRule( methods, message, options ) {
 }
 
 /**
- * Create a rule for util methods
+ * Create a rule for util properties
  *
  * @param {string} property Property name
  * @param {string|Function} [message] Message to report. See createCollectionMethodRule.
@@ -499,7 +500,7 @@ function createCollectionOrUtilMethodRule( methods, message, options ) {
 	methods = Array.isArray( methods ) ? methods : [ methods ];
 
 	let description = 'Disallows the ' + methods.map( jQueryCollectionLink ).join( '/' ) + ' ' +
-			( methods.length > 1 ? 'methods' : 'method' );
+		( methods.length > 1 ? 'methods' : 'method' );
 
 	description += ' and ' + methods.map( jQueryGlobalLink ).join( '/' ) + ' ' +
 			( methods.length > 1 ? 'utilies' : 'utility' ) + '.';
@@ -526,6 +527,47 @@ function createCollectionOrUtilMethodRule( methods, message, options ) {
 	} ), description, options.fixable, options.deprecated );
 }
 
+/**
+ * Create a rule for a method on any object
+ *
+ * @param {string|string[]} methods Method or list of method names
+ * @param {string|Function} message Message to report. See createCollectionMethodRule.
+ * @param {Function} linkGenerator Function to generate a markdown link
+ * @param {Object} [options] Options. See createCollectionMethodRule.
+ *  for a given function name.
+ * @return {Object} Rule
+ */
+function createUniversalMethodRule( methods, message, linkGenerator, options ) {
+	options = options || {};
+
+	options.mode = 'util';
+
+	methods = Array.isArray( methods ) ? methods : [ methods ];
+
+	let description = 'Disallows the ' + methods.map( linkGenerator ).join( '/' ) + ' ' +
+		( methods.length > 1 ? 'methods' : 'method' ) + '.';
+
+	description += messageSuffix( message );
+
+	return createRule( ( context ) => ( {
+		'CallExpression:exit': ( node ) => {
+			if ( node.callee.type !== 'MemberExpression' ) {
+				return;
+			}
+			const name = node.callee.property.name;
+			if ( !methods.includes( name ) ) {
+				return;
+			}
+
+			context.report( {
+				node,
+				message: messageToPlainString( message, node, name, options ),
+				fix: options.fix && options.fix.bind( this, node, context )
+			} );
+		}
+	} ), description, options.fixable, options.deprecated );
+}
+
 function eventShorthandFixer( node, context, fixer ) {
 	const name = node.callee.property.name;
 	if ( node.callee.parent.arguments.length ) {
@@ -541,6 +583,35 @@ function eventShorthandFixer( node, context, fixer ) {
 	}
 }
 
+function allLiteral( node ) {
+	if ( node.type === 'BinaryExpression' ) {
+		return allLiteral( node.left ) && allLiteral( node.right );
+	} else {
+		return node.type === 'Literal';
+	}
+}
+
+function joinLiterals( node ) {
+	if ( node.type === 'BinaryExpression' ) {
+		return joinLiterals( node.left ) + joinLiterals( node.right );
+	} else if ( node.type === 'Literal' ) {
+		return node.value;
+	} else if ( node.type === 'Identifier' ) {
+		// Dummy value for regex matching
+		return 'A0';
+	} else {
+		return '';
+	}
+}
+
+// HTML regex (modified from jQuery)
+const rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*)$/;
+
+function isHtmlString( arg ) {
+	const value = arg && allLiteral( arg ) && joinLiterals( arg );
+	return typeof value === 'string' && value && rquickExpr.exec( value );
+}
+
 module.exports = {
 	isjQuery,
 	isjQueryConstructor,
@@ -550,7 +621,11 @@ module.exports = {
 	createUtilMethodRule,
 	createUtilPropertyRule,
 	createCollectionOrUtilMethodRule,
+	createUniversalMethodRule,
 	eventShorthandFixer,
 	jQueryCollectionLink,
-	jQueryGlobalLink
+	jQueryGlobalLink,
+	allLiteral,
+	joinLiterals,
+	isHtmlString
 };