eslint-plugin-no-jquery 2.7.0 → 3.0.0

package/README.md

@@ -38,7 +38,7 @@ Add `no-jquery` to the plugins section of your `.eslintrc` configuration file. Y
 
 The config **`plugin:no-jquery/recommended`** includes the recommended rule [`no-jquery/variable-pattern`](docs/rules/variable-pattern.md) which is required for method rules to work correctly.
 
-The config **`plugin:no-jquery/deprecated`** includes all known deprecated and removed code, and is updated as new releases of jQuery come out. You can instead use configs targeting specific versions of jQuery if you know the environment in which your code will operate. There is a config for all minor versions from 1.0 to 3.6 (`deprecated-1.0`, ..., `deprecated-3.6`). Deprecation configs are cumulative, so they include all the rules for jQuery versions below them.
+The config **`plugin:no-jquery/deprecated`** includes all known deprecated and removed code, and is updated as new releases of jQuery come out. You can instead use configs targeting specific versions of jQuery if you know the environment in which your code will operate. There is a config for all minor versions from 1.0 to 3.6 (`deprecated-1.0`, ..., `deprecated-3.7`). Deprecation configs are cumulative, so they include all the rules for jQuery versions below them.
 
 The config **`plugin:no-jquery/slim`** includes all features excluded from the official "slim" build of jQuery, specifically the [ajax](https://api.jquery.com/category/ajax/) and [effects](https://api.jquery.com/category/effects/) modules.
 
@@ -114,7 +114,7 @@ Where rules are included in the configs `recommended`, `slim`, `all` or `depreca
 * [`no-jquery/no-error-shorthand`](docs/rules/no-error-shorthand.md) 🔧 `1.8`
 * [`no-jquery/no-escape-selector`](docs/rules/no-escape-selector.md) 🔧 `all`
 * [`no-jquery/no-event-shorthand`](docs/rules/no-event-shorthand.md) ⚙️ 🔧 `3.5`, `3.3†`, `all`
-* [`no-jquery/no-extend`](docs/rules/no-extend.md) ⚙️ `all`
+* [`no-jquery/no-extend`](docs/rules/no-extend.md) ⚙️ 🔧 `all`
 * [`no-jquery/no-fade`](docs/rules/no-fade.md) `slim`, `all`
 * [`no-jquery/no-filter`](docs/rules/no-filter.md) `all`
 * [`no-jquery/no-find`](docs/rules/no-find.md)

package/README.md.template

@@ -37,7 +37,7 @@ Add `no-jquery` to the plugins section of your `.eslintrc` configuration file. Y
 
 The config **`plugin:no-jquery/recommended`** includes the recommended rule [`no-jquery/variable-pattern`](docs/rules/variable-pattern.md) which is required for method rules to work correctly.
 
-The config **`plugin:no-jquery/deprecated`** includes all known deprecated and removed code, and is updated as new releases of jQuery come out. You can instead use configs targeting specific versions of jQuery if you know the environment in which your code will operate. There is a config for all minor versions from 1.0 to 3.6 (`deprecated-1.0`, ..., `deprecated-3.6`). Deprecation configs are cumulative, so they include all the rules for jQuery versions below them.
+The config **`plugin:no-jquery/deprecated`** includes all known deprecated and removed code, and is updated as new releases of jQuery come out. You can instead use configs targeting specific versions of jQuery if you know the environment in which your code will operate. There is a config for all minor versions from 1.0 to 3.6 (`deprecated-1.0`, ..., `deprecated-3.7`). Deprecation configs are cumulative, so they include all the rules for jQuery versions below them.
 
 The config **`plugin:no-jquery/slim`** includes all features excluded from the official "slim" build of jQuery, specifically the [ajax](https://api.jquery.com/category/ajax/) and [effects](https://api.jquery.com/category/effects/) modules.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-no-jquery",
-	"version": "2.7.0",
+	"version": "3.0.0",
 	"description": "Disallow jQuery functions with native equivalents.",
 	"repository": {
 		"type": "git",
@@ -16,7 +16,7 @@
 	"scripts": {
 		"pretest": "eslint --report-unused-disable-directives .",
 		"test": "nyc mocha --reporter dot tests/** && git diff --exit-code docs/ src/ README.md",
-		"onlytest": "mocha --reporter dot tests/** --nofix",
+		"onlytest": "mocha --reporter dot tests/**",
 		"report": "nyc report --reporter=text-lcov > coverage.lcov",
 		"reporthtml": "nyc report --reporter=html",
 		"testpath": "mocha",
@@ -26,18 +26,21 @@
 	"files": [
 		"src"
 	],
+	"engine": {
+		"node": ">=16"
+	},
 	"peerDependencies": {
-		"eslint": ">=2.3.0"
+		"eslint": ">=8.0.0"
 	},
 	"devDependencies": {
 		"codecov": "^3.8.3",
-		"eslint-config-wikimedia": "^0.20.0",
-		"eslint-docgen": "^0.5.1",
-		"eslint-plugin-eslint-plugin": "^3.6.1",
+		"eslint-config-wikimedia": "^0.28.0",
+		"eslint-docgen": "^0.7.1",
+		"eslint-plugin-eslint-plugin": "^6.1.0",
 		"eslint-plugin-self": "^1.2.1",
-		"jquery": "3.6.0",
-		"jsdom": "^16.7.0",
-		"mocha": "^8.4.0",
+		"jquery": "3.7.1",
+		"jsdom": "^22.1.0",
+		"mocha": "^10.2.0",
 		"nyc": "^15.1.0"
 	},
 	"bugs": {

package/src/.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+	"overrides": [
+		{
+			// Rules applying to index.js are used to autofix documentation
+			"files": [
+				"index.js"
+			],
+			"rules": {
+				// Allow non-arrow functions in examples
+				"prefer-arrow-callback": "off",
+				// Allow compact single line functions
+				"max-statements-per-line": "off",
+				"brace-style": "off"
+			}
+		}
+	]
+};

package/src/all-methods.js

@@ -1,6 +1,6 @@
 'use strict';
 
-<!-- This file is built by build-all-methods.js; do not edit it directly. -->
+/* This file is built by build-all-methods.js; do not edit it directly. */
 module.exports = [
 	'add',
 	'addBack',
@@ -135,6 +135,7 @@ module.exports = [
 	'triggerHandler',
 	'unbind',
 	'undelegate',
+	'uniqueSort',
 	'unwrap',
 	'val',
 	'width',

package/src/index.js

@@ -126,9 +126,12 @@ module.exports = {
 		},
 		// Use this config if you want to avoid all known deprecated jQuery tools.
 		deprecated: {
+			extends: 'plugin:no-jquery/deprecated-3.7'
+		},
+		// Use this config if you're writing code targetting jQuery 3.7.x environments.
+		'deprecated-3.7': {
 			extends: 'plugin:no-jquery/deprecated-3.6'
 		},
-		// Use this config if you're writing code targetting jQuery 3.6.x environments.
 		'deprecated-3.6': {
 			extends: 'plugin:no-jquery/deprecated-3.5'
 		},

package/src/rules/no-ajax-events.js

@@ -20,36 +20,34 @@ module.exports = {
 		schema: []
 	},
 
-	create: function ( context ) {
-		return {
-			'CallExpression:exit': function ( node ) {
-				if ( node.callee.type !== 'MemberExpression' ) {
-					return;
-				}
-				let usedMethod;
-				if (
-					node.callee.property.name === 'on' &&
+	create: ( context ) => ( {
+		'CallExpression:exit': ( node ) => {
+			if ( node.callee.type !== 'MemberExpression' ) {
+				return;
+			}
+			let usedMethod;
+			if (
+				node.callee.property.name === 'on' &&
 					node.arguments.length >= 1
-				) {
-					const arg = node.arguments[ 0 ];
-					if (
-						arg.type === 'Literal' &&
+			) {
+				const arg = node.arguments[ 0 ];
+				if (
+					arg.type === 'Literal' &&
 						disallowedEvents.includes( arg.value )
-					) {
-						usedMethod = arg.value;
-					}
-				}
-				if ( disallowedEvents.includes( node.callee.property.name ) ) {
-					usedMethod = node.callee.property.name;
-				}
-				if ( usedMethod && utils.isjQuery( context, node ) ) {
-					context.report( {
-						node: node,
-						message: 'Prefer local event to {{method}}',
-						data: { method: usedMethod }
-					} );
+				) {
+					usedMethod = arg.value;
 				}
 			}
-		};
-	}
+			if ( disallowedEvents.includes( node.callee.property.name ) ) {
+				usedMethod = node.callee.property.name;
+			}
+			if ( usedMethod && utils.isjQuery( context, node ) ) {
+				context.report( {
+					node,
+					message: 'Prefer local event to {{method}}',
+					data: { method: usedMethod }
+				} );
+			}
+		}
+	} )
 };

package/src/rules/no-ajax.js

@@ -6,5 +6,5 @@ module.exports = utils.createUtilMethodRule(
 	[ 'ajax', 'get', 'getJSON', 'getScript', 'post' ],
 	( node ) => node === true ?
 		'Prefer `Window.fetch`' :
-		`Prefer Window.fetch to $.${node.callee.property.name}`
+		`Prefer Window.fetch to $.${ node.callee.property.name }`
 );

package/src/rules/no-and-self.js

@@ -7,8 +7,6 @@ module.exports = utils.createCollectionMethodRule(
 	'Prefer `.addBack` to `.andSelf`',
 	{
 		fixable: 'code',
-		fix: function ( node, context, fixer ) {
-			return fixer.replaceText( node.callee.property, 'addBack' );
-		}
+		fix: ( node, context, fixer ) => fixer.replaceText( node.callee.property, 'addBack' )
 	}
 );

package/src/rules/no-animate-toggle.js

@@ -14,11 +14,11 @@ module.exports = {
 		schema: []
 	},
 
-	create: function ( context ) {
+	create: ( context ) => {
 		const forbidden = [ 'show', 'hide', 'toggle' ];
 
 		return {
-			'CallExpression:exit': function ( node ) {
+			'CallExpression:exit': ( node ) => {
 				if (
 					node.callee.type !== 'MemberExpression' ||
 					!forbidden.includes( node.callee.property.name ) ||
@@ -45,7 +45,7 @@ module.exports = {
 
 				if ( utils.isjQuery( context, node ) ) {
 					context.report( {
-						node: node,
+						node,
 						message: 'Prefer CSS transitions to .{{method}}',
 						data: { method: node.callee.property.name }
 					} );

package/src/rules/no-animate.js

@@ -23,39 +23,37 @@ module.exports = {
 		]
 	},
 
-	create: function ( context ) {
-		return {
-			'CallExpression:exit': function ( node ) {
-				if (
-					node.callee.type !== 'MemberExpression' ||
+	create: ( context ) => ( {
+		'CallExpression:exit': ( node ) => {
+			if (
+				node.callee.type !== 'MemberExpression' ||
 					node.callee.property.name !== 'animate'
-				) {
-					return;
-				}
-				const allowScroll = context.options[ 0 ] && context.options[ 0 ].allowScroll;
-				if ( allowScroll ) {
-					const arg = node.arguments[ 0 ];
-					// Check properties list has more than just scrollTop/scrollLeft
-					if ( arg && arg.type === 'ObjectExpression' ) {
-						if (
-							arg.properties.every(
-								( prop ) => prop.key.name === 'scrollTop' || prop.key.name === 'scrollLeft'
-							)
-						) {
-							return;
-						}
+			) {
+				return;
+			}
+			const allowScroll = context.options[ 0 ] && context.options[ 0 ].allowScroll;
+			if ( allowScroll ) {
+				const arg = node.arguments[ 0 ];
+				// Check properties list has more than just scrollTop/scrollLeft
+				if ( arg && arg.type === 'ObjectExpression' ) {
+					if (
+						arg.properties.every(
+							( prop ) => prop.key.name === 'scrollTop' || prop.key.name === 'scrollLeft'
+						)
+					) {
+						return;
 					}
 				}
+			}
 
-				if ( utils.isjQuery( context, node ) ) {
-					context.report( {
-						node: node,
-						message: allowScroll ?
-							'Prefer CSS transitions to .animate' :
-							'Prefer CSS transitions or CSS scroll-behaviour to .animate'
-					} );
-				}
+			if ( utils.isjQuery( context, node ) ) {
+				context.report( {
+					node,
+					message: allowScroll ?
+						'Prefer CSS transitions to .animate' :
+						'Prefer CSS transitions or CSS scroll-behaviour to .animate'
+				} );
 			}
-		};
-	}
+		}
+	} )
 };

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

@@ -1,7 +1,7 @@
 'use strict';
 
 const utils = require( '../utils.js' );
-const methods = [ 'append', 'prepend', 'before', 'after', 'replaceWith' ];
+const methods = [ 'append', 'prepend', 'before', 'after', 'replaceWith', 'add', 'appendTo', 'prependTo' ];
 
 function alljQueryOrEmpty( context, node ) {
 	if ( node.type === 'ConditionalExpression' ) {
@@ -28,26 +28,24 @@ module.exports = {
 		schema: []
 	},
 
-	create: function ( context ) {
-		return {
-			'CallExpression:exit': function ( node ) {
-				if ( !(
-					node.callee.type === 'MemberExpression' &&
+	create: ( context ) => ( {
+		'CallExpression:exit': ( node ) => {
+			if ( !(
+				node.callee.type === 'MemberExpression' &&
 					methods.includes( node.callee.property.name )
-				) ) {
-					return;
-				}
-				if ( node.arguments.every( ( arg ) => alljQueryOrEmpty( context, arg ) ) ) {
-					return;
-				}
+			) ) {
+				return;
+			}
+			if ( node.arguments.every( ( arg ) => alljQueryOrEmpty( context, arg ) ) ) {
+				return;
+			}
 
-				if ( utils.isjQuery( context, node.callee ) ) {
-					context.report( {
-						node: node,
-						message: 'Avoid injection of possibly unescaped HTML. Create DOM elements instead, or use .text.'
-					} );
-				}
+			if ( utils.isjQuery( context, node.callee ) ) {
+				context.report( {
+					node,
+					message: 'Avoid injection of possibly unescaped HTML. Create DOM elements instead, or use .text.'
+				} );
 			}
-		};
-	}
+		}
+	} )
 };

package/src/rules/no-class-state.js

@@ -15,12 +15,11 @@ module.exports = {
 		schema: []
 	},
 
-	create: function ( context ) {
-		return {
-			'CallExpression:exit': function ( node ) {
-				if ( !(
-					node.callee.type === 'MemberExpression' && (
-						node.callee.property.name === 'hasClass' ||
+	create: ( context ) => ( {
+		'CallExpression:exit': ( node ) => {
+			if ( !(
+				node.callee.type === 'MemberExpression' && (
+					node.callee.property.name === 'hasClass' ||
 						// toggleClass with one argument will check if the
 						// class is already in the DOM before deciding what to do,
 						// so it is equivalent to using hasClass.
@@ -28,18 +27,17 @@ module.exports = {
 							node.callee.property.name === 'toggleClass' &&
 							node.arguments.length === 1
 						)
-					)
-				) ) {
-					return;
-				}
+				)
+			) ) {
+				return;
+			}
 
-				if ( utils.isjQuery( context, node.callee ) ) {
-					context.report( {
-						node: node,
-						message: 'Where possible, maintain application state in JS to avoid slower DOM queries'
-					} );
-				}
+			if ( utils.isjQuery( context, node.callee ) ) {
+				context.report( {
+					node,
+					message: 'Where possible, maintain application state in JS to avoid slower DOM queries'
+				} );
 			}
-		};
-	}
+		}
+	} )
 };

package/src/rules/no-class.js

@@ -6,5 +6,5 @@ module.exports = utils.createCollectionMethodRule(
 	[ 'addClass', 'hasClass', 'removeClass', 'toggleClass' ],
 	( node ) => node === true ?
 		'Prefer `Element#classList`' :
-		`Prefer Element#classList to .${node.callee.property.name}`
+		`Prefer Element#classList to .${ node.callee.property.name }`
 );

