Inline Hints controller and API proposal

extensions/typescript-language-features/src/languageFeatures/signatureArgumentsLabel.ts

@@ -0,0 +1,49 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 { DocumentSelector } from '../utils/documentSelector';
+import { ClientCapability, ITypeScriptServiceClient } from '../typescriptService';
+import { conditionalRegistration, requireSomeCapability } from '../utils/dependentRegistration';
+import { Position } from '../utils/typeConverters';
+
+class TypeScriptSginatureArgumentsLabelProvider implements vscode.SignatureArgumentsLabelProvider {
+	constructor(
+		private readonly client: ITypeScriptServiceClient
+	) { }
+
+	async provideSignatureArgumentsLabels(model: vscode.TextDocument, token: vscode.CancellationToken): Promise<vscode.SignautreArgumentsLabel[]> {
+		const filepath = this.client.toOpenedFilePath(model);
+		if (!filepath) {
+			return [];
+		}
+
+		try {
+			const response = await this.client.execute('provideSignatureArgumentsLabel', { file: filepath }, token);
+			if (response.type !== 'response' || !response.success || !response.body) {
+				return [];
+			}
+
+			const labels = response.body.map(label => {
+				return new vscode.SignautreArgumentsLabel(label.name, Position.fromLocation(label.position));
+			});
+			return labels;
+		} catch (e) {
+			return [];
+		}
+	}
+}
+
+export function register(
+	selector: DocumentSelector,
+	client: ITypeScriptServiceClient
+) {
+	return conditionalRegistration([
+		requireSomeCapability(client, ClientCapability.Semantic),
+	], () => {
+		return vscode.languages.registerSignatureArgumentsLabelProvider(selector.semantic,
+			new TypeScriptSginatureArgumentsLabelProvider(client));
+	});
+}

extensions/typescript-language-features/src/languageProvider.ts

@@ -82,6 +82,7 @@ export default class LanguageProvider extends Disposable {
 			import('./languageFeatures/typeDefinitions').then(provider => this._register(provider.register(selector, this.client))),
 			import('./languageFeatures/semanticTokens').then(provider => this._register(provider.register(selector, this.client))),
 			import('./languageFeatures/callHierarchy').then(provider => this._register(provider.register(selector, this.client))),
+			import('./languageFeatures/signatureArgumentsLabel').then(provider => this._register(provider.register(selector, this.client))),
 		]);
 	}
 

extensions/typescript-language-features/src/typescriptService.ts

@@ -13,6 +13,25 @@ import { TypeScriptServiceConfiguration } from './utils/configuration';
 import { PluginManager } from './utils/plugins';
 import { TelemetryReporter } from './utils/telemetry';
 
