Enable viewing of worktrees under Repositories (microsoft#254992)

* init

* fix: correct configuration key for detecting Git worktrees

* Fixed misspelling of worktrees and populated worktree list

* exported parseGitWorktrees

* Replaced git commands with file system reader

* Removed trailing './git' from path

* Prevent errors when accessing empty worktree directory

* Enable worktree deletion

* code clean up

* Remove exposure to git extension

* labeling and minor fixes

* throw error when no worktrees created

* Error handling when getting worktrees

---------

Co-authored-by: bhavyaus <[email protected]>

Author: nguyenchristy

extensions/git/package.json

@@ -539,6 +539,12 @@
         "category": "Git",
         "enablement": "!operationInProgress"
       },
+      {
+        "command": "git.deleteWorktree",
+        "title": "%command.deleteWorktree%",
+        "category": "Git",
+        "enablement": "!operationInProgress"
+      },
       {
         "command": "git.graph.deleteTag",
         "title": "%command.graphDeleteTag%",
@@ -1289,6 +1295,10 @@
           "command": "git.deleteTag",
           "when": "config.git.enabled && !git.missing && gitOpenRepositoryCount != 0"
         },
+        {
+          "command": "git.deleteWorktree",
+          "when": "config.git.enabled && !git.missing && gitOpenRepositoryCount != 0"
+        },
         {
           "command": "git.deleteRemoteTag",
           "when": "config.git.enabled && !git.missing && gitOpenRepositoryCount != 0"
@@ -1609,6 +1619,11 @@
           "group": "2_main@7",
           "when": "scmProvider == git"
         },
+        {
+          "submenu": "git.worktrees",
+          "group": "2_main@8",
+          "when": "scmProvider == git"
+        },
         {
           "command": "git.showOutput",
           "group": "3_footer",
@@ -2538,6 +2553,12 @@
           "command": "git.deleteRemoteTag",
           "group": "tags@3"
         }
+      ],
+      "git.worktrees": [
+        {
+          "command": "git.deleteWorktree",
+          "group": "worktrees@1"
+        }
       ]
     },
     "submenus": [
@@ -2568,6 +2589,10 @@
       {
         "id": "git.tags",
         "label": "%submenu.tags%"
+      },
+      {
+        "id": "git.worktrees",
+        "label": "%submenu.worktrees%"
       }
     ],
     "configuration": {
@@ -2977,6 +3002,18 @@
           "default": 10,
           "description": "%config.detectSubmodulesLimit%"
         },