package/src/rules/no-constructor-attributes.js

@@ -11,35 +11,33 @@ module.exports = {
 		schema: []
 	},
 
-	create: function ( context ) {
-		return {
-			'CallExpression:exit': function ( node ) {
-				if ( node.callee.type === 'MemberExpression' ) {
-					if ( !(
-						node.callee.property.name === 'add' &&
+	create: ( context ) => ( {
+		'CallExpression:exit': ( node ) => {
+			if ( node.callee.type === 'MemberExpression' ) {
+				if ( !(
+					node.callee.property.name === 'add' &&
 						utils.isjQuery( context, node.callee ) &&
 						node.arguments[ 1 ] &&
 						node.arguments[ 1 ].type === 'ObjectExpression'
-					) ) {
-						return;
-					}
-				} else if ( node.callee.type === 'Identifier' ) {
-					if ( !(
-						utils.isjQueryConstructor( context, node.callee.name ) &&
+				) ) {
+					return;
+				}
+			} else if ( node.callee.type === 'Identifier' ) {
+				if ( !(
+					utils.isjQueryConstructor( context, node.callee.name ) &&
 						node.arguments[ 1 ] &&
 						node.arguments[ 1 ].type === 'ObjectExpression'
-					) ) {
-						return;
-					}
-				} else {
+				) ) {
 					return;
 				}
-
-				context.report( {
-					node: node,
-					message: 'Prefer .attr to constructor attributes'
-				} );
+			} else {
+				return;
 			}
-		};
-	}
+
+			context.report( {
+				node,
+				message: 'Prefer .attr to constructor attributes'
+			} );
+		}
+	} )
 };

package/src/rules/no-data.js

@@ -6,5 +6,5 @@ module.exports = utils.createCollectionOrUtilMethodRule(
 	[ 'data', 'removeData', 'hasData' ],
 	( node ) => node === true ?
 		'Prefer `WeakMap`' :
-		`Prefer WeakMap to .${node.callee.property.name}/$.${node.callee.property.name}`
+		`Prefer WeakMap to .${ node.callee.property.name }/$.${ node.callee.property.name }`
 );

package/src/rules/no-deferred.js

@@ -11,7 +11,7 @@ module.exports = {
 		schema: []
 	},
 
-	create: function ( context ) {
+	create: ( context ) => {
 		function enforce( node ) {
 			if (
 				node.callee.type !== 'MemberExpression' ||
@@ -22,7 +22,7 @@ module.exports = {
 			}
 
 			context.report( {
-				node: node,
+				node,
 				message: 'Prefer Promise to $.Deferred'
 			} );
 		}

package/src/rules/no-error.js

@@ -7,8 +7,6 @@ module.exports = utils.createUtilMethodRule(
 	'Prefer `throw` to `$.error`',
 	{
 		fixable: 'code',
-		fix: function ( node, context, fixer ) {
-			return fixer.replaceText( node.callee, 'throw new Error' );
-		}
+		fix: ( node, context, fixer ) => fixer.replaceText( node.callee, 'throw new Error' )
 	}
 );

package/src/rules/no-escape-selector.js

@@ -7,8 +7,6 @@ module.exports = utils.createUtilMethodRule(
 	'Prefer `CSS.escape` to `$.escapeSelector`',
 	{
 		fixable: 'code',
-		fix: function ( node, context, fixer ) {
-			return fixer.replaceText( node.callee, 'CSS.escape' );
-		}
+		fix: ( node, context, fixer ) => fixer.replaceText( node.callee, 'CSS.escape' )
 	}
 );

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

@@ -48,7 +48,7 @@ const rule = utils.createCollectionMethodRule(
 	].concat( 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}`,
+		`Prefer .on or .trigger to .${ node.callee.property.name }`,
 	{
 		fixable: 'code',
 		fix: utils.eventShorthandFixer
@@ -69,10 +69,10 @@ rule.meta.schema = [
 
 const parentCreate = rule.create;
 
-rule.create = function ( context ) {
+rule.create = ( context ) => {
 	const rules = parentCreate( context );
 	return {
-		'CallExpression:exit': function ( node ) {
+		'CallExpression:exit': ( node ) => {
 			if (
 				node.callee.type === 'MemberExpression' &&
 				context.options[ 0 ] && context.options[ 0 ].allowAjaxEvents

package/src/rules/no-extend.js

@@ -8,6 +8,7 @@ module.exports = {
 		docs: {
 			description: 'Disallows the ' + utils.jQueryGlobalLink( 'extend' ) + ' utility. Prefer `Object.assign` or the spread operator.'
 		},
+		fixable: 'code',
 		schema: [
 			{
 				type: 'object',
@@ -21,32 +22,33 @@ module.exports = {
 		]
 	},
 
-	create: function ( context ) {
-		return {
-			'CallExpression:exit': function ( node ) {
-				if ( node.callee.type !== 'MemberExpression' ) {
-					return;
-				}
-				const name = node.callee.property.name;
-				if (
-					name !== 'extend' ||
+	create: ( context ) => ( {
+		'CallExpression:exit': ( node ) => {
+			if ( node.callee.type !== 'MemberExpression' ) {
+				return;
+			}
+			const name = node.callee.property.name;
+			if (
+				name !== 'extend' ||
 					!utils.isjQueryConstructor( context, node.callee.object.name )
-				) {
-					return;
-				}
-				const allowDeep = context.options[ 0 ] && context.options[ 0 ].allowDeep;
-				if (
-					allowDeep &&
-					node.arguments[ 0 ] && node.arguments[ 0 ].value === true
-				) {
-					return;
-				}
-
-				context.report( {
-					node: node,
-					message: 'Prefer Object.assign or the spread operator to $.extend'
-				} );
+			) {
+				return;
 			}
-		};
-	}
+			const allowDeep = context.options[ 0 ] && context.options[ 0 ].allowDeep;
+			const isDeep = node.arguments[ 0 ] && node.arguments[ 0 ].value === true;
+			if ( allowDeep && isDeep ) {
+				return;
+			}
+
+			context.report( {
+				node,
+				message: 'Prefer Object.assign or the spread operator to $.extend',
+				fix: function ( fixer ) {
+					if ( !isDeep ) {
+						return fixer.replaceText( node.callee, 'Object.assign' );
+					}
+				}
+			} );
+		}
+	} )
 };

package/src/rules/no-fade.js

@@ -6,5 +6,5 @@ module.exports = utils.createCollectionMethodRule(
 	[ 'fadeIn', 'fadeOut', 'fadeTo', 'fadeToggle' ],
 	( node ) => node === true ?
 		'Prefer CSS transitions' :
-		`Prefer CSS transitions to .${node.callee.property.name}`
+		`Prefer CSS transitions to .${ node.callee.property.name }`
 );

package/src/rules/no-fx-interval.js

@@ -11,23 +11,21 @@ module.exports = {
 		schema: []
 	},
 
-	create: function ( context ) {
-		return {
-			MemberExpression: function ( node ) {
-				if (
-					!utils.isjQueryConstructor( context, node.object.name ) ||
+	create: ( context ) => ( {
+		MemberExpression: ( node ) => {
+			if (
+				!utils.isjQueryConstructor( context, node.object.name ) ||
 					node.property.name !== 'fx' ||
 					!node.parent.property ||
 					node.parent.property.name !== 'interval'
-				) {
-					return;
-				}
-
-				context.report( {
-					node: node,
-					message: '$.fx.interval is not allowed'
-				} );
+			) {
+				return;
 			}
-		};
-	}
+
+			context.report( {
+				node,
+				message: '$.fx.interval is not allowed'
+			} );
+		}
+	} )
 };