eslint-plugin-destructuring/lib/rules/in-params.js

destructuring specific linting rules for ESLint

'use strict';

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

module.exports = {
  meta: {
    docs: {},

    schema: [{
      type: 'object',
      properties: {
        'max-params': {
          type: 'integer',
          minimum: 0
        }
      },
      additionalProperties: false
    }]
  },

  create: function inParams(context) {
    const option = context.options[0];
    let maxParams = 1;

    if (typeof option === 'object' && Object.prototype.hasOwnProperty.call(option, 'max-params') && typeof option['max-params'] === 'number') {
      maxParams = option['max-params'];
    }

    return {
      ObjectPattern: function ObjectPattern(node) {
        if (node.parent.type === 'ArrowFunctionExpression' || node.parent.type === 'FunctionDeclaration') {
          if (node.parent.params.length > maxParams) {
            context.report(node, 'Do not use destructuring in params when there' + ` are more than ${maxParams} params.`);
          }
        }
      }
    };
  }
};