Option for "variable-name" rule to allow leading underscore for property backing fields

[glen-84]

It would be nice to have this:

class Example {
    private _var1; // ERROR, not a backing field, shouldn't start with an underscore.
    private _var2; // Allowed, as it's a backing field for the `var2` property.

    public get var2() {
        return this._var2;
    }
}

allow-leading-underscore-backing-fields maybe.

Edit: It would be considered a backing field if there was either a getter or a setter with the same name (sans the leading underscore).

[stevedenman]

This naming convention for backing fields is also suggested in the typescript handbook ;

private _fullName: string;

get fullName(): string {
    return this._fullName;
}

[JoshuaKGoldberg]

variable-name now allows options such as "allow-leading-underscore". 🎉

[glen-84]

@JoshuaKGoldberg That's not new, and allows leading underscores on any variable.

[JoshuaKGoldberg]

Oh! My apologies, I speed-read the rule and missed the difference. Agreed that an option to allow a leading underscore only for backing properties would be nice.

We should note that it shouldn't be allowed to be enabled at the same time as "allow-leading-underscore".

[Xenya0815]

The issue is closed but I can't find a option at the documentation. Is it still planned to offer a option like allow-leading-underscore-backing-fields?

[JoshuaKGoldberg]

Thanks for the catch @Xenya0815 - this should have been re-opened.

[adidahiya]

Closing in favor of typescript-eslint/typescript-eslint#816

[JoshuaKGoldberg]

🤖 Beep boop! 👉 TSLint is deprecated 👈 (#4534) and you should switch to typescript-eslint! 🤖

🔒 This issue is being locked to prevent further unnecessary discussions. Thank you! 👋