Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ Where rules are included in the configs `recommended`, `slim`, `all` or `depreca
* [`no-jquery/no-sub`](docs/rules/no-sub.md) `1.7`, `all`
* [`no-jquery/no-support`](docs/rules/no-support.md) `1.9`
* [`no-jquery/no-text`](docs/rules/no-text.md) `all`
* [`no-jquery/no-toggle-all-classes`](docs/rules/no-toggle-all-classes.md) `3.0`
* [`no-jquery/no-trigger`](docs/rules/no-trigger.md) `all`
* [`no-jquery/no-trim`](docs/rules/no-trim.md) `3.5`, `all`
* [`no-jquery/no-type`](docs/rules/no-type.md) `3.3`, `all`
Expand Down
34 changes: 34 additions & 0 deletions docs/rules/no-toggle-all-classes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[//]: # (This file is generated by eslint-docgen. Do not edit it directly.)

# no-toggle-all-classes

Disallows using [`.toggleClass`](https://api.jquery.com/toggleClass/) to toggle all classes.

📋 This rule is enabled in `plugin:no-jquery/deprecated-3.0`.

## Rule details

❌ Examples of **incorrect** code:
```js
$div.toggleClass();
$div.toggleClass( false );
$div.toggleClass( true );
$div.toggleClass( undefined );
```

✔️ Examples of **correct** code:
```js
$div.attr( 'class', '' );
$div.removeClass( 'myClass' );
toggleClass( false );
obj.toggleClass( false );
$div.toggleClass( 'myClass', true );
$div.toggleClass( 'myClass', false );
$div.toggleClass( 'myClass' );
$div.toggleClass( 'myClass', undefined );
```

## Resources

* [Rule source](/src/rules/no-toggle-all-classes.js)
* [Test source](/tests/rules/no-toggle-all-classes.js)
2 changes: 2 additions & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ module.exports = {
'no-support': require( './rules/no-support' ),
'no-text': require( './rules/no-text' ),
'no-toggle': require( './rules/no-toggle' ),
'no-toggle-all-classes': require( './rules/no-toggle-all-classes' ),
'no-trigger': require( './rules/no-trigger' ),
'no-trim': require( './rules/no-trim' ),
'no-type': require( './rules/no-type' ),
Expand Down Expand Up @@ -184,6 +185,7 @@ module.exports = {
'no-jquery/no-fx-interval': 'warn',
'no-jquery/no-parse-json': 'warn',
'no-jquery/no-ready-shorthand': 'warn',
'no-jquery/no-toggle-all-classes': 'warn',
'no-jquery/no-unique': 'warn'
}
},
Expand Down
50 changes: 50 additions & 0 deletions src/rules/no-toggle-all-classes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
'use strict';

const utils = require( '../utils.js' );

module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'Disallows using ' + utils.jQueryCollectionLink( 'toggleClass' ) + ' to toggle all classes.'
},
schema: []
},

create: ( context ) => ( {
'CallExpression:exit': ( node ) => {
if ( node.callee.type !== 'MemberExpression' ) {
return;
}
const name = node.callee.property.name;
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'
} );
}
}
} )
};
3 changes: 3 additions & 0 deletions test-self/deprecated-3.0/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ $x.ready();
// eslint-disable-next-line self/no-unique
$.unique();

// eslint-disable-next-line self/no-toggle-all-classes
$x.toggleClass( false );

/* 1.10 */
// eslint-disable-next-line self/no-context-prop
$x.context;
Expand Down
38 changes: 38 additions & 0 deletions tests/rules/no-toggle-all-classes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
'use strict';

const rule = require( '../../src/rules/no-toggle-all-classes' );
const RuleTester = require( '../../tools/rule-tester' );

const toggleError = '.toggleClass(boolean|undefined) is deprecated';

const ruleTester = new RuleTester();
ruleTester.run( 'no-toggle-all-classes', rule, {
valid: [
'$div.attr("class", "")',
'$div.removeClass("myClass")',
'toggleClass(false)',
'obj.toggleClass(false)',
'$div.toggleClass("myClass", true)',
'$div.toggleClass("myClass", false)',
'$div.toggleClass("myClass")',
'$div.toggleClass("myClass", undefined)'
],
invalid: [
{
code: '$div.toggleClass()',
errors: [ toggleError ]
},
{
code: '$div.toggleClass(false)',
errors: [ toggleError ]
},
{
code: '$div.toggleClass(true)',
errors: [ toggleError ]
},
{
code: '$div.toggleClass(undefined)',
errors: [ toggleError ]
}
]
} );
Loading