eslint-plugin-no-jquery 3.1.0 → 4.0.0

package/README.md

@@ -96,7 +96,7 @@ Where rules are included in the configs `recommended`, `slim`, `all` or `depreca
 * [`no-jquery/no-box-model`](docs/rules/no-box-model.md) `1.3`
 * [`no-jquery/no-browser`](docs/rules/no-browser.md) `1.3`
 * [`no-jquery/no-camel-case`](docs/rules/no-camel-case.md) `3.3`, `all`
-* [`no-jquery/no-class`](docs/rules/no-class.md) `all`
+* [`no-jquery/no-class`](docs/rules/no-class.md) ⚙️ `3.0†`, `all`
 * [`no-jquery/no-class-state`](docs/rules/no-class-state.md)
 * [`no-jquery/no-clone`](docs/rules/no-clone.md) `all`
 * [`no-jquery/no-closest`](docs/rules/no-closest.md) `all`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-no-jquery",
-	"version": "3.1.0",
+	"version": "4.0.0",
 	"description": "Disallow jQuery functions with native equivalents.",
 	"repository": {
 		"type": "git",
@@ -27,21 +27,21 @@
 		"src"
 	],
 	"engine": {
-		"node": ">=16"
+		"node": ">=20"
 	},
 	"peerDependencies": {
-		"eslint": ">=8.0.0"
+		"eslint": ">=8.0.0 <9.0.0"
 	},
 	"devDependencies": {
 		"codecov": "^3.8.3",
-		"eslint-config-wikimedia": "^0.28.2",
+		"eslint-config-wikimedia": "^0.32.3",
 		"eslint-docgen": "^0.7.1",
-		"eslint-plugin-eslint-plugin": "^6.1.0",
+		"eslint-plugin-eslint-plugin": "^6.5.0",
 		"eslint-plugin-self": "^1.2.1",
 		"jquery": "3.7.1",
-		"jsdom": "^22.1.0",
-		"mocha": "^10.2.0",
-		"nyc": "^15.1.0"
+		"jsdom": "^27.0.0",
+		"mocha": "^11.7.4",
+		"nyc": "^17.1.0"
 	},
 	"bugs": {
 		"url": "https://github.com/wikimedia/eslint-plugin-no-jquery/issues"

package/src/index.js

@@ -180,6 +180,7 @@ module.exports = {
 			extends: 'plugin:no-jquery/deprecated-2.2',
 			rules: {
 				'no-jquery/no-bind': 'warn',
+				'no-jquery/no-class': [ 'warn', { onlyDeprecated: true } ],
 				'no-jquery/no-delegate': 'warn',
 				'no-jquery/no-fx-interval': 'warn',
 				'no-jquery/no-parse-json': 'warn',

package/src/rules/no-animate.js

@@ -17,11 +17,15 @@ module.exports = {
 				type: 'object',
 				properties: {
 					allowScroll: {
-						type: 'boolean'
+						type: 'boolean',
+						description: 'Allow animations which are just used for scrolling'
 					}
 				},
 				additionalProperties: false
 			}
+		],
+		defaultOptions: [
+			{ allowScroll: false }
 		]
 	},
 
@@ -34,16 +38,23 @@ module.exports = {
 				return;
 			}
 			const allowScroll = context.options[ 0 ] && context.options[ 0 ].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' ) {
-					if (
-						arg.properties.every(
-							( prop ) => prop.key.name === 'scrollTop' || prop.key.name === 'scrollLeft'
-						)
-					) {
-						return;
+			const name = node.callee.property.name;
+			if ( allowScroll ) {
+				if ( name === 'stop' || name === 'finish' ) {
+					// We can't tell what animation we are stopping, so assume
+					// it is an allowed scroll
+					return;
+				} else if ( name === 'animate' ) {
+					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;
+						}
 					}
 				}
 			}

package/src/rules/no-class.js

@@ -2,9 +2,83 @@
 
 const utils = require( '../utils.js' );
 
-module.exports = utils.createCollectionMethodRule(
-	[ 'addClass', 'hasClass', 'removeClass', 'toggleClass' ],
-	( node ) => node === true ?
-		'Prefer `Element#classList`' :
-		`Prefer Element#classList to .${ node.callee.property.name }`
-);
+const methods = [ 'addClass', 'hasClass', 'removeClass', 'toggleClass' ];
+
+module.exports = {
+	meta: {
+		type: 'suggestion',
+		docs: {
+			description: 'Disallows the ' + methods.map( utils.jQueryCollectionLink ).join( '/' ) +
+			' methods. User the `onlyDeprecated` option to only report deprecated usages. Prefer `Element#classList`.'
+		},
+		schema: [
+			{
+				type: 'object',
+				properties: {
+					onlyDeprecated: {
+						type: 'boolean',
+						description: 'Only report deprecated usages of the methods.'
+					}
+				},
+				additionalProperties: false
+			}
+		],
+		defaultOptions: [
+			{ onlyDeprecated: false }
+		]
+	},
+
+	create: ( context ) => ( {
+		'CallExpression:exit': ( node ) => {
+			if (
+				node.callee.type !== 'MemberExpression' ||
+					!methods.includes( node.callee.property.name )
+			) {
+				return;
+			}
+			const name = node.callee.property.name;
+			const onlyDeprecated = context.options[ 0 ] && context.options[ 0 ].onlyDeprecated;
+
+			if ( !onlyDeprecated ) {
+				if ( utils.isjQuery( context, node.callee ) ) {
+					const message = node === true ?
+						'Prefer `Element#classList`' :
+						`Prefer Element#classList to .${ name }`;
+					context.report( {
+						node,
+						message
+					} );
+				}
+			} else {
+				if ( name !== 'toggleClass' || utils.isjQueryConstructor( context, node.callee.object.name ) ) {
+					return;
+				}
+
+				if ( node.arguments.length >= 2 ) {
+					return;
+				}
+				if ( node.arguments.length === 1 ) {
+					const arg = node.arguments[ 0 ];
+					if (
+						!(
+							arg.type === 'Literal' &&
+							( arg.value === true || arg.value === false )
+						) &&
+						!(
+							arg.type === 'Identifier' && arg.name === 'undefined'
+						)
+					) {
+						return;
+					}
+				}
+
+				if ( utils.isjQuery( context, node.callee ) ) {
+					context.report( {
+						node,
+						message: '.toggleClass(boolean|undefined) is deprecated'
+					} );
+				}
+			}
+		}
+	} )
+};

