[naming-convention] add a modifier to identify a variable/parameter as having been destructured

[Timmmm]

• I have tried restarting my IDE and the issue persists.
• I have updated to the latest version of the packages.
• I have read the FAQ and my problem is not listed.

Repro

{
  "rules": {
    "@typescript-eslint/naming-convention": "error"
  }
}

import electron from "electron";
const { BrowserWindow } = electron;

Expected Result

It shouldn't complain about the name of BrowserWindow, because I didn't have any choice in the matter.

Actual Result

It does complain.

Additional Info

I feel like there should be an option to don't check destructured names at all.

Versions

All latest.

[bradzacher]

because I didn't have any choice in the matter

You could just as easily write:

const browserWindow = electron.BrowserWindow;
// or
const { BrowserWindow: browserWindow } = electron;

You have a choice of the name, it's just that the simplest syntax reuses the existing name.

---

Destructuring creates variables. These variables should adhere to your naming convention.
Otherwise you will introduce names that do not match your conventions into your codebase.

Side note that there is currently a bug with destructured names: #2250.

[Timmmm]

Destructuring creates variables.

Right, but variables that I didn't name. If I did name them (because the come from my codebase) then I'll get a warning at the place where they are defined anyway. The Rust developers agree, if that persuades you!

Maybe this should be an option.

[bradzacher]

The Rust developers agree, if that persuades you!

It doesn't - pattern matching is a bit different. I don't think there's a way to rename the variable there (I don't know anything about rust syntax but I couldn't see it in a quick scan of the docs).

---

Using PascalCase when your naming convention specified camelCase doesn't seem like to egregious of an issue.

But consider that ignoring destructuring naming would allow this:

const { mY_rId_ICULOUS_ly_$$$_named_variable } = {};

It's hard to draw that line and says "this is acceptable variance".
IMO it's better to just say "all variables must follow the naming convention, no matter their source".

Perhaps we could mark these variables with a modifier, and allow you to reconfigure it as strict as you like?

[Timmmm]

I don't think there's a way to rename the variable there

There is - pattern matching is very similar to destructuring in Rust.

You could instead write

    match pet {
       Animal::Spider { iHateSnakes: i_hate_snakes } => dbg!(i_hate_snakes),
   };

Perhaps we could mark these variables with a modifier, and allow you to reconfigure it as strict as you like?

That sounds like a perfect solution!