eslint-plugin-lodash/src/rules/no-extra-args.js

Lodash specific linting rules for ESLint

/**
 * @fileoverview Rule to make sure lodash method calls don't use superfluous arguments
 */
'use strict'

//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------

const getDocsUrl = require('../util/getDocsUrl')

module.exports = {
    meta: {
        type: 'problem',
        schema: [],
        docs: {
            url: getDocsUrl('no-extra-args')
        }
    },

    create(context) {
        const {version} = require('../util/settingsUtil').getSettings(context)
        const {getLodashMethodVisitors} = require('../util/lodashUtil')
        const {getFunctionMaxArity} = require('../util/methodDataUtil')

        function getExpectedArity(callType, method) {
            const maxArity = getFunctionMaxArity(version, method)
            return Math.max(callType === 'chained' ? maxArity - 1 : maxArity, 0)
        }

        return getLodashMethodVisitors(context, (node, iteratee, {callType, method}) => {
            const expectedArity = getExpectedArity(callType, method)
            if (node.arguments.length > expectedArity) {
                context.report({
                    node,
                    message: 'Too many arguments passed to `{{method}}` (expected {{expectedArity}}).',
                    data: {method, expectedArity}
                })
            }
        })
    }
}