-
Notifications
You must be signed in to change notification settings - Fork 858
Fix completions for contextually constrained types in JSDoc #3011
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
DanielRosenwasser
wants to merge
4
commits into
main
Choose a base branch
from
completionsConstraintInJsDocObjectType
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.
+72
−1
Open
Changes from all commits
Commits
Show all changes
4 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
58 changes: 58 additions & 0 deletions
58
internal/fourslash/tests/completionsForContextualConstraintTypeInJsDoc_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,58 @@ | ||
| package fourslash_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/microsoft/typescript-go/internal/fourslash" | ||
| "github.com/microsoft/typescript-go/internal/testutil" | ||
| ) | ||
|
|
||
| func TestCompletionsForContextualConstraintTypeInJsDoc(t *testing.T) { | ||
| t.Parallel() | ||
| defer testutil.RecoverAndFail(t, "Panic on fourslash test") | ||
|
|
||
| const content = ` | ||
| // @allowJs: true | ||
| // @filename: a.ts | ||
| export interface Blah<T extends { a: "hello" | "world" }> { | ||
| } | ||
|
|
||
| // @filename: b.js | ||
| /** @import * as a from "./a" */ | ||
|
|
||
| /** @type {a.Blah<{ a: /*1*/ }>} */ | ||
| let x; | ||
|
|
||
| // @filename: c.js | ||
| /** @import * as a from "./a" */ | ||
|
|
||
| /** @type {a.Blah<{ a: /*2*/ }>} */ | ||
| ` | ||
|
|
||
| f, done := fourslash.NewFourslash(t, nil /*capabilities*/, content) | ||
| defer done() | ||
|
|
||
| // These examples both would panic in retrieving the symbols | ||
| // of property signature nodes within JSDoc types. | ||
| // In both cases, we'd have a JSDoc property signature that has no symbol. | ||
| // | ||
| // The two cases differ in whether or not there is a variable declaration | ||
| // following the `@type` comment. These are important to test differently | ||
| // because of how JSDoc re-parsing would construct nodes in the tree. | ||
| // | ||
| // Getting the symbol of the reparsed node is a sufficient fix for marker 1. | ||
| // However, that would not fix the case at marker 2 because | ||
| // there is no variable to attach the `@type` annotation, so the node basically | ||
| // doesn't exist for subsequent passes like the binder. | ||
|
|
||
| f.VerifyCompletions(t, f.Markers(), &fourslash.CompletionsExpectedList{ | ||
| IsIncomplete: false, | ||
| ItemDefaults: &fourslash.CompletionsExpectedItemDefaults{CommitCharacters: &[]string{".", ",", ";"}}, | ||
| Items: &fourslash.CompletionsExpectedItems{ | ||
| Includes: []fourslash.CompletionsExpectedItem{ | ||
| `"hello"`, | ||
| `"world"`, | ||
| }, | ||
| }, | ||
| }) | ||
| } | ||
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
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.
CompletionsExpectedItemDefaults.EditRange is left as nil here, which will assert that the server returns a nil CompletionItemDefaults.EditRange. For type-literal completions the server typically sets an edit range; this test should set EditRange to Ignored (or assert the exact range) to avoid a hard failure.
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.
Hard failure? What?
I do wonder if we need to specify any of these
ItemDefaultsthough.