Rule proposal: `prefer-destructured-variables` · sindresorhus/eslint-plugin-unicorn#1230

(4 comments) (6 reactions) (0 assignees)JavaScript (5,022 stars) (468 forks)user submission

help wantednew rule

Description

I understand we already have consistent-destructuring, and it already covers cases I'm going to post, but that rule is buggy, and I don't like destructuring all used properties in one, I prefer destructuring when needed, for example:

const {a} = foo;

if (a) {
  // ... do something not related to `foo.b`
}

const {b} = foo;

// ... do something with `b`

Fail

const {a} = foo;
console.log(foo.a);

Pass

const {a} = foo;
console.log(a, foo.b);

It's like splitting consistent-destructuring into two rules, this one and another like prefer-one-destructuring.

Contributor guide

Tech stack: javascriptnodejs
Domain: developer experience
Issue type: feature
Difficulty: 3
Estimated time: 1-2 days
Activity status: stale
Clarity: clear
Prerequisites: ESLint plugin developmentAST (Abstract Syntax Tree)JavaScript
Newbie friendliness: 45
Research direction: Look at the existing `consistent destructuring` rule implementation in `rules/consistent destructuring.js`. Understand its AST pattern and logic. Review the linked proposals (#248, #1005) for context. Then design a new rule that detects when a destructured variable is not used but the object property is accessed. The rule should be named `prefer destructured variables` and added to the plugin with proper documentation and tests.