canonical/node_modules/eslint-plugin-lodash/lib/util/methodDataUtil.js

Canonical code style linter and formatter for JavaScript, SCSS, CSS and JSON.

'use strict';

var _ = require('lodash');

/**
 * @type {VersionInfo}
 */
var methodDataByVersion = require('./methodDataByVersion');

/**
 * Gets a major version number and method name and returns all its aliases including itself.
 * @param {Number} version
 * @param {String} method
 * @returns {[String]}
 */
function expandAlias(version, method) {
    var methodData = methodDataByVersion[version];
    return [method].concat(methodData.aliases[method] || methodData.wrapperAliases[method] || []);
}

/**
 * Gets a major version number and a list of methods and returns a list of methods and all their aliases
 * @param version
 * @param methods
 * @returns {Array}
 */
function expandAliases(version, methods) {
    return _.flatMap(methods, expandAlias.bind(null, version));
}

/**
 * Gets the raw aliases object for a specific version
 * @param version
 * @returns {Aliases}
 */
function getAliasesByVersion(version) {
    return methodDataByVersion[version].aliases;
}

/**
 * Gets a list of all chainable methods and their aliases for a given version
 * @param {Number} version
 * @returns {[string]}
 */
function getChainableAliases(version) {
    return expandAliases(version, methodDataByVersion[version].chainable);
}

/**
 * Gets a list of all lodash collection methods for a specific version
 * @param {Number} version
 * @returns {[string]}
 */
function getCollectionMethods(version) {
    return expandAliases(version, methodDataByVersion[version].property.concat(['reduce', 'reduceRight']));
}

/**
 * Gets a list of methods that support property shorthand per version
 * @param {Number} version
 * @returns {[string]}
 */
function getPropShorthandMethods(version) {
    return expandAliases(version, methodDataByVersion[version].property);
}

/**
 * Gets a list of all wrapper methods for a specific version
 * @param {Number} version
 * @returns {[string]}
 */
function getWrapperMethods(version) {
    return methodDataByVersion[version].wrapper;
}

/**
 * Gets whether the suspect is an alias of the method in a given version
 * @param {Number} version
 * @param {string} method
 * @param {string} suspect
 * @returns {boolean}
 */
function isAliasOfMethod(version, method, suspect) {
    return _.includes(expandAlias(version, method), suspect);
}

/**
 * Returns the main alias for the method in the specified version.
 * @param {number} version
 * @param {string} method
 * @returns {string}
 */
function getMainAlias(version, method) {
    if (methodDataByVersion[version].aliases[method]) {
        return method;
    }
    return _.findKey(methodDataByVersion[version].aliases, function (aliases) {
        return _.includes(aliases, method);
    }) || method;
}

/**
 * Gets the index of the iteratee of a method when it isn't chained, or -1 if it doesn't have one.
 * @param {number} version
 * @param {string} method
 * @returns {number}
 */
function getIterateeIndex(version, method) {
    var mainAlias = getMainAlias(version, method);
    var iteratees = methodDataByVersion[version].iteratee;
    if (_.has(iteratees.differentIndex, mainAlias)) {
        return iteratees.differentIndex[mainAlias];
    }
    if (_.includes(iteratees.any, mainAlias)) {
        return 1;
    }
    return -1;
}

/**
 * Gets the maximum number of arguments to be given to the function in the specified version
 * @param {number} version
 * @param {string} name
 * @returns {number}
 */
function getFunctionMaxArity(version, name) {
    return methodDataByVersion[version].args[name] || Infinity;
}

module.exports = {
    isAliasOfMethod: isAliasOfMethod,
    getAliasesByVersion: getAliasesByVersion,
    getChainableAliases: getChainableAliases,
    getPropShorthandMethods: getPropShorthandMethods,
    getWrapperMethods: getWrapperMethods,
    getCollectionMethods: getCollectionMethods,
    getMainAlias: getMainAlias,
    getIterateeIndex: getIterateeIndex,
    getFunctionMaxArity: getFunctionMaxArity
};

/**
 * A hash of all aliases for a Lodash method
 @typedef {Object.<string, [string]>} Aliases
 */

/**
 * A JSON object containing method info for a specific lodash major version
 @typedef {Object} VersionInfo
 @property {Aliases} aliases
 @property {[string]} wrapper
 @property {Object.<string, [string]>} wrapperAliases
 @property {[string]} property
 @property {[string]} chainable
 */