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

Docs: method-signature-style lint rule ❤ --enforceReadonly compiler flag #9033

Open
2 tasks done
worstpractice opened this issue Apr 30, 2024 · 0 comments
Open
2 tasks done
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating

Comments

@worstpractice
Copy link

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Just a heads up: another Hejlsberg PR comment detailing new upcoming footguns with method signatures.

In addition to their known issues, going forward, method signatures additionally will not enforce readonly type relationships with the coming --enforceReadonly TypeScript compiler flag enabled.

Including this new footgun specific to method signatures in the lint rule docs adds important context regarding the cost/benefit ratio (and reason-to-be) of the method-signature-style lint rule.

Naturally, if and when the --enforceReadonly flag lands in stable TypeScript would be the time to add this information to the method-signature-style docs.

Affected URL(s)

https://typescript-eslint.io/rules/method-signature-style/

@worstpractice worstpractice added documentation Documentation ("docs") that needs adding/updating triage Waiting for maintainers to take a look labels Apr 30, 2024
@bradzacher bradzacher added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

No branches or pull requests

2 participants