Adds type discriminator to ViewNode

Author: eamodio

src/constants.ts

@@ -509,6 +509,63 @@ export const viewIdsByDefaultContainerId = new Map<ViewContainerIds | CoreViewCo
 	['workbench.view.extension.gitlens', ['home', 'workspaces', 'account']],
 ]);
 
+export type TreeViewRefNodeTypes = 'branch' | 'commit' | 'stash' | 'tag';
+export type TreeViewRefFileNodeTypes = 'commit-file' | 'file-commit' | 'results-file' | 'stash-file';
+export type TreeViewFileNodeTypes =
+	| TreeViewRefFileNodeTypes
+	| 'conflict-file'
+	| 'folder'
+	| 'status-file'
+	| 'uncommitted-file';
+export type TreeViewSubscribableNodeTypes =
+	| 'compare-branch'
+	| 'compare-results'
+	| 'file-history'
+	| 'file-history-tracker'
+	| 'line-history'
+	| 'line-history-tracker'
+	| 'repositories'
+	| 'repository'
+	| 'repository-folder'
+	| 'search-results'
+	| 'workspace';
+export type TreeViewNodeTypes =
+	| TreeViewRefNodeTypes
+	| TreeViewFileNodeTypes
+	| TreeViewSubscribableNodeTypes
+	| 'autolink'
+	| 'autolinks'
+	| 'branch-tag-folder'
+	| 'branches'
+	| 'compare-picker'
+	| 'contributor'
+	| 'contributors'
+	| 'conflict-files'
+	| 'conflict-current-changes'
+	| 'conflict-incoming-changes'
+	| 'merge-status'
+	| 'message'
+	| 'pager'
+	| 'pullrequest'
+	| 'rebase-status'
+	| 'reflog'
+	| 'reflog-record'
+	| 'remote'
+	| 'remotes'
+	| 'results-commits'
+	| 'results-files'
+	| 'search-compare'
+	| 'stashes'
+	| 'status-files'
+	| 'tags'
+	| 'tracking-status'
+	| 'tracking-status-files'
+	| 'uncommitted-files'
+	| 'workspace-missing-repository'
+	| 'workspaces-view'
+	| 'worktree'
+	| 'worktrees';
+
 export type ContextKeys =
 	| `${typeof extensionPrefix}:action:${string}`
 	| `${typeof extensionPrefix}:key:${Keys}`

src/views/nodes/UncommittedFileNode.ts

@@ -12,9 +12,9 @@ import type { FileNode } from './folderNode';
 import type { ViewNode } from './viewNode';
 import { ContextValues, ViewFileNode } from './viewNode';
 
