Skip to content

How to limit the maximum number of variables destructured in the function signature? #47

@yay

Description

@yay

The guide says:

The following patterns are not considered warnings:

/*eslint destructuring/in-params: ["error", { "max-params" : 1}]*/

function t1({a}) {}
function t2(a, b) {
  const {c} = a;
  const {d} = b;
}
const t3 = ({a}) => a;

But this is also valid:

function t3({ a, b, c, d, e}) {}

I would expect to be able to set the maximum number of destructured variables, so that one is forced to rewrite t3 as follows:

function t3(params) {
   const { a, b, c, d, e} = params;
}

This is a common issue with functional React components, where someone starts with a few parameters destructured in the function signature:

const MyReactComponent: FC<MyReactComponentProps> = ({ aProp, orTwo }) => {
   ...
}

Then over time, as different people keep adding features to that component, they put and more props into the function signature that becomes a multi-line monstrosity eventually, without bothering to move the destructuring to a function body.

It would be very handy to have a rule that allows up to a certain number of variables in the destructuting block.

Is there already a way to do it?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions