Add a setting to collapse comments on resolve (microsoft#192864)

Fixes microsoft/vscode-pull-request-github#5031

src/vs/workbench/contrib/comments/browser/commentThreadWidget.ts

@@ -29,6 +29,8 @@ import { ICellRange } from 'vs/workbench/contrib/notebook/common/notebookRange';
 import { FontInfo } from 'vs/editor/common/config/fontInfo';
 import { IContextMenuService } from 'vs/platform/contextview/browser/contextView';
 import { registerNavigableContainer } from 'vs/workbench/browser/actions/widgetNavigationCommands';
+import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
+import { COMMENTS_SECTION, ICommentsConfiguration } from 'vs/workbench/contrib/comments/common/commentsConfiguration';
 
 export const COMMENTEDITOR_DECORATION_KEY = 'commenteditordecoration';
 
@@ -46,6 +48,8 @@ export class CommentThreadWidget<T extends IRange | ICellRange = IRange> extends
 	private _onDidResize = new Emitter<dom.Dimension>();
 	onDidResize = this._onDidResize.event;
 
+	private _commentThreadState: languages.CommentThreadState | undefined;
+
 	get commentThread() {
 		return this._commentThread;
 	}
@@ -55,7 +59,7 @@ export class CommentThreadWidget<T extends IRange | ICellRange = IRange> extends
 		private _owner: string,
 		private _parentResourceUri: URI,
 		private _contextKeyService: IContextKeyService,
-		private _scopedInstatiationService: IInstantiationService,
+		private _scopedInstantiationService: IInstantiationService,
 		private _commentThread: languages.CommentThread<T>,
 		private _pendingComment: string | undefined,
 		private _pendingEdits: { [key: number]: string } | undefined,
@@ -66,7 +70,8 @@ export class CommentThreadWidget<T extends IRange | ICellRange = IRange> extends
 			collapse: () => void;
 		},
 		@ICommentService private commentService: ICommentService,
-		@IContextMenuService contextMenuService: IContextMenuService
+		@IContextMenuService contextMenuService: IContextMenuService,
+		@IConfigurationService private configurationService: IConfigurationService
 	) {
 		super();
 
@@ -83,7 +88,7 @@ export class CommentThreadWidget<T extends IRange | ICellRange = IRange> extends
 			this._commentMenus,
 			this._commentThread,
 			this._contextKeyService,
-			this._scopedInstatiationService,
+			this._scopedInstantiationService,
 			contextMenuService
 		);
 
@@ -107,15 +112,15 @@ export class CommentThreadWidget<T extends IRange | ICellRange = IRange> extends
 			}
 		}));
 
-		this._body = this._scopedInstatiationService.createInstance(
+		this._body = this._scopedInstantiationService.createInstance(
 			CommentThreadBody,
 			this._owner,
 			this._parentResourceUri,
 			bodyElement,
 			this._markdownOptions,
 			this._commentThread,
 			this._pendingEdits,
-			this._scopedInstatiationService,
+			this._scopedInstantiationService,
 			this
 		) as unknown as CommentThreadBody<T>;
 		this._register(this._body);
@@ -170,6 +175,9 @@ export class CommentThreadWidget<T extends IRange | ICellRange = IRange> extends
 	}
 
 	updateCommentThread(commentThread: languages.CommentThread<T>) {
+		const shouldCollapse = (this._commentThread.collapsibleState === languages.CommentThreadCollapsibleState.Expanded) && (this._commentThreadState === languages.CommentThreadState.Unresolved)
+			&& (commentThread.state === languages.CommentThreadState.Resolved);
+		this._commentThreadState = commentThread.state;
 		this._commentThread = commentThread;
 		dispose(this._commentThreadDisposables);
 		this._commentThreadDisposables = [];
@@ -185,6 +193,10 @@ export class CommentThreadWidget<T extends IRange | ICellRange = IRange> extends
 		} else {
 			this._commentThreadContextValue.reset();
 		}
+
+		if (shouldCollapse && this.configurationService.getValue<ICommentsConfiguration>(COMMENTS_SECTION).collapseOnResolve) {
+			this.collapse();
+		}
 	}
 
 	display(lineHeight: number) {
@@ -243,12 +255,12 @@ export class CommentThreadWidget<T extends IRange | ICellRange = IRange> extends
 	}
 
 	private _createCommentForm() {
-		this._commentReply = this._scopedInstatiationService.createInstance(
+		this._commentReply = this._scopedInstantiationService.createInstance(
 			CommentReply,
 			this._owner,
 			this._body.container,
 			this._commentThread,
-			this._scopedInstatiationService,
+			this._scopedInstantiationService,
 			this._contextKeyService,
 			this._commentMenus,
 			this._commentOptions,
@@ -261,7 +273,7 @@ export class CommentThreadWidget<T extends IRange | ICellRange = IRange> extends
 	}
 
 	private _createAdditionalActions() {
-		this._additionalActions = this._scopedInstatiationService.createInstance(
+		this._additionalActions = this._scopedInstantiationService.createInstance(
 			CommentThreadAdditionalActions,
 			this._body.container,
 			this._commentThread,

src/vs/workbench/contrib/comments/browser/comments.contribution.ts

@@ -44,6 +44,11 @@ Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration).regis
 			type: 'boolean',
 			default: true,
 			description: nls.localize('comments.maxHeight', "Controls whether the comments widget scrolls or expands.")
+		},
+		'comments.collapseOnResolve': {
+			type: 'boolean',
+			default: true,
+			description: nls.localize('collapseOnResolve', "Controls whether the comment thread should collapse when the thread is resolved.")
 		}
 	}
 });

src/vs/workbench/contrib/comments/common/commentsConfiguration.ts

@@ -8,6 +8,7 @@ export interface ICommentsConfiguration {
 	useRelativeTime: boolean;
 	visible: boolean;
 	maxHeight: boolean;
+	collapseOnResolve: boolean;
 }
 
 export const COMMENTS_SECTION = 'comments';