no-unreadable-object-destructuring.md

no-unreadable-object-destructuring

📝 Disallow unreadable object destructuring.

💼 This rule is enabled in the following configs: ✅ recommended, ☑️ unopinionated.

Destructuring is very useful, but it can also make some code harder to read. This rule prevents hard-to-read object destructuring patterns, including assigning destructured values to object properties.

Examples

// ✅
const {foo} = object;

// ✅
const {foo: bar = defaultValue} = object;

// ✅
const {foo: {bar}} = object;

// ❌
const {[key]: value} = object;

// ✅
const value = object[key];

A computed key is allowed when the same pattern collects a rest element, since that is the only way to exclude a dynamic property from the rest.

// ✅
const {[key]: value, ...rest} = object;

// ❌
const {foo: [bar]} = object;

// ✅
const [bar] = object.foo;

// ❌
const {foo: {bar: {baz}}} = object;

// ✅
const {baz} = object.foo.bar;

// ❌
({foo: object.property} = object);

// ✅
({foo} = object);
object.property = foo;