no-unreadable-array-destructuring.md

no-unreadable-array-destructuring

📝 Disallow unreadable array destructuring.

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

🔧 This rule is automatically fixable by the --fix CLI option.

Destructuring is very useful, but it can also make some code harder to read. This rule prevents ignoring consecutive values when destructuring from an array.

Examples

// ✅
const [foo] = parts;

// ✅
const [, foo] = parts;

// ❌
const [,, foo] = parts;

// ✅
const foo = parts[2];

// ❌
const [,,, foo] = parts;

// ✅
const foo = parts[3];

// ✅
const [,...rest] = parts;

// ❌
const [,,...rest] = parts;

// ✅
const rest = parts.slice(2);

Note

You might have to modify the built-in prefer-destructuring rule to be compatible with this one:

{
	"rules": {
		"prefer-destructuring": [
			"error",
			{
				"object": true,
				"array": false
			}
		]
	}
}