Add ts inline hints #113412
+308
−1
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -270,6 +270,100 @@ | |
| "description": "%configuration.suggest.includeAutomaticOptionalChainCompletions%", | ||
| "scope": "resource" | ||
| }, | ||
| "typescript.inlayHints.includeInlayParameterNameHints": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "none", | ||
| "literals", | ||
| "all" | ||
| ], | ||
|
Comment on lines
+275
to
+279
Member
There was a problem hiding this comment. I think we should add descriptions for these too.
@DanielRosenwasser, can you think of a more approachable way to describe this?
Member
There was a problem hiding this comment. I guess if we can’t find a concise way to explain what literal expressions are or are not, these descriptions don’t add much. |
||
| "default": "none", | ||
| "description": "%configuration.inlayHints.includeInlayParameterNameHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "typescript.inlayHints.includeInlayFunctionParameterTypeHints": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayFunctionParameterTypeHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "typescript.inlayHints.includeInlayVariableTypeHints": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayVariableTypeHints%", | ||
| "scope": "resource" | ||
Kingwl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }, | ||
| "typescript.inlayHints.includeInlayParameterNameHintsWhenArgumentMatchesName": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayParameterNameHintsWhenArgumentMatchesName%", | ||
| "scope": "resource" | ||
| }, | ||
| "typescript.inlayHints.includeInlayPropertyDeclarationTypeHints": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayPropertyDeclarationTypeHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "typescript.inlayHints.includeInlayFunctionLikeReturnTypeHints": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayFunctionLikeReturnTypeHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "typescript.inlayHints.includeInlayEnumMemberValueHints": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayEnumMemberValueHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "javascript.inlayHints.includeInlayParameterNameHints": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "none", | ||
| "literals", | ||
| "all" | ||
| ], | ||
| "default": "none", | ||
| "description": "%configuration.inlayHints.includeInlayParameterNameHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "javascript.inlayHints.includeInlayFunctionParameterTypeHints": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayFunctionParameterTypeHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "javascript.inlayHints.includeInlayVariableTypeHints": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayVariableTypeHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "javascript.inlayHints.includeInlayParameterNameHintsWhenArgumentMatchesName": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayParameterNameHintsWhenArgumentMatchesName%", | ||
| "scope": "resource" | ||
| }, | ||
| "javascript.inlayHints.includeInlayPropertyDeclarationTypeHints": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayPropertyDeclarationTypeHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "javascript.inlayHints.includeInlayFunctionLikeReturnTypeHints": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayFunctionLikeReturnTypeHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "javascript.inlayHints.includeInlayEnumMemberValueHints": { | ||
| "type": "boolean", | ||
| "default": false, | ||
| "description": "%configuration.inlayHints.includeInlayEnumMemberValueHints%", | ||
| "scope": "resource" | ||
| }, | ||
| "javascript.suggest.includeCompletionsForImportStatements": { | ||
| "type": "boolean", | ||
| "default": true, | ||
|
|
||
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
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,143 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See License.txt in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import * as vscode from 'vscode'; | ||
| import * as Proto from '../protocol'; | ||
| import { DocumentSelector } from '../utils/documentSelector'; | ||
| import { ClientCapability, ITypeScriptServiceClient, ServerResponse, ExecConfig } from '../typescriptService'; | ||
| import { conditionalRegistration, requireMinVersion, requireSomeCapability } from '../utils/dependentRegistration'; | ||
| import { Position } from '../utils/typeConverters'; | ||
| import FileConfigurationManager, { getInlayHintsPreferences } from './fileConfigurationManager'; | ||
| import API from '../utils/api'; | ||
| import { isTypeScriptDocument } from '../utils/languageModeIds'; | ||
|
|
||
| namespace ExperimentalProto { | ||
| export const enum CommandTypes { | ||
| ProvideInlineHints = 'ProvideInlayHints' | ||
| } | ||
|
|
||
| export interface InlayHintsArgs extends Proto.FileRequestArgs { | ||
| /** | ||
| * Start position of the span. | ||
| */ | ||
| start: number; | ||
| /** | ||
| * Length of the span. | ||
| */ | ||
| length: number; | ||
| } | ||
|
|
||
| export interface InlineHintsRequest extends Proto.Request { | ||
| command: CommandTypes.ProvideInlineHints; | ||
| arguments: InlayHintsArgs; | ||
| } | ||
|
|
||
| export enum InlayHintKind { | ||
| Type = 'Type', | ||
| Parameter = 'Parameter', | ||
| Enum = 'Enum' | ||
| } | ||
|
|
||
| interface InlayHintItem { | ||
| text: string; | ||
| position: Proto.Location; | ||
| kind?: InlayHintKind; | ||
| whitespaceBefore?: boolean; | ||
| whitespaceAfter?: boolean; | ||
| } | ||
|
|
||
| export interface InlayHintsResponse extends Proto.Response { | ||
| body?: InlayHintItem[]; | ||
| } | ||
|
|
||
| export interface IExtendedTypeScriptServiceClient { | ||
| execute<K extends keyof ExtendedTsServerRequests>( | ||
| command: K, | ||
| args: ExtendedTsServerRequests[K][0], | ||
| token: vscode.CancellationToken, | ||
| config?: ExecConfig | ||
| ): Promise<ServerResponse.Response<ExtendedTsServerRequests[K][1]>>; | ||
| } | ||
|
|
||
| export interface ExtendedTsServerRequests { | ||
| 'provideInlayHints': [InlayHintsArgs, InlayHintsResponse]; | ||
| } | ||
|
|
||
| export namespace InlayHintKind { | ||
| export function fromProtocolInlayHintKind(kind: InlayHintKind): vscode.InlayHintKind { | ||
| switch (kind) { | ||
| case InlayHintKind.Parameter: | ||
| return vscode.InlayHintKind.Parameter; | ||
| case InlayHintKind.Type: | ||
| return vscode.InlayHintKind.Type; | ||
| case InlayHintKind.Enum: | ||
| return vscode.InlayHintKind.Other; | ||
| default: | ||
| return vscode.InlayHintKind.Other; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class TypeScriptInlayHintsProvider implements vscode.InlayHintsProvider { | ||
| public static readonly minVersion = API.v440; | ||
|
|
||
| constructor( | ||
| private readonly client: ITypeScriptServiceClient, | ||
| private readonly fileConfigurationManager: FileConfigurationManager | ||
| ) { } | ||
|
|
||
| async provideInlayHints(model: vscode.TextDocument, range: vscode.Range, token: vscode.CancellationToken): Promise<vscode.InlayHint[]> { | ||
| const filepath = this.client.toOpenedFilePath(model); | ||
| if (!filepath) { | ||
| return []; | ||
| } | ||
|
|
||
| await this.fileConfigurationManager.ensureConfigurationForDocument(model, token); | ||
|
|
||
| if (!this.someInlayHintsEnabled(model)) { | ||
Kingwl marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| return []; | ||
| } | ||
|
|
||
| const start = model.offsetAt(range.start); | ||
| const length = model.offsetAt(range.end) - start; | ||
|
|
||
| const response = await (this.client as ExperimentalProto.IExtendedTypeScriptServiceClient).execute('provideInlayHints', { file: filepath, start, length }, token); | ||
| if (response.type !== 'response' || !response.success || !response.body) { | ||
| return []; | ||
| } | ||
|
|
||
| return response.body.map(hint => { | ||
| const result = new vscode.InlayHint( | ||
| hint.text, | ||
| Position.fromLocation(hint.position), | ||
| hint.kind && ExperimentalProto.InlayHintKind.fromProtocolInlayHintKind(hint.kind) | ||
| ); | ||
| result.whitespaceBefore = hint.whitespaceBefore; | ||
| result.whitespaceAfter = hint.whitespaceAfter; | ||
| return result; | ||
| }); | ||
| } | ||
|
|
||
| private someInlayHintsEnabled(model: vscode.TextDocument) { | ||
Kingwl marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| const config = vscode.workspace.getConfiguration(isTypeScriptDocument(model) ? 'typescript' : 'javascript', model.uri); | ||
|
||
| const preferences = getInlayHintsPreferences(config); | ||
| return Object.values(preferences).some(Boolean); | ||
| } | ||
| } | ||
|
|
||
| export function register( | ||
| selector: DocumentSelector, | ||
| client: ITypeScriptServiceClient, | ||
| fileConfigurationManager: FileConfigurationManager | ||
| ) { | ||
| return conditionalRegistration([ | ||
| requireMinVersion(client, TypeScriptInlayHintsProvider.minVersion), | ||
| requireSomeCapability(client, ClientCapability.Semantic), | ||
| ], () => { | ||
| return vscode.languages.registerInlayHintsProvider(selector.semantic, | ||
| new TypeScriptInlayHintsProvider(client, fileConfigurationManager)); | ||
| }); | ||
| } | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.