Fix minor typos in protocol.ts #63475
Conversation
|
This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise. |
1 similar comment
|
This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise. |
|
Thanks for the PR! It looks like you've changed the TSServer protocol in some way. Please ensure that any changes here don't break consumers of the current TSServer API. For some extra review, we'll ping @sheetalkamat, @mjbvz, and @joj for you. Feel free to loop in other consumers/maintainers if necessary. |
|
@iamdaven please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
1 similar comment
|
@iamdaven please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
There was a problem hiding this comment.
Pull request overview
This PR updates src/server/protocol.ts, primarily correcting spelling in protocol JSDoc, but it also adjusts the QuickInfoRequest protocol typing and changes the structure of the trailing type-assertion scope.
Changes:
- Fixes multiple typos in JSDoc comments (e.g. “changes” → “changed”, “declarartion” → “declaration”, “arry” → “array”).
- Updates
QuickInfoRequest.argumentsto useQuickInfoRequestArgs(soverbosityLevelis representable in the request type). - Replaces a trailing block scope with an internal
namespace _assertTypesCompletewrapper for type assertions.
| export interface QuickInfoRequest extends FileLocationRequest { | ||
| command: CommandTypes.Quickinfo; | ||
| arguments: FileLocationRequestArgs; | ||
| // FIX: was FileLocationRequestArgs, which silently dropped verbosityLevel | ||
| arguments: QuickInfoRequestArgs; | ||
| } |
| // FIX: was FileLocationRequestArgs, which silently dropped verbosityLevel | ||
| arguments: QuickInfoRequestArgs; |
| /** @internal */ | ||
| namespace _assertTypesComplete { | ||
| type AssertKeysComplete<Source extends { [K in keyof Target]: any; }, Target> = Source; |
No tests required — this change only corrects spelling in JSDoc comments
and does not affect any runtime behavior or public API.