+        "git.detectWorktrees": {
+          "type": "boolean",
+          "scope": "resource",
+          "default": false,
+          "description": "%config.detectWorktrees%"
+        },
+        "git.detectWorktreesLimit": {
+          "type": "number",
+          "scope": "resource",
+          "default": 10,
+          "description": "%config.detectWorktreesLimit%"
+        },
         "git.alwaysShowStagedChangesResourceGroup": {
           "type": "boolean",
           "scope": "resource",

extensions/git/package.nls.json

@@ -75,6 +75,7 @@
 	"command.rebase": "Rebase Branch...",
 	"command.createTag": "Create Tag...",
 	"command.deleteTag": "Delete Tag...",
+	"command.deleteWorktree": "Delete Worktree...",
 	"command.deleteRemoteTag": "Delete Remote Tag...",
 	"command.fetch": "Fetch",
 	"command.fetchPrune": "Fetch (Prune)",
@@ -217,6 +218,8 @@
 	"config.inputValidationSubjectLength": "Controls the commit message subject length threshold for showing a warning. Unset it to inherit the value of `#git.inputValidationLength#`.",
 	"config.detectSubmodules": "Controls whether to automatically detect Git submodules.",
 	"config.detectSubmodulesLimit": "Controls the limit of Git submodules detected.",
+	"config.detectWorktrees": "Controls whether to automatically detect Git worktrees.",
+	"config.detectWorktreesLimit": "Controls the limit of Git worktrees detected.",
 	"config.alwaysShowStagedChangesResourceGroup": "Always show the Staged Changes resource group.",
 	"config.alwaysSignOff": "Controls the signoff flag for all commits.",
 	"config.ignoreSubmodules": "Ignore modifications to submodules in the file tree.",
@@ -301,6 +304,7 @@
 	"submenu.remotes": "Remote",
 	"submenu.stash": "Stash",
 	"submenu.tags": "Tags",
+	"submenu.worktrees": "Worktrees",
 	"colors.added": "Color for added resources.",
 	"colors.modified": "Color for modified resources.",
 	"colors.stageModified": "Color for modified resources which have been staged.",

extensions/git/src/commands.ts

@@ -9,7 +9,7 @@ import { Command, commands, Disposable, MessageOptions, Position, ProgressLocati
 import TelemetryReporter from '@vscode/extension-telemetry';
 import { uniqueNamesGenerator, adjectives, animals, colors, NumberDictionary } from '@joaomoreno/unique-names-generator';
 import { ForcePushMode, GitErrorCodes, RefType, Status, CommitOptions, RemoteSourcePublisher, Remote, Branch, Ref } from './api/git';
-import { Git, Stash } from './git';
+import { Git, Stash, Worktree } from './git';
 import { Model } from './model';
 import { GitResourceGroup, Repository, Resource, ResourceGroupType } from './repository';
 import { DiffEditorSelectionHunkToolbarContext, LineChange, applyLineChanges, getIndexDiffInformation, getModifiedRange, getWorkingTreeDiffInformation, intersectDiffWithRange, invertLineChange, toLineChanges, toLineRanges, compareLineChanges } from './staging';
@@ -57,6 +57,19 @@ class RefItemSeparator implements QuickPickItem {
 	constructor(private readonly refType: RefType) { }
 }
 
+class WorktreeItem implements QuickPickItem {
+
+	get label(): string {
+		return `$(list-tree) ${this.worktree.name}`;
+	}
+
+	get description(): string {
+		return this.worktree.path;
+	}
+
+	constructor(readonly worktree: Worktree) { }
+}
+
 class RefItem implements QuickPickItem {
 
 	get label(): string {
@@ -215,6 +228,14 @@ class RemoteTagDeleteItem extends RefItem {
 	}
 }
 
+class WorktreeDeleteItem extends WorktreeItem {
+	async run(repository: Repository): Promise<void> {
+		if (this.worktree.path) {
+			await repository.deleteWorktree(this.worktree.path);
+		}
+	}
+}
+
 class MergeItem extends BranchItem {
 
 	async run(repository: Repository): Promise<void> {
@@ -3315,6 +3336,23 @@ export class CommandCenter {
 		}
 	}
 
+	@command('git.deleteWorktree', { repository: true })
+	async deleteWorktree(repository: Repository): Promise<void> {
+		const worktreePicks = async (): Promise<WorktreeDeleteItem[] | QuickPickItem[]> => {
+			const worktrees = await repository.getWorktrees();
+			return worktrees.length === 0
+				? [{ label: l10n.t('$(info) This repository has no worktrees.') }]
+				: worktrees.map(worktree => new WorktreeDeleteItem(worktree));
+		};
+
+		const placeHolder = l10n.t('Select a worktree to delete');
+		const choice = await this.pickRef<WorktreeDeleteItem | QuickPickItem>(worktreePicks(), placeHolder);
+
+		if (choice instanceof WorktreeDeleteItem) {
+			await choice.run(repository);
+		}
+	}
+
 	@command('git.graph.deleteTag', { repository: true })
 	async deleteTag2(repository: Repository, historyItem?: SourceControlHistoryItem, historyItemRefId?: string): Promise<void> {
 		const historyItemRef = historyItem?.references?.find(r => r.id === historyItemRefId);

extensions/git/src/git.ts

@@ -860,6 +860,11 @@ export class GitStatusParser {
 	}
 }
 
+export interface Worktree {
+	readonly name: string;
+	readonly path: string;
+}
+
 export interface Submodule {
 	name: string;
 	path: string;
@@ -2028,6 +2033,11 @@ export class Repository {
 		await this.exec(args);
 	}
 
+	async deleteWorktree(path: string): Promise<void> {
+		const args = ['worktree', 'remove', path];
+		await this.exec(args);
+	}
+
 	async deleteRemoteRef(remoteName: string, refName: string, options?: { force?: boolean }): Promise<void> {
 		const args = ['push', remoteName, '--delete'];
 
@@ -2740,6 +2750,50 @@ export class Repository {
 		return parseGitStashes(result.stdout.trim());
 	}
 
+	async getWorktrees(): Promise<Worktree[]> {
+		return await this.getWorktreesFS();
+	}
+
+	private async getWorktreesFS(): Promise<Worktree[]> {
+		const worktreesPath = path.join(this.repositoryRoot, '.git', 'worktrees');
+
+		try {
+			// List all worktree folder names
+			const dirents = await fs.readdir(worktreesPath, { withFileTypes: true });
+			const result: Worktree[] = [];
+
+			for (const dirent of dirents) {
+				if (!dirent.isDirectory()) {
+					continue;
+				}
+
+				const gitdirPath = path.join(worktreesPath, dirent.name, 'gitdir');
+
+				try {
+					const gitdirContent = (await fs.readFile(gitdirPath, 'utf8')).trim();
+					// Remove trailing '/.git'
+					const gitdirTrimmed = gitdirContent.replace(/\.git.*$/, '');
+					result.push({ name: dirent.name, path: gitdirTrimmed });
+				} catch (err) {
+					if (/ENOENT/.test(err.message)) {
+						continue;
+					}
+
+					throw err;
+				}
+			}
+
+			return result;
+		}
+		catch (err) {
+			if (/ENOENT/.test(err.message)) {
+				return [];
+			}
+
+			throw err;
+		}
+	}
+
 	async getRemotes(): Promise<Remote[]> {
 		const remotes: MutableRemote[] = [];
 

extensions/git/src/model.ts

@@ -724,6 +724,14 @@ export class Model implements IRepositoryResolver, IBranchProtectionProviderRegi
 			.getConfiguration('git', Uri.file(repository.root))
 			.get<number>('detectSubmodulesLimit') as number;
 
+		const shouldDetectWorktrees = workspace
+			.getConfiguration('git', Uri.file(repository.root))
+			.get<boolean>('detectWorktrees') as boolean;
+
+		const worktreesLimit = workspace
+			.getConfiguration('git', Uri.file(repository.root))
+			.get<number>('detectWorktreesLimit') as number;
+
 		const checkForSubmodules = () => {
 			if (!shouldDetectSubmodules) {
 				this.logger.trace('[Model][open] Automatic detection of git submodules is not enabled.');
@@ -744,6 +752,25 @@ export class Model implements IRepositoryResolver, IBranchProtectionProviderRegi
 				});
 		};
 
+		const checkForWorktrees = () => {
+			if (!shouldDetectWorktrees) {
+				this.logger.trace('[Model][open] Automatic detection of git worktrees is not enabled.');
+				return;
+			}
+
+			if (repository.worktrees.length > worktreesLimit) {
+				window.showWarningMessage(l10n.t('The "{0}" repository has {1} worktrees which won\'t be opened automatically. You can still open each one individually by opening a file within.', path.basename(repository.root), repository.worktrees.length));
+				statusListener.dispose();
+			}
+
+			repository.worktrees
+				.slice(0, worktreesLimit)
+				.forEach(w => {
+					this.logger.trace(`[Model][open] Opening worktree: '${w.path}'`);
+					this.eventuallyScanPossibleGitRepository(w.path);
+				});
+		};
+
 		const updateMergeChanges = () => {
 			// set mergeChanges context
 			const mergeChanges: Uri[] = [];
@@ -757,10 +784,12 @@ export class Model implements IRepositoryResolver, IBranchProtectionProviderRegi
 
 		const statusListener = repository.onDidRunGitStatus(() => {
 			checkForSubmodules();
+			checkForWorktrees();
 			updateMergeChanges();
 			this.onDidChangeActiveTextEditor();
 		});
 		checkForSubmodules();
+		checkForWorktrees();
 		this.onDidChangeActiveTextEditor();
 
 		const updateOperationInProgressContext = () => {

extensions/git/src/operation.ts

@@ -22,6 +22,7 @@ export const enum OperationKind {
 	DeleteRef = 'DeleteRef',
 	DeleteRemoteRef = 'DeleteRemoteRef',
 	DeleteTag = 'DeleteTag',
+	DeleteWorktree = 'DeleteWorktree',
 	Diff = 'Diff',
 	Fetch = 'Fetch',
 	FindTrackingBranches = 'GetTracking',
@@ -31,6 +32,7 @@ export const enum OperationKind {
 	GetObjectDetails = 'GetObjectDetails',
 	GetObjectFiles = 'GetObjectFiles',
 	GetRefs = 'GetRefs',
+	GetWorktrees = 'GetWorktrees',
 	GetRemoteRefs = 'GetRemoteRefs',
 	HashObject = 'HashObject',
 	Ignore = 'Ignore',
@@ -66,8 +68,8 @@ export const enum OperationKind {
 
 export type Operation = AddOperation | ApplyOperation | BlameOperation | BranchOperation | CheckIgnoreOperation | CherryPickOperation |
 	CheckoutOperation | CheckoutTrackingOperation | CleanOperation | CommitOperation | ConfigOperation | DeleteBranchOperation |
-	DeleteRefOperation | DeleteRemoteRefOperation | DeleteTagOperation | DiffOperation | FetchOperation | FindTrackingBranchesOperation |
-	GetBranchOperation | GetBranchesOperation | GetCommitTemplateOperation | GetObjectDetailsOperation | GetObjectFilesOperation | GetRefsOperation |
+	DeleteRefOperation | DeleteRemoteRefOperation | DeleteTagOperation | DeleteWorktreeOperation | DiffOperation | FetchOperation | FindTrackingBranchesOperation |
+	GetBranchOperation | GetBranchesOperation | GetCommitTemplateOperation | GetObjectDetailsOperation | GetObjectFilesOperation | GetRefsOperation | GetWorktreesOperation |
 	GetRemoteRefsOperation | HashObjectOperation | IgnoreOperation | LogOperation | LogFileOperation | MergeOperation | MergeAbortOperation |
 	MergeBaseOperation | MoveOperation | PostCommitCommandOperation | PullOperation | PushOperation | RemoteOperation | RenameBranchOperation |
 	RemoveOperation | ResetOperation | RebaseOperation | RebaseAbortOperation | RebaseContinueOperation | RefreshOperation | RevertFilesOperation |
@@ -90,6 +92,7 @@ export type DeleteBranchOperation = BaseOperation & { kind: OperationKind.Delete
 export type DeleteRefOperation = BaseOperation & { kind: OperationKind.DeleteRef };
 export type DeleteRemoteRefOperation = BaseOperation & { kind: OperationKind.DeleteRemoteRef };
 export type DeleteTagOperation = BaseOperation & { kind: OperationKind.DeleteTag };
+export type DeleteWorktreeOperation = BaseOperation & { kind: OperationKind.DeleteWorktree };
 export type DiffOperation = BaseOperation & { kind: OperationKind.Diff };
 export type FetchOperation = BaseOperation & { kind: OperationKind.Fetch };
 export type FindTrackingBranchesOperation = BaseOperation & { kind: OperationKind.FindTrackingBranches };
@@ -99,6 +102,7 @@ export type GetCommitTemplateOperation = BaseOperation & { kind: OperationKind.G
 export type GetObjectDetailsOperation = BaseOperation & { kind: OperationKind.GetObjectDetails };
 export type GetObjectFilesOperation = BaseOperation & { kind: OperationKind.GetObjectFiles };
 export type GetRefsOperation = BaseOperation & { kind: OperationKind.GetRefs };
+export type GetWorktreesOperation = BaseOperation & { kind: OperationKind.GetWorktrees };
 export type GetRemoteRefsOperation = BaseOperation & { kind: OperationKind.GetRemoteRefs };
 export type HashObjectOperation = BaseOperation & { kind: OperationKind.HashObject };
 export type IgnoreOperation = BaseOperation & { kind: OperationKind.Ignore };
@@ -147,6 +151,7 @@ export const Operation = {
 	DeleteRef: { kind: OperationKind.DeleteRef, blocking: false, readOnly: false, remote: false, retry: false, showProgress: true } as DeleteRefOperation,
 	DeleteRemoteRef: { kind: OperationKind.DeleteRemoteRef, blocking: false, readOnly: false, remote: true, retry: false, showProgress: true } as DeleteRemoteRefOperation,
 	DeleteTag: { kind: OperationKind.DeleteTag, blocking: false, readOnly: false, remote: false, retry: false, showProgress: true } as DeleteTagOperation,
+	DeleteWorktree: { kind: OperationKind.DeleteWorktree, blocking: false, readOnly: false, remote: false, retry: false, showProgress: true } as DeleteWorktreeOperation,
 	Diff: { kind: OperationKind.Diff, blocking: false, readOnly: true, remote: false, retry: false, showProgress: false } as DiffOperation,
 	Fetch: (showProgress: boolean) => ({ kind: OperationKind.Fetch, blocking: false, readOnly: false, remote: true, retry: true, showProgress } as FetchOperation),
 	FindTrackingBranches: { kind: OperationKind.FindTrackingBranches, blocking: false, readOnly: true, remote: false, retry: false, showProgress: true } as FindTrackingBranchesOperation,
@@ -156,6 +161,7 @@ export const Operation = {
 	GetObjectDetails: { kind: OperationKind.GetObjectDetails, blocking: false, readOnly: true, remote: false, retry: false, showProgress: false } as GetObjectDetailsOperation,
 	GetObjectFiles: { kind: OperationKind.GetObjectFiles, blocking: false, readOnly: true, remote: false, retry: false, showProgress: false } as GetObjectFilesOperation,
 	GetRefs: { kind: OperationKind.GetRefs, blocking: false, readOnly: true, remote: false, retry: false, showProgress: false } as GetRefsOperation,
+	GetWorktrees: { kind: OperationKind.GetWorktrees, blocking: false, readOnly: true, remote: false, retry: false, showProgress: false } as GetWorktreesOperation,
 	GetRemoteRefs: { kind: OperationKind.GetRemoteRefs, blocking: false, readOnly: true, remote: true, retry: false, showProgress: false } as GetRemoteRefsOperation,
 	HashObject: { kind: OperationKind.HashObject, blocking: false, readOnly: false, remote: false, retry: false, showProgress: true } as HashObjectOperation,
 	Ignore: { kind: OperationKind.Ignore, blocking: false, readOnly: false, remote: false, retry: false, showProgress: true } as IgnoreOperation,