Eslint-plugin: Add method-signature-style TypeScript lint rule #62718
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sirreal
added
[Type] Code Quality
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: 0 B Total Size: 1.76 MB ℹ️ View Unchanged
|
sirreal
force-pushed
the
add/method-signature-style-typescript-lint
branch
from
42c407c to
e8d9a20
Compare
youknowriad
approved these changes
Jul 4, 2024
This subtle change can dramatically change the type system's behavior.
```ts
type Rec = Record<string, unknown>;
interface Post extends Rec { status: string; }
interface Base<T> {
isEligibleMethod(item: T): boolean;
isEligibleFunc: (item: T) => boolean;
}
const base: Base<Rec> = {
// Using the "method" type syntax above weakens the type checking.
// This is not a type error!!!
isEligibleMethod: (item: Post) => item.status.startsWith('eli:'),
// This is a type error as expected.
isEligibleFunc: (item: Post) => item.status.startsWith('foo'),
}
```
See https://typescript-eslint.io/rules/method-signature-style
sirreal
force-pushed
the
add/method-signature-style-typescript-lint
branch
from
e8d9a20 to
853ee41
Compare
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Jul 18, 2024
…ress#62718) This subtle different can influence the type system's behavior in dramatic and surprising ways. See https://typescript-eslint.io/rules/method-signature-style for details. --- Co-authored-by: sirreal <jonsurrell@git.wordpress.org> Co-authored-by: youknowriad <youknowriad@git.wordpress.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Add the method-signature-style to the recommended TypeScript rule set.
Why?
This subtle change is not obvious but can dramatically weaken (or strengthen) the type system.
See https://typescript-eslint.io/rules/method-signature-style
This was discovered in #62647 (comment) with the help of @jsnajdr.
How?
Add and enable the rule in the recommended TypeScript rule set.
Testing Instructions
CI passes.