Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(eslint-plugin): [prefer-readonly] support modifiers of unions and intersections #8169

Merged
merged 3 commits into from Jan 8, 2024

Conversation

auvred
Copy link
Member

@auvred auvred commented Jan 2, 2024

PR Checklist

Overview

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @auvred!

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.

Copy link

netlify bot commented Jan 2, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 653b438
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/659b92b3da52eb0007584519
😎 Deploy Preview https://deploy-preview-8169--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 90 (🔴 down 9 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 98 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

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

Comment on lines +344 to +349
if (type.isUnion()) {
// any union of class/instance and something else will prevent access to
// private members, so we assume that union consists only of classes
// or class instances, because otherwise tsc will report an error
return this.getTypeToClassRelation(type.types[0]);
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Playground

class Test {
  private foo: number = 1
  private static foo: number

  test() {
    const that1 = {} as typeof Test | this
    that1.foo = 2
    //     ^ 2339: Property 'foo' does not exist on type 'this | typeof Test'

    const that2 = {} as this | { _foo: 'bar' }
    that2.foo = 2
    //     ^ 2339: Property 'foo' does not exist on type 'this | { _foo: "bar"; }'

    const that3 = {} as typeof Test | { _foo: 'bar' }
    that3.foo = 2
    //     ^ 2339: Property 'foo' does not exist on type 'typeof Test | { _foo: "bar"; }'
  }
}

@@ -251,6 +251,13 @@ type ParameterOrPropertyDeclaration =
const OUTSIDE_CONSTRUCTOR = -1;
const DIRECTLY_INSIDE_CONSTRUCTOR = 0;

enum TypeToClassRelation {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Praise] I found this enum and the logic around it to be quite helpful in understanding the new logic. Very readable. Nice! 👏

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯 !

@JoshuaKGoldberg JoshuaKGoldberg merged commit 3a219c0 into typescript-eslint:main Jan 8, 2024
44 of 57 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: [prefer-readonly] False positive if property was assigned after type guard for class properties
2 participants