Adds ViewFileNode base for consolidation

eamodio · eamodio · commit b41804fb5527 · 2022-09-05T17:39:33.000-04:00
Avoids dangerous `any` cast when setting FileNode parent in FolderNode
diff --git a/src/views/nodes/UncommittedFileNode.ts b/src/views/nodes/UncommittedFileNode.ts
@@ -8,17 +8,12 @@ import { GitFile } from '../../git/models/file';
 import { dirname, joinPaths } from '../../system/path';
 import type { ViewsWithCommits } from '../viewBase';
 import type { FileNode } from './folderNode';
-import { ContextValues, ViewNode } from './viewNode';
-
-export class UncommittedFileNode extends ViewNode<ViewsWithCommits> implements FileNode {
-	public readonly file: GitFile;
-	public readonly repoPath: string;
+import type { ViewNode } from './viewNode';
+import { ContextValues, ViewFileNode } from './viewNode';
 
+export class UncommittedFileNode extends ViewFileNode<ViewsWithCommits> implements FileNode {
 	constructor(view: ViewsWithCommits, parent: ViewNode, repoPath: string, file: GitFile) {
-		super(GitUri.fromFile(file, repoPath), view, parent);
-
-		this.repoPath = repoPath;
-		this.file = file;
+		super(GitUri.fromFile(file, repoPath), view, parent, file);
 	}
 
 	override toClipboard(): string {
diff --git a/src/views/nodes/branchTrackingStatusFilesNode.ts b/src/views/nodes/branchTrackingStatusFilesNode.ts
@@ -86,8 +86,8 @@ export class BranchTrackingStatusFilesNode extends ViewNode<ViewsWithCommits> {
 				new StatusFileNode(
 					this.view,
 					this,
-					this.repoPath,
 					files[files.length - 1],
+					this.repoPath,
 					files.map(s => s.commit),
 					this.direction,
 				),
diff --git a/src/views/nodes/commitFileNode.ts b/src/views/nodes/commitFileNode.ts
@@ -18,15 +18,15 @@ export class CommitFileNode<TView extends View = ViewsWithCommits | FileHistoryV
 	constructor(
 		view: TView,
 		parent: ViewNode,
-		public readonly file: GitFile,
+		file: GitFile,
 		public commit: GitCommit,
 		private readonly _options: {
 			branch?: GitBranch;
 			selection?: Selection;
 			unpublished?: boolean;
 		} = {},
 	) {
-		super(GitUri.fromFile(file, commit.repoPath, commit.sha), view, parent);
+		super(GitUri.fromFile(file, commit.repoPath, commit.sha), view, parent, file);
 	}
 
 	override toClipboard(): string {
diff --git a/src/views/nodes/fileRevisionAsCommitNode.ts b/src/views/nodes/fileRevisionAsCommitNode.ts
@@ -24,7 +24,7 @@ export class FileRevisionAsCommitNode extends ViewRefFileNode<ViewsWithCommits |
 	constructor(
 		view: ViewsWithCommits | FileHistoryView | LineHistoryView,
 		parent: ViewNode,
-		public readonly file: GitFile,
+		file: GitFile,
 		public commit: GitCommit,
 		private readonly _options: {
 			branch?: GitBranch;
@@ -33,7 +33,7 @@ export class FileRevisionAsCommitNode extends ViewRefFileNode<ViewsWithCommits |
 			unpublished?: boolean;
 		} = {},
 	) {
-		super(GitUri.fromFile(file, commit.repoPath, commit.sha), view, parent);
+		super(GitUri.fromFile(file, commit.repoPath, commit.sha), view, parent, file);
 	}
 
 	override toClipboard(): string {
diff --git a/src/views/nodes/folderNode.ts b/src/views/nodes/folderNode.ts
@@ -7,22 +7,25 @@ import { sortCompare } from '../../system/string';
 import type { FileHistoryView } from '../fileHistoryView';
 import type { StashesView } from '../stashesView';
 import type { ViewsWithCommits } from '../viewBase';
+import type { ViewFileNode } from './viewNode';
 import { ContextValues, ViewNode } from './viewNode';
 
-export interface FileNode extends ViewNode {
+export interface FileNode extends ViewFileNode {
 	folderName: string;
-	label?: string;
 	priority: number;
+
+	label?: string;
 	relativePath?: string;
-	root?: HierarchicalItem<FileNode>;
+
+	// root?: HierarchicalItem<FileNode>;
 }
 
 export class FolderNode extends ViewNode<ViewsWithCommits | FileHistoryView | StashesView> {
 	readonly priority: number = 1;
 
 	constructor(
 		view: ViewsWithCommits | FileHistoryView | StashesView,
-		parent: ViewNode,
+		protected override parent: ViewNode,
 		public readonly repoPath: string,
 		public readonly folderName: string,
 		public readonly root: HierarchicalItem<FileNode>,
@@ -56,7 +59,7 @@ export class FolderNode extends ViewNode<ViewsWithCommits | FileHistoryView | St
 					children.push(
 						new FolderNode(
 							this.view,
-							this.folderName ? this : this.parent!,
+							this.folderName ? this : this.parent,
 							this.repoPath,
 							folder.name,
 							folder,
@@ -68,7 +71,7 @@ export class FolderNode extends ViewNode<ViewsWithCommits | FileHistoryView | St
 				}
 
 				// Make sure to set the parent
-				(folder.value as any).parent = this.folderName ? this : this.parent!;
+				folder.value.parent = this.folderName ? this : this.parent;
 				folder.value.relativePath = this.root.relativePath;
 				children.push(folder.value);
 			}
diff --git a/src/views/nodes/mergeConflictFileNode.ts b/src/views/nodes/mergeConflictFileNode.ts
@@ -11,16 +11,17 @@ import type { ViewsWithCommits } from '../viewBase';
 import type { FileNode } from './folderNode';
 import { MergeConflictCurrentChangesNode } from './mergeConflictCurrentChangesNode';
 import { MergeConflictIncomingChangesNode } from './mergeConflictIncomingChangesNode';
-import { ContextValues, ViewNode } from './viewNode';
+import type { ViewNode } from './viewNode';
+import { ContextValues, ViewFileNode } from './viewNode';
 
-export class MergeConflictFileNode extends ViewNode<ViewsWithCommits> implements FileNode {
+export class MergeConflictFileNode extends ViewFileNode<ViewsWithCommits> implements FileNode {
 	constructor(
 		view: ViewsWithCommits,
 		parent: ViewNode,
+		file: GitFile,
 		public readonly status: GitMergeStatus | GitRebaseStatus,
-		public readonly file: GitFile,
 	) {
-		super(GitUri.fromFile(file, status.repoPath, status.HEAD.ref), view, parent);
+		super(GitUri.fromFile(file, status.repoPath, status.HEAD.ref), view, parent, file);
 	}
 
 	override toClipboard(): string {
@@ -35,10 +36,6 @@ export class MergeConflictFileNode extends ViewNode<ViewsWithCommits> implements
 		return this.file.path;
 	}
 
-	get repoPath(): string {
-		return this.status.repoPath;
-	}
-
 	getChildren(): ViewNode[] {
 		return [
 			new MergeConflictCurrentChangesNode(this.view, this, this.status, this.file),
diff --git a/src/views/nodes/mergeStatusNode.ts b/src/views/nodes/mergeStatusNode.ts
@@ -45,7 +45,7 @@ export class MergeStatusNode extends ViewNode<ViewsWithCommits> {
 		if (this.status?.hasConflicts !== true) return [];
 
 		let children: FileNode[] = this.status.conflicts.map(
-			f => new MergeConflictFileNode(this.view, this, this.mergeStatus, f),
+			f => new MergeConflictFileNode(this.view, this, f, this.mergeStatus),
 		);
 
 		if (this.view.config.files.layout !== ViewFilesLayout.List) {
diff --git a/src/views/nodes/rebaseStatusNode.ts b/src/views/nodes/rebaseStatusNode.ts
@@ -52,7 +52,7 @@ export class RebaseStatusNode extends ViewNode<ViewsWithCommits> {
 
 	async getChildren(): Promise<ViewNode[]> {
 		let children: FileNode[] =
-			this.status?.conflicts.map(f => new MergeConflictFileNode(this.view, this, this.rebaseStatus, f)) ?? [];
+			this.status?.conflicts.map(f => new MergeConflictFileNode(this.view, this, f, this.rebaseStatus)) ?? [];
 
 		if (this.view.config.files.layout !== ViewFilesLayout.List) {
 			const hierarchy = makeHierarchical(
diff --git a/src/views/nodes/resultsFileNode.ts b/src/views/nodes/resultsFileNode.ts
@@ -18,12 +18,12 @@ export class ResultsFileNode extends ViewRefFileNode implements FileNode {
 		view: View,
 		parent: ViewNode,
 		repoPath: string,
-		public readonly file: GitFile,
+		file: GitFile,
 		public readonly ref1: string,
 		public readonly ref2: string,
 		private readonly direction: 'ahead' | 'behind' | undefined,
 	) {
-		super(GitUri.fromFile(file, repoPath, ref1 || ref2), view, parent);
+		super(GitUri.fromFile(file, repoPath, ref1 || ref2), view, parent, file);
 	}
 
 	override toClipboard(): string {
diff --git a/src/views/nodes/resultsFilesNode.ts b/src/views/nodes/resultsFilesNode.ts
@@ -32,7 +32,7 @@ export interface FilesQueryResults {
 export class ResultsFilesNode extends ViewNode<ViewsWithCommits> {
 	constructor(
 		view: ViewsWithCommits,
-		protected override readonly parent: ViewNode,
+		protected override parent: ViewNode,
 		public readonly repoPath: string,
 		public readonly ref1: string,
 		public readonly ref2: string,
diff --git a/src/views/nodes/statusFileNode.ts b/src/views/nodes/statusFileNode.ts
@@ -12,12 +12,11 @@ import { pluralize } from '../../system/string';
 import type { ViewsWithCommits } from '../viewBase';
 import { FileRevisionAsCommitNode } from './fileRevisionAsCommitNode';
 import type { FileNode } from './folderNode';
-import { ContextValues, ViewNode } from './viewNode';
+import type { ViewNode } from './viewNode';
+import { ContextValues, ViewFileNode } from './viewNode';
 
-export class StatusFileNode extends ViewNode<ViewsWithCommits> implements FileNode {
+export class StatusFileNode extends ViewFileNode<ViewsWithCommits> implements FileNode {
 	public readonly commits: GitCommit[];
-	public readonly file: GitFile;
-	public readonly repoPath: string;
 
 	private readonly _direction: 'ahead' | 'behind';
 	private readonly _hasStagedChanges: boolean;
@@ -26,8 +25,8 @@ export class StatusFileNode extends ViewNode<ViewsWithCommits> implements FileNo
 	constructor(
 		view: ViewsWithCommits,
 		parent: ViewNode,
-		repoPath: string,
 		file: GitFile,
+		repoPath: string,
 		commits: GitCommit[],
 		direction: 'ahead' | 'behind' = 'ahead',
 	) {
@@ -55,10 +54,8 @@ export class StatusFileNode extends ViewNode<ViewsWithCommits> implements FileNo
 			}
 		}
 
-		super(GitUri.fromFile(file, repoPath, ref), view, parent);
+		super(GitUri.fromFile(file, repoPath, ref), view, parent, file);
 
-		this.repoPath = repoPath;
-		this.file = file;
 		this.commits = commits;
 
 		this._direction = direction;
diff --git a/src/views/nodes/statusFilesNode.ts b/src/views/nodes/statusFilesNode.ts
@@ -94,8 +94,8 @@ export class StatusFilesNode extends ViewNode<RepositoriesView | WorktreesView>
 				new StatusFileNode(
 					this.view,
 					this,
-					repoPath,
 					files[files.length - 1],
+					repoPath,
 					files.map(s => s.commit),
 				),
 		);
diff --git a/src/views/nodes/viewNode.ts b/src/views/nodes/viewNode.ts
@@ -88,7 +88,7 @@ export interface ViewNode {
 export abstract class ViewNode<TView extends View = View, State extends object = any> {
 	protected splatted = false;
 
-	constructor(uri: GitUri, public readonly view: TView, protected readonly parent?: ViewNode) {
+	constructor(uri: GitUri, public readonly view: TView, protected parent?: ViewNode) {
 		this._uri = uri;
 	}
 
@@ -100,7 +100,7 @@ export abstract class ViewNode<TView extends View = View, State extends object =
 	}
 
 	protected _uri: GitUri;
-	get uri() {
+	get uri(): GitUri {
 		return this._uri;
 	}
 
@@ -168,6 +168,23 @@ export function isViewNode(node: any): node is ViewNode {
 type StateKey<T> = keyof T;
 type StateValue<T, P extends StateKey<T>> = P extends keyof T ? T[P] : never;
 
+export abstract class ViewFileNode<TView extends View = View, State extends object = any> extends ViewNode<
+	TView,
+	State
+> {
+	constructor(uri: GitUri, view: TView, public override parent: ViewNode, public readonly file: GitFile) {
+		super(uri, view, parent);
+	}
+
+	get repoPath(): string {
+		return this.uri.repoPath!;
+	}
+
+	override toString(): string {
+		return `${super.toString()}:${this.file.path}`;
+	}
+}
+
 export abstract class ViewRefNode<
 	TView extends View = View,
 	TReference extends GitReference = GitReference,
@@ -184,12 +201,15 @@ export abstract class ViewRefNode<
 	}
 }
 
-export abstract class ViewRefFileNode<TView extends View = View, State extends object = any> extends ViewRefNode<
+export abstract class ViewRefFileNode<TView extends View = View, State extends object = any> extends ViewFileNode<
 	TView,
-	GitRevisionReference,
 	State
 > {
-	abstract get file(): GitFile;
+	constructor(uri: GitUri, view: TView, parent: ViewNode, file: GitFile) {
+		super(uri, view, parent, file);
+	}
+
+	abstract get ref(): GitRevisionReference;
 
 	override toString(): string {
 		return `${super.toString()}:${this.file.path}`;