-export class UncommittedFileNode extends ViewFileNode<ViewsWithCommits> implements FileNode {
+export class UncommittedFileNode extends ViewFileNode<'uncommitted-file', ViewsWithCommits> implements FileNode {
 	constructor(view: ViewsWithCommits, parent: ViewNode, repoPath: string, file: GitFile) {
-		super(GitUri.fromFile(file, repoPath), view, parent, file);
+		super('uncommitted-file', GitUri.fromFile(file, repoPath), view, parent, file);
 	}
 
 	override toClipboard(): string {

src/views/nodes/UncommittedFilesNode.ts

@@ -12,7 +12,7 @@ import { FolderNode } from './folderNode';
 import { UncommittedFileNode } from './UncommittedFileNode';
 import { ContextValues, getViewNodeId, ViewNode } from './viewNode';
 
-export class UncommittedFilesNode extends ViewNode<ViewsWithWorkingTree> {
+export class UncommittedFilesNode extends ViewNode<'uncommitted-files', ViewsWithWorkingTree> {
 	constructor(
 		view: ViewsWithWorkingTree,
 		protected override readonly parent: ViewNode,
@@ -26,9 +26,9 @@ export class UncommittedFilesNode extends ViewNode<ViewsWithWorkingTree> {
 			  },
 		public readonly range: string | undefined,
 	) {
-		super(GitUri.fromRepoPath(status.repoPath), view, parent);
+		super('uncommitted-files', GitUri.fromRepoPath(status.repoPath), view, parent);
 
-		this._uniqueId = getViewNodeId('uncommitted-files', this.context);
+		this._uniqueId = getViewNodeId(this.type, this.context);
 	}
 
 	override get id(): string {

src/views/nodes/autolinkedItemNode.ts

@@ -8,17 +8,17 @@ import { isPromise } from '../../system/promise';
 import type { ViewsWithCommits } from '../viewBase';
 import { ContextValues, getViewNodeId, ViewNode } from './viewNode';
 
-export class AutolinkedItemNode extends ViewNode<ViewsWithCommits> {
+export class AutolinkedItemNode extends ViewNode<'autolink', ViewsWithCommits> {
 	constructor(
 		view: ViewsWithCommits,
 		protected override readonly parent: ViewNode,
 		public readonly repoPath: string,
 		public readonly item: Autolink,
 		private enrichedItem: Promise<IssueOrPullRequest | undefined> | IssueOrPullRequest | undefined,
 	) {
-		super(GitUri.fromRepoPath(repoPath), view, parent);
+		super('autolink', GitUri.fromRepoPath(repoPath), view, parent);
 
-		this._uniqueId = getViewNodeId(`autolink+${item.id}`, this.context);
+		this._uniqueId = getViewNodeId(`${this.type}+${item.id}`, this.context);
 	}
 
 	override get id(): string {

src/views/nodes/autolinkedItemsNode.ts

@@ -14,7 +14,7 @@ import { ContextValues, getViewNodeId, ViewNode } from './viewNode';
 
 let instanceId = 0;
 
-export class AutolinkedItemsNode extends ViewNode<ViewsWithCommits> {
+export class AutolinkedItemsNode extends ViewNode<'autolinks', ViewsWithCommits> {
 	private _instanceId: number;
 
 	constructor(
@@ -24,11 +24,11 @@ export class AutolinkedItemsNode extends ViewNode<ViewsWithCommits> {
 		public readonly log: GitLog,
 		private expand: boolean,
 	) {
-		super(GitUri.fromRepoPath(repoPath), view, parent);
+		super('autolinks', GitUri.fromRepoPath(repoPath), view, parent);
 
 		this._instanceId = instanceId++;
 		this.updateContext({ autolinksId: String(this._instanceId) });
-		this._uniqueId = getViewNodeId('autolinks', this.context);
+		this._uniqueId = getViewNodeId(this.type, this.context);
 	}
 
 	override get id(): string {

src/views/nodes/branchNode.ts

@@ -34,7 +34,10 @@ type State = {
 	pendingPullRequest: Promise<PullRequest | undefined> | undefined;
 };
 
-export class BranchNode extends ViewRefNode<ViewsWithBranches, GitBranchReference, State> implements PageableViewNode {
+export class BranchNode
+	extends ViewRefNode<'branch', ViewsWithBranches, GitBranchReference, State>
+	implements PageableViewNode
+{
 	limit: number | undefined;
 
 	private readonly options: {
@@ -68,10 +71,10 @@ export class BranchNode extends ViewRefNode<ViewsWithBranches, GitBranchReferenc
 			authors?: GitUser[];
 		},
 	) {
-		super(uri, view, parent);
+		super('branch', uri, view, parent);
 
 		this.updateContext({ repository: repo, branch: branch, root: root });
-		this._uniqueId = getViewNodeId('branch', this.context);
+		this._uniqueId = getViewNodeId(this.type, this.context);
 		this.limit = this.view.getNodeLastKnownLimit(this);
 
 		this.options = {

src/views/nodes/branchOrTagFolderNode.ts

@@ -2,24 +2,24 @@ import { ThemeIcon, TreeItem, TreeItemCollapsibleState } from 'vscode';
 import { GitUri } from '../../git/gitUri';
 import type { HierarchicalItem } from '../../system/array';
 import type { View } from '../viewBase';
-import { BranchNode } from './branchNode';
+import type { BranchNode } from './branchNode';
 import type { TagNode } from './tagNode';
 import { ContextValues, getViewNodeId, ViewNode } from './viewNode';
 
-export class BranchOrTagFolderNode extends ViewNode {
+export class BranchOrTagFolderNode extends ViewNode<'branch-tag-folder'> {
 	constructor(
 		view: View,
 		protected override readonly parent: ViewNode,
-		public readonly type: 'branch' | 'remote-branch' | 'tag',
+		public readonly folderType: 'branch' | 'remote-branch' | 'tag',
 		public readonly root: HierarchicalItem<BranchNode | TagNode>,
 		public readonly repoPath: string,
 		public readonly folderName: string,
 		public readonly relativePath: string | undefined,
 		private readonly _expanded: boolean = false,
 	) {
-		super(GitUri.fromRepoPath(repoPath), view, parent);
+		super('branch-tag-folder', GitUri.fromRepoPath(repoPath), view, parent);
 
-		this._uniqueId = getViewNodeId(`${type}-folder+${relativePath ?? folderName}`, this.context);
+		this._uniqueId = getViewNodeId(`${this.type}+${folderType}+${relativePath ?? folderName}`, this.context);
 	}
 
 	override get id(): string {
@@ -38,12 +38,12 @@ export class BranchOrTagFolderNode extends ViewNode {
 		for (const folder of this.root.children.values()) {
 			if (folder.value === undefined) {
 				// If the folder contains the current branch, expand it by default
-				const expanded = folder.descendants?.some(n => n instanceof BranchNode && n.current);
+				const expanded = folder.descendants?.some(n => n.is('branch') && n.current);
 				children.push(
 					new BranchOrTagFolderNode(
 						this.view,
 						this.folderName ? this : this.parent,
-						this.type,
+						this.folderType,
 						folder,
 						this.repoPath,
 						folder.name,

src/views/nodes/branchTrackingStatusFilesNode.ts

@@ -14,18 +14,18 @@ import { FolderNode } from './folderNode';
 import { StatusFileNode } from './statusFileNode';
 import { ContextValues, getViewNodeId, ViewNode } from './viewNode';
 
-export class BranchTrackingStatusFilesNode extends ViewNode<ViewsWithCommits> {
+export class BranchTrackingStatusFilesNode extends ViewNode<'tracking-status-files', ViewsWithCommits> {
 	constructor(
 		view: ViewsWithCommits,
 		protected override readonly parent: ViewNode,
 		public readonly branch: GitBranch,
 		public readonly status: Required<BranchTrackingStatus>,
 		public readonly direction: 'ahead' | 'behind',
 	) {
-		super(GitUri.fromRepoPath(status.repoPath), view, parent);
+		super('tracking-status-files', GitUri.fromRepoPath(status.repoPath), view, parent);
 
 		this.updateContext({ branch: branch, branchStatus: status, branchStatusUpstreamType: direction });
-		this._uniqueId = getViewNodeId('tracking-status-files', this.context);
+		this._uniqueId = getViewNodeId(this.type, this.context);
 	}
 
 	get repoPath(): string {

src/views/nodes/branchTrackingStatusNode.ts

@@ -26,7 +26,10 @@ export interface BranchTrackingStatus {
 	upstream?: string;
 }
 
-export class BranchTrackingStatusNode extends ViewNode<ViewsWithCommits> implements PageableViewNode {
+export class BranchTrackingStatusNode
+	extends ViewNode<'tracking-status', ViewsWithCommits>
+	implements PageableViewNode
+{
 	limit: number | undefined;
 
 	constructor(
@@ -41,15 +44,15 @@ export class BranchTrackingStatusNode extends ViewNode<ViewsWithCommits> impleme
 			showAheadCommits?: boolean;
 		},
 	) {
-		super(GitUri.fromRepoPath(status.repoPath), view, parent);
+		super('tracking-status', GitUri.fromRepoPath(status.repoPath), view, parent);
 
 		this.updateContext({
 			branch: branch,
 			branchStatus: status,
 			branchStatusUpstreamType: upstreamType,
 			root: root,
 		});
-		this._uniqueId = getViewNodeId('tracking-status', this.context);
+		this._uniqueId = getViewNodeId(this.type, this.context);
 		this.limit = this.view.getNodeLastKnownLimit(this);
 	}
 

src/views/nodes/branchesNode.ts

@@ -10,17 +10,17 @@ import { BranchOrTagFolderNode } from './branchOrTagFolderNode';
 import { MessageNode } from './common';
 import { ContextValues, getViewNodeId, ViewNode } from './viewNode';
 
-export class BranchesNode extends ViewNode<ViewsWithBranchesNode> {
+export class BranchesNode extends ViewNode<'branches', ViewsWithBranchesNode> {
 	constructor(
 		uri: GitUri,
 		view: ViewsWithBranchesNode,
 		protected override readonly parent: ViewNode,
 		public readonly repo: Repository,
 	) {
-		super(uri, view, parent);
+		super('branches', uri, view, parent);
 
 		this.updateContext({ repository: repo });
-		this._uniqueId = getViewNodeId('branches', this.context);
+		this._uniqueId = getViewNodeId(this.type, this.context);
 	}
 
 	override get id(): string {