no-animate-toggle.js

'use strict';

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

module.exports = {
	meta: {
		type: 'suggestion',
		docs: {
			description:
				'Disallows the duration argument when using the ' + utils.jQueryCollectionLink( 'show' ) +
				', ' + utils.jQueryCollectionLink( 'hide' ) + ' & ' + utils.jQueryCollectionLink( 'toggle' ) +
				' methods. Prefer CSS transitions.'
		},
		schema: []
	},

	create: ( context ) => {
		const forbidden = [ 'show', 'hide', 'toggle' ];

		return {
			'CallExpression:exit': ( node ) => {
				if (
					node.callee.type !== 'MemberExpression' ||
					!forbidden.includes( node.callee.property.name ) ||
					node.arguments.length === 0
				) {
					return;
				}
				if (
					node.arguments.length === 1 &&
					node.callee.property.name === 'toggle'
				) {
					let possibleBool = true;
					const arg = node.arguments[ 0 ];
					if ( arg.type === 'Literal' ) {
						possibleBool = typeof arg.value === 'boolean';
					}
					if ( arg.type === 'ObjectExpression' ) {
						possibleBool = false;
					}
					if ( possibleBool ) {
						return;
					}
				}

				if ( utils.isjQuery( context, node ) ) {
					context.report( {
						node,
						message: 'Prefer CSS transitions to .{{method}}',
						data: { method: node.callee.property.name }
					} );
				}
			}
		};
	}
};