-
Notifications
You must be signed in to change notification settings - Fork 13.8k
Fix false positive TS8030 for JSDoc @type on optional interface methods #64052
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
Open
종윤 (jyx-07)
wants to merge
2
commits into
microsoft:main
Choose a base branch
from
jyx-07:fix/jsdoc-optional-method-8030
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
20 changes: 20 additions & 0 deletions
20
tsc/testdata/baselines/reference/compiler/jsdocOptionalMethodFullSignature.errors.txt
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| /a.js(10,12): error TS8030: A JSDoc '@type' tag on a function must have a signature with the correct number of arguments. | ||
|
|
||
|
|
||
| ==== /a.js (1 errors) ==== | ||
| /** @typedef {{ method?: (s: string) => number }} Example */ | ||
|
|
||
| const example = { | ||
| /** @type {Example['method']} */ | ||
| method(s) { | ||
| return s.length; | ||
| } | ||
| }; | ||
|
|
||
| /** @type {Example['method']} */ | ||
| ~~~~~~~~~~~~~~~~~ | ||
| !!! error TS8030: A JSDoc '@type' tag on a function must have a signature with the correct number of arguments. | ||
| function tooManyParams(s, extra) { | ||
| return 0; | ||
| } | ||
|
|
29 changes: 29 additions & 0 deletions
29
tsc/testdata/baselines/reference/compiler/jsdocOptionalMethodFullSignature.symbols
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| //// [tests/cases/compiler/jsdocOptionalMethodFullSignature.ts] //// | ||
|
|
||
| === /a.js === | ||
| /** @typedef {{ method?: (s: string) => number }} Example */ | ||
|
|
||
| const example = { | ||
| >example : Symbol(example, Decl(a.js, 2, 5)) | ||
|
|
||
| /** @type {Example['method']} */ | ||
| method(s) { | ||
| >method : Symbol(method, Decl(a.js, 2, 17)) | ||
| >s : Symbol(s, Decl(a.js, 4, 9)) | ||
|
|
||
| return s.length; | ||
| >s.length : Symbol(String.length, Decl(lib.es5.d.ts, --, --)) | ||
| >s : Symbol(s, Decl(a.js, 4, 9)) | ||
| >length : Symbol(String.length, Decl(lib.es5.d.ts, --, --)) | ||
| } | ||
| }; | ||
|
|
||
| /** @type {Example['method']} */ | ||
| function tooManyParams(s, extra) { | ||
| >tooManyParams : Symbol(tooManyParams, Decl(a.js, 7, 2)) | ||
| >s : Symbol(s, Decl(a.js, 10, 23)) | ||
| >extra : Symbol(extra, Decl(a.js, 10, 25)) | ||
|
|
||
| return 0; | ||
| } | ||
|
|
31 changes: 31 additions & 0 deletions
31
tsc/testdata/baselines/reference/compiler/jsdocOptionalMethodFullSignature.types
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| //// [tests/cases/compiler/jsdocOptionalMethodFullSignature.ts] //// | ||
|
|
||
| === /a.js === | ||
| /** @typedef {{ method?: (s: string) => number }} Example */ | ||
|
|
||
| const example = { | ||
| >example : { method(s: string): number; } | ||
| >{ /** @type {Example['method']} */ method(s) { return s.length; }} : { method(s: string): number; } | ||
|
|
||
| /** @type {Example['method']} */ | ||
| method(s) { | ||
| >method : (s: string) => number | ||
| >s : string | ||
|
|
||
| return s.length; | ||
| >s.length : number | ||
| >s : string | ||
| >length : number | ||
| } | ||
| }; | ||
|
|
||
| /** @type {Example['method']} */ | ||
| function tooManyParams(s, extra) { | ||
| >tooManyParams : (s: string) => number | ||
| >s : string | ||
| >extra : any | ||
|
|
||
| return 0; | ||
| >0 : 0 | ||
| } | ||
|
|
19 changes: 19 additions & 0 deletions
19
tsc/testdata/tests/cases/compiler/jsdocOptionalMethodFullSignature.ts
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| // @target: es2015 | ||
| // @allowJs: true | ||
| // @checkJs: true | ||
| // @noEmit: true | ||
|
|
||
| // @Filename: /a.js | ||
| /** @typedef {{ method?: (s: string) => number }} Example */ | ||
|
|
||
| const example = { | ||
| /** @type {Example['method']} */ | ||
| method(s) { | ||
| return s.length; | ||
| } | ||
| }; | ||
|
|
||
| /** @type {Example['method']} */ | ||
| function tooManyParams(s, extra) { | ||
| return 0; | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.