feat(eslint-plugin): add new extended rule prefer-destructuring

[seiyab]

PR Checklist

• Addresses an existing open issue: fixes [prefer-destructuring] Variable declaration type annotation #723 New Rule: prefer-destructuring #1931
• That issue was marked as accepting prs
• Steps in Contributing were taken

Overview

Add a new base rule extension @typescript-eslint/prefer-destructuring to resolve following issues.

• [prefer-destructuring] Variable declaration type annotation #723
• New Rule: prefer-destructuring #1931

#723 requests two things: 1. keep type annotation, 2. add an option to allow non-destructuring assignment for type annotated ones.
For the first one, I just disable auto fixer for declaration with type annotation, rather than providing correct auto fix. It's just because difficulty and maitainability.
For the second one, I add enforceForDeclarationWithTypeAnnotation option. I set default value false because I agree with "annotations on destructured variables aren't very pretty" in the issue.

#1931 requests type-aware version and I have implemented it for numeric index access for non-iterable object, that is the only case reported in the issue (excluding comments that are duplication of #723).
There is a notable thing for it. I treated numeric index access for non-iterable object as renamed one. So it is affected by enforceForRenamedProperties option.

[typescript-eslint]

Thanks for the PR, @seiyab!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

---

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	77b6704
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/64da426db8f1bd0008bf99dc
😎 Deploy Preview	https://deploy-preview-7117--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 77b6704. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 37 targets

• nx test eslint-plugin --coverage=false
• Node 20 - nx test eslint-plugin
• Node 16 - nx test eslint-plugin --coverage=false
• nx build website
• Node 20 - nx test type-utils
• nx test eslint-plugin-tslint --coverage=false
• Node 20 - nx run types:build
• nx run types:build
• nx test typescript-estree --coverage=false
• Node 20 - nx test scope-manager
• Node 20 - nx test utils
• nx test eslint-plugin-internal --coverage=false
• Node 20 - nx test parser
• Node 20 - nx test visitor-keys
• Node 20 - nx test typescript-estree
• Node 20 - nx test rule-schema-to-typescript-types
• Node 20 - nx test repo-tools
• nx run-many --target=lint --parallel
• nx run-many --target=typecheck --parallel
• Node 16 - nx test rule-schema-to-typescript-types --coverage=false
• Node 16 - nx run types:build
• Node 20 - nx test eslint-plugin-tslint
• Node 16 - nx test eslint-plugin-internal --coverage=false
• Node 16 - nx test visitor-keys --coverage=false
• nx run integration-tests:test
• Node 16 - nx test type-utils --coverage=false
• Node 16 - nx test repo-tools --coverage=false
• Node 16 - nx test typescript-estree --coverage=false
• Node 16 - nx test scope-manager --coverage=false
• Node 16 - nx test ast-spec --coverage=false
• Node 20 - nx test eslint-plugin-internal
• Node 16 - nx test eslint-plugin-tslint --coverage=false
• Node 20 - nx test ast-spec
• Node 16 - nx test parser --coverage=false
• Node 16 - nx test utils --coverage=false
• nx run eslint-plugin:generate:configs
• nx run-many --target=build --parallel --exclude=website --exclude=website-eslint

---

Sent with 💌 from NxCloud.

[codecov]

Codecov Report

Merging #7117 (77b6704) into main (479f9f6) will increase coverage by 0.06%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7117      +/-   ##
==========================================
+ Coverage   85.25%   85.31%   +0.06%     
==========================================
  Files         386      387       +1     
  Lines       13358    13417      +59     
  Branches     3943     3962      +19     
==========================================
+ Hits        11388    11447      +59     
  Misses       1593     1593              
  Partials      377      377              

Flag	Coverage Δ
unittest	85.31% <100.00%> (+0.06%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
...ckages/eslint-plugin/src/util/getESLintCoreRule.ts	75.00% <ø> (ø)
...es/eslint-plugin/src/rules/prefer-destructuring.ts	100.00% <100.00%> (ø)

[JoshuaKGoldberg]

I also took the liberty of merging in from main, since v6 was merged & changed a few internals after this PR was sent. Cheers!

[seiyab]

I have responded to your requests🚀

[JoshuaKGoldberg]

LGTM, thanks for both sending & updating it (with so many tests)! 🔥

I'll defer to an additional review from @typescript-eslint/triage-team because this is the first instance I can find of calling baseRule.create in two different potential ways.

[seiyab]

Thank you for your review.
I have responded to #7117 (comment) and #7117 (comment) but I'm wondering why create(context, [enabledTypes, options = {}]) { get uncovered renaming a variable.

[seiyab]

@JoshuaKGoldberg
Could you tell me the current status?

[JoshuaKGoldberg]

Heh, I was hoping for an additional review, but it seems that everyone is slammed right now. Let's merge as-is 😄. Thanks for the ping!

[JoshuaKGoldberg]