API feedback for comment reactor (#202098)

Part of #201131
microsoft · Jan 9, 2024 · a6659cb · a6659cb
1 parent fb84f3b
commit a6659cb
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 3 deletions.
diff --git a/src/vs/editor/common/languages.ts b/src/vs/editor/common/languages.ts
@@ -1777,6 +1777,12 @@ export interface CommentingRanges {
 	fileComments: boolean;
 }
 
+export interface CommentAuthorInformation {
+	name: string;
+	iconPath?: UriComponents;
+
+}
+
 /**
  * @internal
  */

diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -7726,6 +7726,11 @@ declare namespace monaco.languages {
 		arguments?: any[];
 	}
 
+	export interface CommentAuthorInformation {
+		name: string;
+		iconPath?: UriComponents;
+	}
+
 	export interface PendingCommentThread {
 		body: string;
 		range: IRange | undefined;

diff --git a/src/vs/workbench/api/common/extHostComments.ts b/src/vs/workbench/api/common/extHostComments.ts
@@ -697,7 +697,7 @@ export function createExtHostComments(mainContext: IMainContext, commands: ExtHo
 			iconPath: reaction.iconPath ? extHostTypeConverter.pathOrURIToURI(reaction.iconPath) : undefined,
 			count: reaction.count,
 			hasReacted: reaction.authorHasReacted,
-			reactors: reaction.reactors
+			reactors: ((reaction.reactors && (reaction.reactors.length > 0) && (typeof reaction.reactors[0] !== 'string')) ? (reaction.reactors as languages.CommentAuthorInformation[]).map(reactor => reactor.name) : reaction.reactors) as string[]
 		};
 	}
 
@@ -707,7 +707,7 @@ export function createExtHostComments(mainContext: IMainContext, commands: ExtHo
 			count: reaction.count || 0,
 			iconPath: reaction.iconPath ? URI.revive(reaction.iconPath) : '',
 			authorHasReacted: reaction.hasReacted || false,
-			reactors: reaction.reactors
+			reactors: reaction.reactors?.map(reactor => ({ name: reactor }))
 		};
 	}
 

diff --git a/src/vscode-dts/vscode.proposed.commentReactor.d.ts b/src/vscode-dts/vscode.proposed.commentReactor.d.ts
@@ -8,6 +8,6 @@ declare module 'vscode' {
 	// @alexr00 https://github.com/microsoft/vscode/issues/201131
 
 	export interface CommentReaction {
-		readonly reactors?: readonly string[];
+		readonly reactors?: readonly CommentAuthorInformation[];
 	}
 }