-
Notifications
You must be signed in to change notification settings - Fork 944
Fix hover JSDoc for mapped type properties #3663
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
Andarist
wants to merge
3
commits into
microsoft:main
Choose a base branch
from
Andarist:fix/jsdoc-on-mapped-symbol
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.
+135
−4
Open
Changes from all commits
Commits
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
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,35 @@ | ||
| package fourslash_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/microsoft/typescript-go/internal/fourslash" | ||
| "github.com/microsoft/typescript-go/internal/testutil" | ||
| ) | ||
|
|
||
| func TestQuickInfoMappedTypeJSDoc(t *testing.T) { | ||
| t.Parallel() | ||
| defer testutil.RecoverAndFail(t, "Panic on fourslash test") | ||
|
|
||
| // https://github.com/microsoft/typescript-go/issues/3659 | ||
| const content = ` | ||
| type Test = { | ||
| /** a's comment */ | ||
| a: string; | ||
| }; | ||
|
|
||
| type Mapped = { | ||
| [K in keyof Test]: number; | ||
| }; | ||
|
|
||
| const x: Mapped = { | ||
| a: 123 | ||
| }; | ||
|
|
||
| x./*1*/a | ||
| ` | ||
| f, done := fourslash.NewFourslash(t, nil /*capabilities*/, content) | ||
| defer done() | ||
|
|
||
| f.VerifyQuickInfoAt(t, "1", "(property) a: number", "a's comment") | ||
| } |
55 changes: 55 additions & 0 deletions
55
internal/fourslash/tests/quickInfoRootSymbolJSDocAggregation_test.go
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,55 @@ | ||
| package fourslash_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/microsoft/typescript-go/internal/fourslash" | ||
| "github.com/microsoft/typescript-go/internal/testutil" | ||
| ) | ||
|
|
||
| func TestQuickInfoRootSymbolJSDocAggregation(t *testing.T) { | ||
| t.Parallel() | ||
| defer testutil.RecoverAndFail(t, "Panic on fourslash test") | ||
|
|
||
| const content = ` | ||
| declare const distinct: { | ||
| /** first */ | ||
| a: number; | ||
| } & { | ||
| /** second */ | ||
| a: number; | ||
| }; | ||
|
|
||
| declare const duplicate: { | ||
| /** same */ | ||
| a: number; | ||
| } & { | ||
| /** same */ | ||
| a: number; | ||
| } & { | ||
| /** third */ | ||
| a: number; | ||
| }; | ||
|
|
||
| declare const mixed: { | ||
| /** first */ | ||
| a: number; | ||
| } & { | ||
| /** second */ | ||
| a: number; | ||
| } & { | ||
| /** first */ | ||
| a: number; | ||
| }; | ||
|
|
||
| distinct./*distinct*/a | ||
| duplicate./*duplicate*/a | ||
| mixed./*mixed*/a | ||
| ` | ||
| f, done := fourslash.NewFourslash(t, nil /*capabilities*/, content) | ||
| defer done() | ||
|
|
||
| f.VerifyQuickInfoAt(t, "distinct", "(property) a: number", "first\nsecond") | ||
| f.VerifyQuickInfoAt(t, "duplicate", "(property) a: number", "same\nthird") | ||
| f.VerifyQuickInfoAt(t, "mixed", "(property) a: number", "first\nsecond") | ||
| } |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GetRootSymbols(symbol)can return multiple candidates (e.g., union/intersection properties). Returning the first non-empty documentation can yield incorrect or non-deterministic hover text when root symbols have differing JSDoc. Consider only returning documentation when it is unique/consistent across all root symbols (e.g., collect non-empty docs and return it only if they’re all identical), otherwise fall back to the existing alias/documentation path.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, actually in Strada all declarations (with some deduplication) contribute to the documentation: https://github.com/microsoft/TypeScript/blob/f350b52331494b68c90ab02e2b6d0828d2a22a74/src/services/jsDoc.ts#L187-L221