feat(completion): support detail from schema (#243)

Co-authored-by: Martin Aeschlimann <[email protected]>
microsoft · Dec 2, 2024 · 3da5591 · 3da5591
1 parent 601d5eb
commit 3da5591
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/src/jsonSchema.ts b/src/jsonSchema.ts
@@ -85,6 +85,7 @@ export interface JSONSchema {
 	suggestSortText?: string;  // VSCode extension
 	allowComments?: boolean; // VSCode extension
 	allowTrailingCommas?: boolean; // VSCode extension
+	completionDetail?: string; // VSCode extension
 }
 
 export interface JSONSchemaMap {

diff --git a/src/services/jsonCompletion.ts b/src/services/jsonCompletion.ts
@@ -237,8 +237,11 @@ export class JSONCompletion {
 								insertText: this.getInsertTextForProperty(key, propertySchema, addValue, separatorAfter),
 								insertTextFormat: InsertTextFormat.Snippet,
 								filterText: this.getFilterTextForValue(key),
-								documentation: this.fromMarkup(propertySchema.markdownDescription) || propertySchema.description || '',
+								documentation: this.fromMarkup(propertySchema.markdownDescription) || propertySchema.description || ''
 							};
+							if (propertySchema.completionDetail !== undefined) {
+								proposal.detail = propertySchema.completionDetail;
+							}
 							if (propertySchema.suggestSortText !== undefined) {
 								proposal.sortText = propertySchema.suggestSortText;
 							}
@@ -261,8 +264,11 @@ export class JSONCompletion {
 							insertText: this.getInsertTextForProperty(name, undefined, addValue, separatorAfter),
 							insertTextFormat: InsertTextFormat.Snippet,
 							filterText: this.getFilterTextForValue(name),
-							documentation: enumDescription || this.fromMarkup(schemaPropertyNames.markdownDescription) || schemaPropertyNames.description || '',
+							documentation: enumDescription || this.fromMarkup(schemaPropertyNames.markdownDescription) || schemaPropertyNames.description || ''
 						};
+						if (schemaPropertyNames.completionDetail !== undefined) {
+							proposal.detail = schemaPropertyNames.completionDetail;
+						}
 						if (schemaPropertyNames.suggestSortText !== undefined) {
 							proposal.sortText = schemaPropertyNames.suggestSortText;
 						}