+export namespace Experimental {
+	export const enum CommandTypes {
+		ProvideSignatureArgumentsLabel = 'provideSignatureArgumentsLabel'
+	}
+
+	export interface ProvideSignatureArgumentsLabelRequest extends Proto.FileRequest {
+		command: CommandTypes.ProvideSignatureArgumentsLabel;
+	}
+
+	interface LabelItem {
+		name: string
+		position: Proto.Location
+	}
+
+	export interface ProvideSignatureArgumentsLabelResponse extends Proto.Response {
+		body?: LabelItem[];
+	}
+}
+
 export enum ServerType {
 	Syntax = 'syntax',
 	Semantic = 'semantic',
@@ -68,6 +87,7 @@ interface StandardTsServerRequests {
 	'prepareCallHierarchy': [Proto.FileLocationRequestArgs, Proto.PrepareCallHierarchyResponse];
 	'provideCallHierarchyIncomingCalls': [Proto.FileLocationRequestArgs, Proto.ProvideCallHierarchyIncomingCallsResponse];
 	'provideCallHierarchyOutgoingCalls': [Proto.FileLocationRequestArgs, Proto.ProvideCallHierarchyOutgoingCallsResponse];
+	'provideSignatureArgumentsLabel': [Proto.FileRequestArgs, Experimental.ProvideSignatureArgumentsLabelResponse];
 }
 
 interface NoResponseTsServerRequests {

src/vs/editor/browser/widget/codeEditorWidget.ts

@@ -1834,6 +1834,7 @@ export class EditorModeContext extends Disposable {
 	private readonly _hasMultipleDocumentFormattingProvider: IContextKey<boolean>;
 	private readonly _hasMultipleDocumentSelectionFormattingProvider: IContextKey<boolean>;
 	private readonly _hasSignatureHelpProvider: IContextKey<boolean>;
+	private readonly _hasSignatureArgumentsLabelProvider: IContextKey<boolean>;
 	private readonly _isInWalkThrough: IContextKey<boolean>;
 
 	constructor(
@@ -1856,6 +1857,7 @@ export class EditorModeContext extends Disposable {
 		this._hasReferenceProvider = EditorContextKeys.hasReferenceProvider.bindTo(_contextKeyService);
 		this._hasRenameProvider = EditorContextKeys.hasRenameProvider.bindTo(_contextKeyService);
 		this._hasSignatureHelpProvider = EditorContextKeys.hasSignatureHelpProvider.bindTo(_contextKeyService);
+		this._hasSignatureArgumentsLabelProvider = EditorContextKeys.hasSignatureArgumentsLabelProvider.bindTo(_contextKeyService);
 		this._hasDocumentFormattingProvider = EditorContextKeys.hasDocumentFormattingProvider.bindTo(_contextKeyService);
 		this._hasDocumentSelectionFormattingProvider = EditorContextKeys.hasDocumentSelectionFormattingProvider.bindTo(_contextKeyService);
 		this._hasMultipleDocumentFormattingProvider = EditorContextKeys.hasMultipleDocumentFormattingProvider.bindTo(_contextKeyService);
@@ -1884,6 +1886,7 @@ export class EditorModeContext extends Disposable {
 		this._register(modes.DocumentFormattingEditProviderRegistry.onDidChange(update));
 		this._register(modes.DocumentRangeFormattingEditProviderRegistry.onDidChange(update));
 		this._register(modes.SignatureHelpProviderRegistry.onDidChange(update));
+		this._register(modes.SignatureArgumentsLabelProviderRegistry.onDidChange(update));
 
 		update();
 	}
@@ -1935,6 +1938,7 @@ export class EditorModeContext extends Disposable {
 			this._hasReferenceProvider.set(modes.ReferenceProviderRegistry.has(model));
 			this._hasRenameProvider.set(modes.RenameProviderRegistry.has(model));
 			this._hasSignatureHelpProvider.set(modes.SignatureHelpProviderRegistry.has(model));
+			this._hasSignatureArgumentsLabelProvider.set(modes.SignatureArgumentsLabelProviderRegistry.has(model));
 			this._hasDocumentFormattingProvider.set(modes.DocumentFormattingEditProviderRegistry.has(model) || modes.DocumentRangeFormattingEditProviderRegistry.has(model));
 			this._hasDocumentSelectionFormattingProvider.set(modes.DocumentRangeFormattingEditProviderRegistry.has(model));
 			this._hasMultipleDocumentFormattingProvider.set(modes.DocumentFormattingEditProviderRegistry.all(model).length + modes.DocumentRangeFormattingEditProviderRegistry.all(model).length > 1);

src/vs/editor/common/config/editorOptions.ts

@@ -625,6 +625,10 @@ export interface IEditorOptions {
 	 * Controls strikethrough deprecated variables.
 	 */
 	showDeprecated?: boolean;
+	/**
+	 * Controls show signature arguments label.
+	 */
+	showSignatureArgumentsLabel?: boolean
 }
 
 /**
@@ -3759,7 +3763,7 @@ export const enum EditorOption {
 	wrappingIndent,
 	wrappingStrategy,
 	showDeprecated,
-
+	showSignatureArgumentsLabel,
 	// Leave these at the end (because they have dependencies!)
 	editorClassName,
 	pixelRatio,
@@ -4263,6 +4267,10 @@ export const EditorOptions = {
 		EditorOption.showDeprecated, 'showDeprecated', true,
 		{ description: nls.localize('showDeprecated', "Controls strikethrough deprecated variables.") }
 	)),
+	showSignatureArgumentsLabel: register(new EditorBooleanOption(
+		EditorOption.showSignatureArgumentsLabel, 'showSignatureArgumentsLabel', true,
+		{ description: nls.localize('showSignatureArgumentsLabel', "Controls show signature arguments label.") }
+	)),
 	snippetSuggestions: register(new EditorStringEnumOption(
 		EditorOption.snippetSuggestions, 'snippetSuggestions',
 		'inline' as 'top' | 'bottom' | 'inline' | 'none',

src/vs/editor/common/editorContextKeys.ts

@@ -61,6 +61,7 @@ export namespace EditorContextKeys {
 	export const hasReferenceProvider = new RawContextKey<boolean>('editorHasReferenceProvider', false);
 	export const hasRenameProvider = new RawContextKey<boolean>('editorHasRenameProvider', false);
 	export const hasSignatureHelpProvider = new RawContextKey<boolean>('editorHasSignatureHelpProvider', false);
+	export const hasSignatureArgumentsLabelProvider = new RawContextKey<boolean>('editorHasSignatureArgumentsLabelProvider', false);
 
 	// -- mode context keys: formatting
 	export const hasDocumentFormattingProvider = new RawContextKey<boolean>('editorHasDocumentFormattingProvider', false);

src/vs/editor/common/modes.ts

@@ -9,7 +9,7 @@ import { Event } from 'vs/base/common/event';
 import { IMarkdownString } from 'vs/base/common/htmlContent';
 import { IDisposable } from 'vs/base/common/lifecycle';
 import { URI, UriComponents } from 'vs/base/common/uri';
-import { Position } from 'vs/editor/common/core/position';
+import { IPosition, Position } from 'vs/editor/common/core/position';
 import { IRange, Range } from 'vs/editor/common/core/range';
 import { Selection } from 'vs/editor/common/core/selection';
 import { TokenizationResult, TokenizationResult2 } from 'vs/editor/common/core/token';
@@ -1659,6 +1659,15 @@ export interface CodeLensProvider {
 	resolveCodeLens?(model: model.ITextModel, codeLens: CodeLens, token: CancellationToken): ProviderResult<CodeLens>;
 }
 
+export interface SignautreArgumentsLabel {
+	name: string
+	position: IPosition
+}
+
+export interface SignatureArgumentsLabelProvider {
+	provideSignatureArgumentsLabels(model: model.ITextModel, token: CancellationToken): ProviderResult<SignautreArgumentsLabel[]>;
+}
+
 export interface SemanticTokensLegend {
 	readonly tokenTypes: string[];
 	readonly tokenModifiers: string[];
@@ -1763,6 +1772,10 @@ export const TypeDefinitionProviderRegistry = new LanguageFeatureRegistry<TypeDe
  * @internal
  */
 export const CodeLensProviderRegistry = new LanguageFeatureRegistry<CodeLensProvider>();
+/**
+ * @internal
+ */
+export const SignatureArgumentsLabelProviderRegistry = new LanguageFeatureRegistry<SignatureArgumentsLabelProvider>();
 
 /**
  * @internal

src/vs/editor/common/standalone/standaloneEnums.ts

@@ -287,11 +287,12 @@ export enum EditorOption {
 	wrappingIndent = 117,
 	wrappingStrategy = 118,
 	showDeprecated = 119,
-	editorClassName = 120,
-	pixelRatio = 121,
-	tabFocusMode = 122,
-	layoutInfo = 123,
-	wrappingInfo = 124
+	showSignatureArgumentsLabel = 120,
+	editorClassName = 121,
+	pixelRatio = 122,
+	tabFocusMode = 123,
+	layoutInfo = 124,
+	wrappingInfo = 125
 }
 
 /**