package/src/rules/no-extend.js

@@ -6,7 +6,9 @@ module.exports = {
 	meta: {
 		type: 'suggestion',
 		docs: {
-			description: 'Disallows the ' + utils.jQueryGlobalLink( 'extend' ) + ' utility. Prefer `Object.assign` or the spread operator.'
+			description:
+				'Disallows the ' + utils.jQueryGlobalLink( 'extend' ) + ' utility. Prefer `Object.assign` or the spread operator. ' +
+				'Use the `allowDeep` option to allow using the method with the `deep` argument.'
 		},
 		fixable: 'code',
 		schema: [
@@ -14,11 +16,15 @@ module.exports = {
 				type: 'object',
 				properties: {
 					allowDeep: {
-						type: 'boolean'
+						type: 'boolean',
+						description: 'Allow when used with the `deep` argument'
 					}
 				},
 				additionalProperties: false
 			}
+		],
+		defaultOptions: [
+			{ allowDeep: false }
 		]
 	},
 

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

@@ -20,11 +20,15 @@ module.exports = {
 				type: 'object',
 				properties: {
 					allowIds: {
-						type: 'boolean'
+						type: 'boolean',
+						description: 'Allow single ID selectors'
 					}
 				},
 				additionalProperties: false
 			}
+		],
+		defaultOptions: [
+			{ allowIds: false }
 		]
 	},
 

package/src/rules/no-other-methods.js

@@ -31,6 +31,7 @@ const methodsWithRules = [
 	'fadeToggle',
 	'filter',
 	'find',
+	'finish',
 	'focus',
 	'focusin',
 	'focusout',
@@ -71,6 +72,7 @@ const methodsWithRules = [
 	'slideDown',
 	'slideToggle',
 	'slideUp',
+	'stop',
 	'submit',
 	'text',
 	'toggle',

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

@@ -26,11 +26,15 @@ module.exports = {
 				type: 'object',
 				properties: {
 					singleTagStyle: {
-						enum: [ 'minimal', 'self-closing', 'any' ]
+						enum: [ 'minimal', 'self-closing', 'any' ],
+						description: 'Format of single tags'
 					}
 				},
 				additionalProperties: false
 			}
+		],
+		defaultOptions: [
+			{ singleTagStyle: 'minimal' }
 		]
 	},
 

package/src/rules/no-sizzle.js

@@ -15,14 +15,20 @@ module.exports = {
 				type: 'object',
 				properties: {
 					allowPositional: {
-						type: 'boolean'
+						type: 'boolean',
+						description: 'Allow positional selectors'
 					},
 					allowOther: {
-						type: 'boolean'
+						type: 'boolean',
+						description: 'Allow all other selectors'
 					}
 				},
 				additionalProperties: false
 			}
+		],
+		defaultOptions: [
+			{ allowPositional: false },
+			{ allowOther: false }
 		]
 	},