Skip to content
This repository has been archived by the owner on Jun 19, 2024. It is now read-only.

Latest commit

 

History

History
108 lines (86 loc) · 1.87 KB

destructuring-assignment.md

File metadata and controls

108 lines (86 loc) · 1.87 KB

Enforce consistent usage of destructuring assignment of props, state, and context (react/destructuring-assignment)

Rule can be set to either of always or never;

"react/destructuring-assignment": [<enabled>, 'always']

Rule Details

By default rule is set to always enforce destructuring assignment. The following patterns are considered warnings:

const MyComponent = (props) => {
  return (<div id={props.id} />)
};
const Foo = class extends React.PureComponent {
  render() {
    return <div>{this.context.foo}</div>;
  }
};

Below pattern is correct:

const MyComponent = ({id}) => {
  return (<div id={id} />)
};
const MyComponent = (props, context) => {
  const { id } = props;
  return (<div id={id} />)
};
const Foo = class extends React.PureComponent {
  render() {
    const { title } = this.context;
    return <div>{title}</div>;
  }
};

If rule is set to never, the following patterns are considered warning:

const MyComponent = ({id}) => {
  return (<div id={id} />)
};
const MyComponent = (props) => {
  const { id } = props;
  return (<div id={id} />)
};
const Foo = class extends React.PureComponent {
  render() {
    const { title } = this.state;
    return <div>{title}</div>;
  }
};

and below pattern is correct:

const MyComponent = (props) => {
  return (<div id={props.id} />)
};
const Foo = class extends React.PureComponent {
  render() {
    return <div>{this.state.title}</div>;
  }
};

Rule Options

...
"react/destructuring-assignment": [<enabled>, "always", { "ignoreClassFields": <boolean> }]
...

ignoreClassFields

When true the rule will ignore class field declarations.

The following patterns are then considered okay and do not cause warnings:

class Foo extends React.PureComponent {
  bar = this.props.bar
}