fix(eslint-plugin): [class-literal-property-style] correct handling of override cases #5983

sviat9440 · 2022-11-13T16:17:28Z

[prefer-optional-chain] A literal getter with a setter does not pass lint, and incorrectly auto-fix (#5961)

[prefer-optional-chain] The overridden literal getter does not pass lint and incorrectly auto-fix (#5962)

PR Checklist

Addresses an existing open issue: Bug: [class-literal-property-style] A literal getter with a setter does not pass lint, and incorrectly auto-fix #5961, Bug: [class-literal-property-style] The overridden literal getter does not pass lint and incorrectly auto-fix #5962
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

Ignore accessors with computed names (like get [a + b](): string {}, because we cannot be sure that the computed names are not overrides.

/// a.ts

const a = 'a';
const b = 'b';

class A {
  get [a + b](): string {
    return ...;
  }
}

/// b.ts
import { A } from './a';

const a = 'c';
const b = 'd';

class B extends A {
  get [a + b](): string {
    return ...;
  }
}

In this case, visually, the accessors keys are no different, and can be taken as an override. But in fact, this is a completely different key.
So, the supported nodes are now: Identifier, PrivateIdentifier, Literal

The rule now uses type checker, and if parserOptions.project is not defined, rule will cause an error. (BREAKING CHANGE!)
If the literal getter overrides the getter of the parent class. the rule will not cause an error, because there is no way to fix it.
If the literal getter has a setter in a pair, the rule will not cause an error, because there is no way to fix it.

nx-cloud · 2022-11-13T16:17:30Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 704cc72. 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 47 targets

Sent with 💌 from NxCloud.

typescript-eslint · 2022-11-13T16:17:31Z

Thanks for the PR, @sviat9440!

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 · 2022-11-13T16:17:33Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`704cc72`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/63dc26d0cb87de000878f214
😎 Deploy Preview	https://deploy-preview-5983--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 settings.

sviat9440 · 2022-11-13T16:19:45Z

For backward compatibility, I can add a try catch when creating a ParserServices, and not apply logic to find an override if parserOptions.project is not defined. If needed...

codecov · 2022-11-14T06:56:59Z

Codecov Report

Merging #5983 (704cc72) into main (a948729) will decrease coverage by 0.02%.
The diff coverage is 92.30%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5983      +/-   ##
==========================================
- Coverage   91.52%   91.51%   -0.02%     
==========================================
  Files         371      371              
  Lines       12649    12643       -6     
  Branches     3714     3714              
==========================================
- Hits        11577    11570       -7     
  Misses        755      755              
- Partials      317      318       +1

Flag	Coverage Δ
unittest	`91.51% <92.30%> (-0.02%)`	⬇️

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

Impacted Files	Coverage Δ
...t-plugin/src/rules/class-literal-property-style.ts	`97.50% <92.30%> (-2.50%)`	⬇️

bradzacher · 2022-11-15T05:54:59Z

The rule now uses type checker, and if parserOptions.project is not defined, rule will cause an error

Strongly disagree with this change.
Overriding a getter with another getter that specifically and intentionally returns a constant value is a really, really, really rare usecase. TBH I've never actually seen code do it.
The rule is well over 2 years old at this point and you're the first report of the problem - another point in the column of really rare.

It's not worth locking the rule into type information and restricting many people from using it just to prevent a really, really rare false-positive.

As per the comments on #5962 - the change we would accept is making the fixer a suggestion fixer so that the rule cannot automatically fix and break code.

For backward compatibility, I can add a try catch when creating a ParserServices, and not apply logic to find an override if parserOptions.project is not defined. If needed...

Making rules conditionally dependent on type information is not something we really like doing in this project. Most users struggle with understanding config as it is, and adding extra forks to rules dependent on certain configs that are separate to the rule's configs further complicates things.

JoshuaKGoldberg

Blocked on #5961 passing triage. Also what Brad said. 😄

Edit: now just what Brad said.

JoshuaKGoldberg · 2023-01-26T16:00:16Z

Ping @sviat9440 - is this something you have the time to work on? No worries if not, just checking in - thanks!

sviat9440 · 2023-01-27T06:51:27Z

@JoshuaKGoldberg I'll take a look this weekend

[prefer-optional-chain] A literal getter with a setter does not pass lint, and incorrectly auto-fix (typescript-eslint#5961) [prefer-optional-chain] The overridden literal getter does not pass lint and incorrectly auto-fix (typescript-eslint#5962)

JoshuaKGoldberg

LGTM, thanks! I'll defer to @bradzacher since Brad was active in the comments, and this is a tricky edge case kind of scenario.

packages/eslint-plugin/src/rules/class-literal-property-style.ts

JoshuaKGoldberg

Whoops, meant to request changes on the test coverage dipping...

sviat9440 · 2023-02-02T21:10:50Z

@JoshuaKGoldberg ready to go

bradzacher · 2023-02-07T13:30:55Z

packages/eslint-plugin/src/rules/class-literal-property-style.ts

+    case AST_NODE_TYPES.Identifier:
+      return key.name;
+    case AST_NODE_TYPES.Literal:
+      return key.raw;


You can't use .raw here because:

For strings it encodes in the quotes and backslashes.

For numbers it encodes the _ separators, decimal points, and differentiates between binary/octal/hex/decimal notation

For bigints it encodes the _ separators

EG this would mean that these cases are not matched:

class Foo { get 'a\"'() { return 1; } set 'a"'(v) { } get 'a'() { return 1; } set "a"(v) {} get 11() { return 1; } set 1_1(v) { } get 1.0() { return 1; } set 1(v) { } get 0b10() { return 1; } set 2(v) { } get 0o10() { return 1; } set 8(v) { } get 0x10() { return 1; } set 16(v) { } }

Cases case to be careful of:

RegExp literals are not primitives, so .value === .value will not work.

BigInt literals can technically be .value = null, but shouldn't really ever be.

bradzacher · 2023-02-07T13:32:05Z

packages/eslint-plugin/src/rules/class-literal-property-style.ts

+                item.kind === 'set' &&
+                isEqualPropertyKey(node.key, item.key),


this also needs to check .computed or else you will false negative on this case:

const key = 'not key lol'; class Foo { get key() { return 'a' } set [key](arg) {} }

Though worth noting that right now your logic correctly handles this case:

class Foo { get 'key'() { return 'a' } set ['key'](arg) {} }

If we want to keep handling this case then the logic change will need to be more sophisticated than just checking .computed

bradzacher · 2023-02-07T13:35:04Z

packages/eslint-plugin/src/rules/class-literal-property-style.ts

+            const setter = classBody.body.find(
+              item =>
+                item.type === AST_NODE_TYPES.MethodDefinition &&
+                item.kind === 'set' &&
+                isEqualPropertyKey(node.key, item.key),
+            );


This logic also does not respect static and thus will false negative on this case:

class Foo { get key() { return 'a' } static set key(arg) {} }

JoshuaKGoldberg · 2023-03-13T04:56:29Z

👋 ping @sviat9440, is this still something you have time for? No worries if not - I just don't want to leave it hanging.

JoshuaKGoldberg · 2023-04-05T16:53:47Z

Closing this PR as it's been stale for ~6 weeks without activity. Feel free to reopen @sviat9440 if you have time - but no worries if not! If anybody wants to drive it forward, please do post your own PR - and if you use this as a start, consider adding Co-authored-by: @sviat9440 at the end of your PR description. Thanks! 😊

sviat9440 force-pushed the fix/5961_5962 branch from 9674865 to 0e63dd7 Compare November 14, 2022 06:41

bradzacher changed the title ~~fix(class-literal-property-style)~~ fix(eslint-plugin): [class-literal-property-style] correct handling of override cases Nov 15, 2022

JoshuaKGoldberg requested changes Nov 15, 2022

View reviewed changes

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Nov 15, 2022

sviat9440 force-pushed the fix/5961_5962 branch from aca7b04 to f719f93 Compare January 29, 2023 06:51

sviat9440 requested a review from JoshuaKGoldberg January 29, 2023 06:51

sviat9440 force-pushed the fix/5961_5962 branch from f719f93 to ea4fdcc Compare January 29, 2023 06:52

fix(class-literal-property-style):

3be9f6e

[prefer-optional-chain] A literal getter with a setter does not pass lint, and incorrectly auto-fix (typescript-eslint#5961) [prefer-optional-chain] The overridden literal getter does not pass lint and incorrectly auto-fix (typescript-eslint#5962)

sviat9440 force-pushed the fix/5961_5962 branch from ea4fdcc to 3be9f6e Compare January 29, 2023 07:28

JoshuaKGoldberg approved these changes Jan 31, 2023

View reviewed changes

packages/eslint-plugin/src/rules/class-literal-property-style.ts Show resolved Hide resolved

JoshuaKGoldberg assigned bradzacher Jan 31, 2023

JoshuaKGoldberg requested changes Jan 31, 2023

View reviewed changes

Святослав Зайцев and others added 3 commits February 2, 2023 11:15

fix(class-literal-property-style): fix coverage

acd5884

Merge branch 'main' into fix/5961_5962

39c0baf

Merge branch 'main' into fix/5961_5962

704cc72

JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Feb 3, 2023

bradzacher requested changes Feb 7, 2023

View reviewed changes

bradzacher removed the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Feb 7, 2023

bradzacher added the bug Something isn't working label Mar 15, 2023

JoshuaKGoldberg closed this Apr 5, 2023

github-actions bot locked as resolved and limited conversation to collaborators Apr 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [class-literal-property-style] correct handling of override cases #5983

fix(eslint-plugin): [class-literal-property-style] correct handling of override cases #5983

sviat9440 commented Nov 13, 2022 •

edited by Josh-Cena

Loading

nx-cloud bot commented Nov 13, 2022 •

edited

Loading

typescript-eslint bot commented Nov 13, 2022

netlify bot commented Nov 13, 2022 •

edited

Loading

sviat9440 commented Nov 13, 2022

codecov bot commented Nov 14, 2022 •

edited

Loading

bradzacher commented Nov 15, 2022

JoshuaKGoldberg left a comment •

edited

Loading

JoshuaKGoldberg commented Jan 26, 2023

sviat9440 commented Jan 27, 2023

JoshuaKGoldberg left a comment

JoshuaKGoldberg left a comment

sviat9440 commented Feb 2, 2023

bradzacher Feb 7, 2023 •

edited

Loading

bradzacher Feb 7, 2023

bradzacher Feb 7, 2023

JoshuaKGoldberg commented Mar 13, 2023

JoshuaKGoldberg commented Apr 5, 2023

		item.kind === 'set' &&
		isEqualPropertyKey(node.key, item.key),

fix(eslint-plugin): [class-literal-property-style] correct handling of override cases #5983

fix(eslint-plugin): [class-literal-property-style] correct handling of override cases #5983

Conversation

sviat9440 commented Nov 13, 2022 • edited by Josh-Cena Loading

PR Checklist

Overview

nx-cloud bot commented Nov 13, 2022 • edited Loading

☁️ Nx Cloud Report

typescript-eslint bot commented Nov 13, 2022

netlify bot commented Nov 13, 2022 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

sviat9440 commented Nov 13, 2022

codecov bot commented Nov 14, 2022 • edited Loading

Codecov Report

bradzacher commented Nov 15, 2022

JoshuaKGoldberg left a comment • edited Loading

Choose a reason for hiding this comment

JoshuaKGoldberg commented Jan 26, 2023

sviat9440 commented Jan 27, 2023

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

sviat9440 commented Feb 2, 2023

bradzacher Feb 7, 2023 • edited Loading

Choose a reason for hiding this comment

bradzacher Feb 7, 2023

Choose a reason for hiding this comment

bradzacher Feb 7, 2023

Choose a reason for hiding this comment

JoshuaKGoldberg commented Mar 13, 2023

JoshuaKGoldberg commented Apr 5, 2023

sviat9440 commented Nov 13, 2022 •

edited by Josh-Cena

Loading

nx-cloud bot commented Nov 13, 2022 •

edited

Loading

netlify bot commented Nov 13, 2022 •

edited

Loading

codecov bot commented Nov 14, 2022 •

edited

Loading

JoshuaKGoldberg left a comment •

edited

Loading

bradzacher Feb 7, 2023 •

edited

Loading