@putout/plugin-destructuring [![NPM version][NPMIMGURL]][NPMURL]

[NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-destructuring.svg?style=flat&longCache=true
[NPMURL]: https://npmjs.org/package/@putout/plugin-destructuring"npm"

> The destructuring assignment syntax is a JavaScript expression that makes it possible to unpack values from arrays, or properties from objects, into distinct variables.
>
> (c) MDN

🐊Putout plugin adds ability to use destructuring on variable declarations.

Install

``
npm i @putout/plugin-destructuring
`

Rules

- ✅ apply-array;
- ✅ apply-object;
- ✅ convert-object-to-array;
- ✅ extract-properties;
- ✅ remove-useless-object;
- ✅ remove-useless-arguments;
- ✅ remove-useless-variables;
- ✅ split-nested;
- ✅ split-call;
- ✅ merge-properties;

Config

`json
{
"rules": {
"destructuring/apply-array": "on",
"destructuring/apply-object": "on",
"destructuring/convert-object-to-array": "on",
"destructuring/extract-properties": "on",
"destructuring/remove-useless-object": "on",
"destructuring/remove-useless-arguments": "on",
"destructuring/remove-useless-variables": "on",
"destructuring/split-nested": "on",
"destructuring/split-call": "on",
"destructuring/merge-properties": "on"
}
}
`

apply-array

$3

`js
const first = array[0];
`

$3

`js
const [first] = array;
`

apply-object

$3

`js
const name = user.name;

hello = world.hello;
`

$3

`js
const {name} = user;

({hello} = world);
`

remove-useless-object

Check out in 🐊Putout Editor.

$3

`js
const {maxElementsInOneLine} = {
options,
};
`

$3

`js
const {maxElementsInOneLine} = options;
`

convert-object-to-array

Check out in 🐊Putout Editor.

$3

`js
const {0: a, 1: b} = c;
`

$3

`js
const [a, b] = c;
`

split-nested

> - Don't use nested destructuring on data that comes from any external data sources (such as REST APIs, GraphQL endpoints or files).
> - Don't use nested destructuring on function arguments that have long or complicated signatures.
>
> (c) Destructuring in JavaScript: the not so good parts

$3

`js
const {
a: {
b,
},
a: {
b: x,
},
} = c;

function f({a}) {
const {b} = a;
console.log(b);
}
`

$3

`js
const {a} = c;
const {b, b: x} = a;

function f({a}) {
const {b} = a;
console.log(b);
}
`

split-call

$3

`js
console.log('hello')({uid} = path.scope);
console.log('hello')[uid] = path.scope;
`

$3

`js
console.log('hello');
({uid} = path.scope);

console.log('hello');
[uid] = path.scope;
`

merge-properties

Checkout in 🐊Putout Editor.

$3

`js
const {one} = require('numbers');
const {two} = require('numbers');

({from} = data);
({to} = data);
({names} = data);
`

$3

`js
const {one, two} = require('numbers');

({
from,
to,
names,
} = data);
`

remove-useless-arguments

$3

`js
onIfStatement({
push,
generate,
abc,
helloworld,
});

function onIfStatement({push}) {}
`

$3

`js
onIfStatement({
push,
});

function onIfStatement({push}) {}
`

remove-useless-variables

$3

`js
function hi(c) {
const {a, b} = c;
}
`

$3

`js
function hi({a, b}) {}
`

extract-properties

$3

#### ❌ Example of incorrect code

`js
const {replaceWith} = a.operate;
const {isIdentifier} = a.types;
`

#### ✅ Example of correct code

`js
const {operator, types} = a;

const {replaceWith} = operator;
const {isIdentifier} = types;
`

$3

#### ❌ Example of incorrect code

`js
const {replaceWith} = a;
const {isIdentifier} = a.types;
`

#### ✅ Example of correct code

`js
const {replaceWith, types} = a;
const {isIdentifier} = types;
``

License

MIT