From a2c4a0ca8ca8b86e8dd32e20e596a2e00bfdeaf9 Mon Sep 17 00:00:00 2001
From: Johannes Rieken <johannes.rieken@gmail.com>
Date: Tue, 22 Jun 2021 13:59:29 +0200
Subject: [PATCH] use label, detail, and description for CompletionItemLabel,
 tweak rendering, https://github.com/microsoft/vscode/issues/39441

---
 src/vs/editor/common/modes.ts                 | 22 +++----------------
 .../editor/contrib/suggest/media/suggest.css  |  5 +++--
 src/vs/editor/contrib/suggest/suggest.ts      |  4 ++--
 .../contrib/suggest/suggestWidgetRenderer.ts  |  8 ++-----
 src/vs/editor/contrib/suggest/wordDistance.ts |  2 +-
 src/vs/monaco.d.ts                            | 19 +++-------------
 src/vs/vscode.proposed.d.ts                   | 21 +++++++-----------
 .../api/common/extHostTypeConverters.ts       |  2 +-
 src/vs/workbench/api/common/extHostTypes.ts   |  8 +++----
 .../browser/snippetCompletionProvider.ts      |  8 +++----
 10 files changed, 30 insertions(+), 69 deletions(-)

diff --git a/src/vs/editor/common/modes.ts b/src/vs/editor/common/modes.ts
index 76b00784ef481..d9863fff7fe79 100644
--- a/src/vs/editor/common/modes.ts
+++ b/src/vs/editor/common/modes.ts
@@ -487,25 +487,9 @@ export let completionKindFromString: {
 })();
 
 export interface CompletionItemLabel {
-	/**
-	 * The function or variable. Rendered leftmost.
-	 */
-	name: string;
-
-	/**
-	 * The parameters without the return type. Render after `name`.
-	 */
-	signature?: string;
-
-	/**
-	 * The fully qualified name, like package name or file path. Rendered after `signature`.
-	 */
-	qualifier?: string;
-
-	/**
-	 * The return-type of a function or type of a property/variable. Rendered rightmost.
-	 */
-	type?: string;
+	label: string;
+	detail?: string;
+	description?: string;
 }
 
 export const enum CompletionItemTag {
diff --git a/src/vs/editor/contrib/suggest/media/suggest.css b/src/vs/editor/contrib/suggest/media/suggest.css
index a79237e754310..afef49ab7b91a 100644
--- a/src/vs/editor/contrib/suggest/media/suggest.css
+++ b/src/vs/editor/contrib/suggest/media/suggest.css
@@ -166,9 +166,9 @@
 }
 
 .monaco-editor .suggest-widget .monaco-list .monaco-list-row>.contents>.main>.left>.qualifier-label {
-	margin-left: 4px;
+	margin-left: 12px;
 	opacity: 0.4;
-	font-size: 90%;
+	font-size: 85%;
 	line-height: initial;
 	text-overflow: ellipsis;
 	overflow: hidden;
@@ -178,6 +178,7 @@
 /** Type Info and icon next to the label in the focused completion item **/
 
 .monaco-editor .suggest-widget .monaco-list .monaco-list-row>.contents>.main>.right>.details-label {
+	font-size: 85%;
 	margin-left: 1.1em;
 	overflow: hidden;
 	text-overflow: ellipsis;
diff --git a/src/vs/editor/contrib/suggest/suggest.ts b/src/vs/editor/contrib/suggest/suggest.ts
index ec192ae88cfee..6729ec47a9436 100644
--- a/src/vs/editor/contrib/suggest/suggest.ts
+++ b/src/vs/editor/contrib/suggest/suggest.ts
@@ -74,7 +74,7 @@ export class CompletionItem {
 	) {
 		this.textLabel = typeof completion.label === 'string'
 			? completion.label
-			: completion.label.name;
+			: completion.label.label;
 
 		// ensure lower-variants (perf)
 		this.labelLow = this.textLabel.toLowerCase();
@@ -227,7 +227,7 @@ export async function provideSuggestionItems(
 				}
 				// fill in default sortText when missing
 				if (!suggestion.sortText) {
-					suggestion.sortText = typeof suggestion.label === 'string' ? suggestion.label : suggestion.label.name;
+					suggestion.sortText = typeof suggestion.label === 'string' ? suggestion.label : suggestion.label.label;
 				}
 				if (!needsClipboard && suggestion.insertTextRules && suggestion.insertTextRules & modes.CompletionItemInsertTextRule.InsertAsSnippet) {
 					needsClipboard = SnippetParser.guessNeedsClipboard(suggestion.insertText);
diff --git a/src/vs/editor/contrib/suggest/suggestWidgetRenderer.ts b/src/vs/editor/contrib/suggest/suggestWidgetRenderer.ts
index b466ee9feb14b..7db2c65d3d05f 100644
--- a/src/vs/editor/contrib/suggest/suggestWidgetRenderer.ts
+++ b/src/vs/editor/contrib/suggest/suggestWidgetRenderer.ts
@@ -208,16 +208,12 @@ export class ItemRenderer implements IListRenderer<CompletionItem, ISuggestionTe
 		data.iconLabel.setLabel(element.textLabel, undefined, labelOptions);
 		if (typeof completion.label === 'string') {
 			data.parametersLabel.textContent = '';
-			data.qualifierLabel.textContent = '';
 			data.detailsLabel.textContent = stripNewLines(completion.detail || '');
 			data.root.classList.add('string-label');
-			data.root.title = '';
 		} else {
-			data.parametersLabel.textContent = stripNewLines(completion.label.signature || '');
-			data.qualifierLabel.textContent = stripNewLines(completion.label.qualifier || '');
-			data.detailsLabel.textContent = stripNewLines(completion.label.type || '');
+			data.parametersLabel.textContent = stripNewLines(completion.label.detail || '');
+			data.detailsLabel.textContent = stripNewLines(completion.label.description || '');
 			data.root.classList.remove('string-label');
-			data.root.title = `${element.textLabel}${completion.label.signature ?? ''}  ${completion.label.qualifier ?? ''}  ${completion.label.type ?? ''}`;
 		}
 
 		if (this._editor.getOption(EditorOption.suggest).showInlineDetails) {
diff --git a/src/vs/editor/contrib/suggest/wordDistance.ts b/src/vs/editor/contrib/suggest/wordDistance.ts
index 5226f503f9c81..0f4ce4f132c79 100644
--- a/src/vs/editor/contrib/suggest/wordDistance.ts
+++ b/src/vs/editor/contrib/suggest/wordDistance.ts
@@ -57,7 +57,7 @@ export abstract class WordDistance {
 				if (item.kind === CompletionItemKind.Keyword) {
 					return 2 << 20;
 				}
-				let word = typeof item.label === 'string' ? item.label : item.label.name;
+				let word = typeof item.label === 'string' ? item.label : item.label.label;
 				let wordLines = wordRanges[word];
 				if (isFalsyOrEmpty(wordLines)) {
 					return 2 << 20;
diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
index 3dd99e5814bb8..a139b04c73030 100644
--- a/src/vs/monaco.d.ts
+++ b/src/vs/monaco.d.ts
@@ -5673,22 +5673,9 @@ declare namespace monaco.languages {
 	}
 
 	export interface CompletionItemLabel {
-		/**
-		 * The function or variable. Rendered leftmost.
-		 */
-		name: string;
-		/**
-		 * The parameters without the return type. Render after `name`.
-		 */
-		signature?: string;
-		/**
-		 * The fully qualified name, like package name or file path. Rendered after `signature`.
-		 */
-		qualifier?: string;
-		/**
-		 * The return-type of a function or type of a property/variable. Rendered rightmost.
-		 */
-		type?: string;
+		label: string;
+		detail?: string;
+		description?: string;
 	}
 
 	export enum CompletionItemTag {
diff --git a/src/vs/vscode.proposed.d.ts b/src/vs/vscode.proposed.d.ts
index 93629a1a59992..82f626e638f35 100644
--- a/src/vs/vscode.proposed.d.ts
+++ b/src/vs/vscode.proposed.d.ts
@@ -1406,29 +1406,24 @@ declare module 'vscode' {
 	}
 
 	export interface CompletionItemLabel {
+
 		/**
-		 * The name of this completion item. By default
+		 * The label of this completion item. By default
 		 * this is also the text that is inserted when selecting
 		 * this completion.
 		 */
-		name: string;
-
-		/**
-		 * The signature of this completion item. Will be rendered right after the
-		 * {@link CompletionItemLabel.name name}.
-		 */
-		signature?: string;
+		label: string;
 
 		/**
-		 * The fully qualified name, like package name or file path. Rendered after `signature`.
+		 * A string which is rendered less prominent and directly after {@link CompletionItemLabel.label name}
+		 * without any spacing. Should be used for function signatures or type annotations.
 		 */
-		//todo@API find better name
-		qualifier?: string;
+		detail?: string;
 
 		/**
-		 * The return-type of a function or type of a property/variable. Rendered rightmost.
+		 * The fully qualified name, like package name or file path. Rendered after `detail`.
 		 */
-		type?: string;
+		description?: string;
 	}
 
 	//#endregion
diff --git a/src/vs/workbench/api/common/extHostTypeConverters.ts b/src/vs/workbench/api/common/extHostTypeConverters.ts
index a80dd14a3f361..d9f8c54680fca 100644
--- a/src/vs/workbench/api/common/extHostTypeConverters.ts
+++ b/src/vs/workbench/api/common/extHostTypeConverters.ts
@@ -997,7 +997,7 @@ export namespace CompletionItem {
 
 	export function to(suggestion: modes.CompletionItem, converter?: CommandsConverter): types.CompletionItem {
 
-		const result = new types.CompletionItem(typeof suggestion.label === 'string' ? suggestion.label : suggestion.label.name);
+		const result = new types.CompletionItem(typeof suggestion.label === 'string' ? suggestion.label : suggestion.label.label);
 		if (typeof suggestion.label !== 'string') {
 			result.label2 = suggestion.label;
 		}
diff --git a/src/vs/workbench/api/common/extHostTypes.ts b/src/vs/workbench/api/common/extHostTypes.ts
index 692b105a9dbd4..36efab2c1a315 100644
--- a/src/vs/workbench/api/common/extHostTypes.ts
+++ b/src/vs/workbench/api/common/extHostTypes.ts
@@ -1467,13 +1467,11 @@ export enum CompletionItemTag {
 }
 
 export interface CompletionItemLabel {
-	name: string;
-	parameters?: string;
-	qualifier?: string;
-	type?: string;
+	label: string;
+	detail?: string;
+	description?: string;
 }
 
-
 @es5ClassCompat
 export class CompletionItem implements vscode.CompletionItem {
 
diff --git a/src/vs/workbench/contrib/snippets/browser/snippetCompletionProvider.ts b/src/vs/workbench/contrib/snippets/browser/snippetCompletionProvider.ts
index 111c824d156a1..c6d6dcba43f48 100644
--- a/src/vs/workbench/contrib/snippets/browser/snippetCompletionProvider.ts
+++ b/src/vs/workbench/contrib/snippets/browser/snippetCompletionProvider.ts
@@ -33,7 +33,7 @@ export class SnippetCompletion implements CompletionItem {
 		readonly snippet: Snippet,
 		range: IRange | { insert: IRange, replace: IRange }
 	) {
-		this.label = { name: snippet.prefix, type: snippet.name };
+		this.label = { label: snippet.prefix, description: snippet.name };
 		this.detail = localize('detail.snippet', "{0} ({1})", snippet.description || snippet.name, snippet.source);
 		this.insertText = snippet.codeSnippet;
 		this.range = range;
@@ -48,7 +48,7 @@ export class SnippetCompletion implements CompletionItem {
 	}
 
 	static compareByLabel(a: SnippetCompletion, b: SnippetCompletion): number {
-		return compare(a.label.name, b.label.name);
+		return compare(a.label.label, b.label.label);
 	}
 }
 
@@ -156,10 +156,10 @@ export class SnippetCompletionProvider implements CompletionItemProvider {
 			let item = suggestions[i];
 			let to = i + 1;
 			for (; to < suggestions.length && item.label === suggestions[to].label; to++) {
-				suggestions[to].label.name = localize('snippetSuggest.longLabel', "{0}, {1}", suggestions[to].label.name, suggestions[to].snippet.name);
+				suggestions[to].label.label = localize('snippetSuggest.longLabel', "{0}, {1}", suggestions[to].label.label, suggestions[to].snippet.name);
 			}
 			if (to > i + 1) {
-				suggestions[i].label.name = localize('snippetSuggest.longLabel', "{0}, {1}", suggestions[i].label.name, suggestions[i].snippet.name);
+				suggestions[i].label.label = localize('snippetSuggest.longLabel', "{0}, {1}", suggestions[i].label.label, suggestions[i].snippet.name);
 				i = to;
 			}
 		}