Moves view description to ViewBase

eamodio · eamodio · commit a43f4bf70091 · 2024-11-11T03:40:25.000-05:00
Fixes focus issue when attaching/detaching views
diff --git a/src/views/branchesView.ts b/src/views/branchesView.ts
@@ -48,7 +48,7 @@ export class BranchesRepositoryNode extends RepositoryFolderNode<BranchesView, B
 
 export class BranchesViewNode extends RepositoriesSubscribeableNode<BranchesView, BranchesRepositoryNode> {
 	async getChildren(): Promise<ViewNode[]> {
-		this.view.description = this.getViewDescription();
+		this.view.description = this.view.getViewDescription();
 		this.view.message = undefined;
 
 		if (this.children == null) {
@@ -91,7 +91,7 @@ export class BranchesViewNode extends RepositoriesSubscribeableNode<BranchesView
 				return [];
 			}
 
-			this.view.description = this.getViewDescription(branches.values.length);
+			this.view.description = this.view.getViewDescription(branches.values.length);
 
 			return child.getChildren();
 		}
diff --git a/src/views/commitsView.ts b/src/views/commitsView.ts
@@ -121,7 +121,7 @@ export class CommitsRepositoryNode extends RepositoryFolderNode<CommitsView, Bra
 export class CommitsViewNode extends RepositoriesSubscribeableNode<CommitsView, CommitsRepositoryNode> {
 	async getChildren(): Promise<ViewNode[]> {
 		if (this.children == null) {
-			this.view.description = this.getViewDescription();
+			this.view.description = this.view.getViewDescription();
 			this.view.message = undefined;
 
 			const repositories = this.view.container.git.openRepositories;
diff --git a/src/views/contributorsView.ts b/src/views/contributorsView.ts
@@ -53,7 +53,7 @@ export class ContributorsRepositoryNode extends RepositoryFolderNode<Contributor
 
 export class ContributorsViewNode extends RepositoriesSubscribeableNode<ContributorsView, ContributorsRepositoryNode> {
 	async getChildren(): Promise<ViewNode[]> {
-		this.view.description = this.getViewDescription();
+		this.view.description = this.view.getViewDescription();
 		this.view.message = undefined;
 
 		if (this.children == null) {
@@ -106,7 +106,7 @@ export class ContributorsViewNode extends RepositoriesSubscribeableNode<Contribu
 				return [];
 			}
 
-			this.view.description = this.getViewDescription(children.length);
+			this.view.description = this.view.getViewDescription(children.length);
 
 			return children;
 		}
diff --git a/src/views/nodes/abstract/repositoriesSubscribeableNode.ts b/src/views/nodes/abstract/repositoriesSubscribeableNode.ts
@@ -31,12 +31,6 @@ export abstract class RepositoriesSubscribeableNode<
 		return szudzikPairing(this.view.container.git.etag, this.view.container.subscription.etag);
 	}
 
-	protected getViewDescription(count?: number) {
-		return `${this.view.grouped ? `${this.view.name.toLocaleLowerCase()} ` : ''}${
-			count != null ? `(${count})` : ''
-		}`;
-	}
-
 	@debug()
 	protected subscribe(): Disposable | Promise<Disposable> {
 		return Disposable.from(
diff --git a/src/views/remotesView.ts b/src/views/remotesView.ts
@@ -48,7 +48,7 @@ export class RemotesRepositoryNode extends RepositoryFolderNode<RemotesView, Rem
 
 export class RemotesViewNode extends RepositoriesSubscribeableNode<RemotesView, RemotesRepositoryNode> {
 	async getChildren(): Promise<ViewNode[]> {
-		this.view.description = this.getViewDescription();
+		this.view.description = this.view.getViewDescription();
 		this.view.message = undefined;
 
 		if (this.children == null) {
@@ -83,7 +83,7 @@ export class RemotesViewNode extends RepositoriesSubscribeableNode<RemotesView,
 				return [];
 			}
 
-			this.view.description = this.getViewDescription(remotes.length);
+			this.view.description = this.view.getViewDescription(remotes.length);
 
 			return child.getChildren();
 		}
diff --git a/src/views/scmGroupedView.ts b/src/views/scmGroupedView.ts
@@ -30,15 +30,15 @@ export class ScmGroupedView implements Disposable {
 
 				executeCommand(`gitlens.views.${this._view.type}.refresh` as Commands);
 			}),
-			registerCommand('gitlens.views.scm.grouped.branches', () => this.setView('branches')),
-			registerCommand('gitlens.views.scm.grouped.commits', () => this.setView('commits')),
-			registerCommand('gitlens.views.scm.grouped.contributors', () => this.setView('contributors')),
-			registerCommand('gitlens.views.scm.grouped.remotes', () => this.setView('remotes')),
-			registerCommand('gitlens.views.scm.grouped.repositories', () => this.setView('repositories')),
-			registerCommand('gitlens.views.scm.grouped.searchAndCompare', () => this.setView('searchAndCompare')),
-			registerCommand('gitlens.views.scm.grouped.stashes', () => this.setView('stashes')),
-			registerCommand('gitlens.views.scm.grouped.tags', () => this.setView('tags')),
-			registerCommand('gitlens.views.scm.grouped.worktrees', () => this.setView('worktrees')),
+			registerCommand('gitlens.views.scm.grouped.branches', () => this.setView('branches', true)),
+			registerCommand('gitlens.views.scm.grouped.commits', () => this.setView('commits', true)),
+			registerCommand('gitlens.views.scm.grouped.contributors', () => this.setView('contributors', true)),
+			registerCommand('gitlens.views.scm.grouped.remotes', () => this.setView('remotes', true)),
+			registerCommand('gitlens.views.scm.grouped.repositories', () => this.setView('repositories', true)),
+			registerCommand('gitlens.views.scm.grouped.searchAndCompare', () => this.setView('searchAndCompare', true)),
+			registerCommand('gitlens.views.scm.grouped.stashes', () => this.setView('stashes', true)),
+			registerCommand('gitlens.views.scm.grouped.tags', () => this.setView('tags', true)),
+			registerCommand('gitlens.views.scm.grouped.worktrees', () => this.setView('worktrees', true)),
 		);
 
 		this._view = this.setView(this.views.lastSelectedScmGroupedView!);
@@ -49,7 +49,7 @@ export class ScmGroupedView implements Disposable {
 		this._view?.dispose();
 	}
 
-	setView<T extends GroupableTreeViewTypes>(type: T): TreeViewByType[T] {
+	setView<T extends GroupableTreeViewTypes>(type: T, focus?: boolean): TreeViewByType[T] {
 		if (!this.views.scmGroupedViews.has(type)) {
 			type = first(this.views.scmGroupedViews) as T;
 		}
@@ -61,7 +61,9 @@ export class ScmGroupedView implements Disposable {
 
 		this._view?.dispose();
 		this._view = this.getView(type);
-		void this._view.show({ preserveFocus: false });
+		if (focus) {
+			void this._view.show({ preserveFocus: false });
+		}
 		this.views.lastSelectedScmGroupedView = type;
 
 		return this._view as TreeViewByType[T];
diff --git a/src/views/stashesView.ts b/src/views/stashesView.ts
@@ -34,7 +34,7 @@ export class StashesRepositoryNode extends RepositoryFolderNode<StashesView, Sta
 
 export class StashesViewNode extends RepositoriesSubscribeableNode<StashesView, StashesRepositoryNode> {
 	async getChildren(): Promise<ViewNode[]> {
-		this.view.description = this.getViewDescription();
+		this.view.description = this.view.getViewDescription();
 		this.view.message = undefined;
 
 		if (this.children == null) {
@@ -69,7 +69,7 @@ export class StashesViewNode extends RepositoriesSubscribeableNode<StashesView,
 				return [];
 			}
 
-			this.view.description = this.getViewDescription(stash.commits.size);
+			this.view.description = this.view.getViewDescription(stash.commits.size);
 
 			return child.getChildren();
 		}
diff --git a/src/views/tagsView.ts b/src/views/tagsView.ts
@@ -35,7 +35,7 @@ export class TagsRepositoryNode extends RepositoryFolderNode<TagsView, TagsNode>
 
 export class TagsViewNode extends RepositoriesSubscribeableNode<TagsView, TagsRepositoryNode> {
 	async getChildren(): Promise<ViewNode[]> {
-		this.view.description = this.getViewDescription();
+		this.view.description = this.view.getViewDescription();
 		this.view.message = undefined;
 
 		if (this.children == null) {
@@ -70,7 +70,7 @@ export class TagsViewNode extends RepositoriesSubscribeableNode<TagsView, TagsRe
 				return [];
 			}
 
-			this.view.description = this.getViewDescription(tags.values.length);
+			this.view.description = this.view.getViewDescription(tags.values.length);
 
 			return child.getChildren();
 		}
diff --git a/src/views/viewBase.ts b/src/views/viewBase.ts
@@ -212,9 +212,7 @@ export abstract class ViewBase<
 		private readonly trackingFeature: TrackedUsageFeatures,
 		public readonly grouped?: boolean,
 	) {
-		if (this.grouped) {
-			this.description = this.name.toLocaleLowerCase();
-		}
+		this.description = this.getViewDescription();
 		this.disposables.push(once(container.onReady)(this.onReady, this));
 
 		if (this.container.debugging || configuration.get('debug')) {
@@ -440,6 +438,13 @@ export abstract class ViewBase<
 		return node.getTreeItem();
 	}
 
+	getViewDescription(count?: number) {
+		return (
+			`${this.grouped ? `${this.name.toLocaleLowerCase()} ` : ''}${count != null ? `(${count})` : ''}` ||
+			undefined
+		);
+	}
+
 	resolveTreeItem(item: TreeItem, node: ViewNode, token: CancellationToken): TreeItem | Promise<TreeItem> {
 		return node.resolveTreeItem?.(item, token) ?? item;
 	}
diff --git a/src/views/views.ts b/src/views/views.ts
@@ -244,20 +244,20 @@ export class Views implements Disposable {
 	private async toggleScmViewGrouping(type: GroupableTreeViewTypes, grouped: boolean) {
 		if (grouped) {
 			if (!this._scmGroupedViews.has(type)) {
-				this.lastSelectedScmGroupedView = type;
 				this._scmGroupedViews.add(type);
+				this.lastSelectedScmGroupedView = type;
 			}
 		} else if (this._scmGroupedViews.has(type)) {
+			this._scmGroupedViews.delete(type);
 			if (type === this.lastSelectedScmGroupedView) {
-				this.lastSelectedScmGroupedView = undefined;
+				this.lastSelectedScmGroupedView = first(this._scmGroupedViews);
 			}
-			this._scmGroupedViews.delete(type);
 		}
 
 		await updateScmGroupedViewsInConfig(this._scmGroupedViews);
 
 		// Show the view after the configuration change has been applied
-		setTimeout(() => executeCoreCommand(`gitlens.views.${type}.focus`), 1);
+		setTimeout(() => executeCoreCommand(`gitlens.views.${grouped ? 'scm.grouped' : type}.focus`), 1);
 	}
 
 	private updateScmGroupedViewsRegistration() {
diff --git a/src/views/worktreesView.ts b/src/views/worktreesView.ts
@@ -41,13 +41,8 @@ export class WorktreesRepositoryNode extends RepositoryFolderNode<WorktreesView,
 }
 
 export class WorktreesViewNode extends RepositoriesSubscribeableNode<WorktreesView, WorktreesRepositoryNode> {
-	protected override getViewDescription(count?: number): string {
-		const description = super.getViewDescription(count);
-		return description ? `${description} \u00a0\u2022\u00a0 ${proBadge}` : proBadge;
-	}
-
 	async getChildren(): Promise<ViewNode[]> {
-		this.view.description = this.getViewDescription();
+		this.view.description = this.view.getViewDescription();
 		this.view.message = undefined;
 
 		if (this.children == null) {
@@ -84,7 +79,7 @@ export class WorktreesViewNode extends RepositoriesSubscribeableNode<WorktreesVi
 				return [];
 			}
 
-			this.view.description = this.getViewDescription(grandChildren.length);
+			this.view.description = this.view.getViewDescription(grandChildren.length);
 
 			return grandChildren;
 		}
@@ -103,12 +98,11 @@ export class WorktreesView extends ViewBase<'worktrees', WorktreesViewNode, Work
 
 	constructor(container: Container, grouped?: boolean) {
 		super(container, 'worktrees', 'Worktrees', 'worktreesView', grouped);
+	}
 
-		if (this.grouped) {
-			this.description = `${this.name.toLocaleLowerCase()} \u00a0\u2022\u00a0 ${proBadge}`;
-		} else {
-			this.description = proBadge;
-		}
+	override getViewDescription(count?: number): string {
+		const description = super.getViewDescription(count);
+		return description ? `${description} \u00a0\u2022\u00a0 ${proBadge}` : proBadge;
 	}
 
 	override get canReveal(): boolean {

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ export class BranchesRepositoryNode extends RepositoryFolderNode<BranchesView, B`
`48`	`48`
`49`	`49`	`export class BranchesViewNode extends RepositoriesSubscribeableNode<BranchesView, BranchesRepositoryNode> {`
`50`	`50`	`async getChildren(): Promise<ViewNode[]> {`
`51`		`- this.view.description = this.getViewDescription();`
	`51`	`+ this.view.description = this.view.getViewDescription();`
`52`	`52`	`this.view.message = undefined;`
`53`	`53`
`54`	`54`	`if (this.children == null) {`
`@@ -91,7 +91,7 @@ export class BranchesViewNode extends RepositoriesSubscribeableNode<BranchesView`
`91`	`91`	`return [];`
`92`	`92`	`}`
`93`	`93`
`94`		`- this.view.description = this.getViewDescription(branches.values.length);`
	`94`	`+ this.view.description = this.view.getViewDescription(branches.values.length);`
`95`	`95`
`96`	`96`	`return child.getChildren();`
`97`	`97`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ export class ContributorsRepositoryNode extends RepositoryFolderNode<Contributor`
`53`	`53`
`54`	`54`	`export class ContributorsViewNode extends RepositoriesSubscribeableNode<ContributorsView, ContributorsRepositoryNode> {`
`55`	`55`	`async getChildren(): Promise<ViewNode[]> {`
`56`		`- this.view.description = this.getViewDescription();`
	`56`	`+ this.view.description = this.view.getViewDescription();`
`57`	`57`	`this.view.message = undefined;`
`58`	`58`
`59`	`59`	`if (this.children == null) {`
`@@ -106,7 +106,7 @@ export class ContributorsViewNode extends RepositoriesSubscribeableNode<Contribu`
`106`	`106`	`return [];`
`107`	`107`	`}`
`108`	`108`
`109`		`- this.view.description = this.getViewDescription(children.length);`
	`109`	`+ this.view.description = this.view.getViewDescription(children.length);`
`110`	`110`
`111`	`111`	`return children;`
`112`	`112`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ export class RemotesRepositoryNode extends RepositoryFolderNode<RemotesView, Rem`
`48`	`48`
`49`	`49`	`export class RemotesViewNode extends RepositoriesSubscribeableNode<RemotesView, RemotesRepositoryNode> {`
`50`	`50`	`async getChildren(): Promise<ViewNode[]> {`
`51`		`- this.view.description = this.getViewDescription();`
	`51`	`+ this.view.description = this.view.getViewDescription();`
`52`	`52`	`this.view.message = undefined;`
`53`	`53`
`54`	`54`	`if (this.children == null) {`
`@@ -83,7 +83,7 @@ export class RemotesViewNode extends RepositoriesSubscribeableNode<RemotesView,`
`83`	`83`	`return [];`
`84`	`84`	`}`
`85`	`85`
`86`		`- this.view.description = this.getViewDescription(remotes.length);`
	`86`	`+ this.view.description = this.view.getViewDescription(remotes.length);`
`87`	`87`
`88`	`88`	`return child.getChildren();`
`89`	`89`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ export class StashesRepositoryNode extends RepositoryFolderNode<StashesView, Sta`
`34`	`34`
`35`	`35`	`export class StashesViewNode extends RepositoriesSubscribeableNode<StashesView, StashesRepositoryNode> {`
`36`	`36`	`async getChildren(): Promise<ViewNode[]> {`
`37`		`- this.view.description = this.getViewDescription();`
	`37`	`+ this.view.description = this.view.getViewDescription();`
`38`	`38`	`this.view.message = undefined;`
`39`	`39`
`40`	`40`	`if (this.children == null) {`
`@@ -69,7 +69,7 @@ export class StashesViewNode extends RepositoriesSubscribeableNode<StashesView,`
`69`	`69`	`return [];`
`70`	`70`	`}`
`71`	`71`
`72`		`- this.view.description = this.getViewDescription(stash.commits.size);`
	`72`	`+ this.view.description = this.view.getViewDescription(stash.commits.size);`
`73`	`73`
`74`	`74`	`return child.getChildren();`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ export class TagsRepositoryNode extends RepositoryFolderNode<TagsView, TagsNode>`
`35`	`35`
`36`	`36`	`export class TagsViewNode extends RepositoriesSubscribeableNode<TagsView, TagsRepositoryNode> {`
`37`	`37`	`async getChildren(): Promise<ViewNode[]> {`
`38`		`- this.view.description = this.getViewDescription();`
	`38`	`+ this.view.description = this.view.getViewDescription();`
`39`	`39`	`this.view.message = undefined;`
`40`	`40`
`41`	`41`	`if (this.children == null) {`
`@@ -70,7 +70,7 @@ export class TagsViewNode extends RepositoriesSubscribeableNode<TagsView, TagsRe`
`70`	`70`	`return [];`
`71`	`71`	`}`
`72`	`72`
`73`		`- this.view.description = this.getViewDescription(tags.values.length);`
	`73`	`+ this.view.description = this.view.getViewDescription(tags.values.length);`
`74`	`74`
`75`	`75`	`return child.getChildren();`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -244,20 +244,20 @@ export class Views implements Disposable {`
`244`	`244`	`private async toggleScmViewGrouping(type: GroupableTreeViewTypes, grouped: boolean) {`
`245`	`245`	`if (grouped) {`
`246`	`246`	`if (!this._scmGroupedViews.has(type)) {`
`247`		`- this.lastSelectedScmGroupedView = type;`
`248`	`247`	`this._scmGroupedViews.add(type);`
	`248`	`+ this.lastSelectedScmGroupedView = type;`
`249`	`249`	`}`
`250`	`250`	`} else if (this._scmGroupedViews.has(type)) {`
	`251`	`+ this._scmGroupedViews.delete(type);`
`251`	`252`	`if (type === this.lastSelectedScmGroupedView) {`
`252`		`- this.lastSelectedScmGroupedView = undefined;`
	`253`	`+ this.lastSelectedScmGroupedView = first(this._scmGroupedViews);`
`253`	`254`	`}`
`254`		`- this._scmGroupedViews.delete(type);`
`255`	`255`	`}`
`256`	`256`
`257`	`257`	`await updateScmGroupedViewsInConfig(this._scmGroupedViews);`
`258`	`258`
`259`	`259`	`// Show the view after the configuration change has been applied`
`260`		- setTimeout(() => executeCoreCommand(`gitlens.views.${type}.focus`), 1);
	`260`	+ setTimeout(() => executeCoreCommand(`gitlens.views.${grouped ? 'scm.grouped' : type}.focus`), 1);
`261`	`261`	`}`
`262`	`262`
`263`	`263`	`private updateScmGroupedViewsRegistration() {`