Fixes #3090 and #2575 - Treats .git/gitdir as cwd on "empty" bare clones

[hwangh95]

Description

There are cases for having bare clones with multiple worktrees in the same folder to manage various versions in a workspace

Currently, however, the only supported way to do this is to have the .git/ files such as HEAD, branches/, refs/, worktrees/, etc in the same folder as your actual worktrees. This makes your workspace very cluttered and is counterproductive to the structured way of multiple worktrees

What many of us prefer is to have an "empty" bare clone with the normal bare clone files within the .git/ folder or another folder labeled .bare and use a .git file with a gitdir reference

This fix will allow for the worktrees view to function the same way it would show on a git worktree list command

Checklist

• I have followed the guidelines in the Contributing document
• My changes follow the coding style of this project
• My changes build without any errors or warnings
• My changes have been formatted and linted
• My changes include any required corresponding changes to the documentation (including CHANGELOG.md and README.md)
• My changes have been rebased and squashed to the minimal number (typically 1) of relevant commits
• My changes have a descriptive commit message with a short title, including a Fixes $XXX - or Closes #XXX - prefix to auto-close the issue that your PR addresses

Refs: #3090, #2575

[hwangh95]

@eamodio Hello, could you please have a look at this PR?

[hwangh95]

@d13 Hey sorry for the ping but could you look at this PR? Or is there someone else who can? I've been waiting for feedback for about a month now

[hwangh95]

@d13 Still waiting for feedback on this

[hwangh95]

@axosoft-ramint Sorry for the ping, but could I get you to look into this? I've been manually compiling the source every version to fix this issue...

[axosoft-ramint]

@hwangh95 Thanks! It may be a while before I get to this, but it's on my list now.

[hwangh95]

@axosoft-ramint Are there any updates on this?

[eamodio]

Thank you for the PR and sorry for the LONG delay here. Please test things out with the following suggestions and if it works, we should be able to get this in ASAP.

[eamodio]

Nit: please split into 2 "Fixes" lines

[eamodio]

Please replace this with the following (assuming it works in your testing). In my testing this seems to resolve the issue and takes advantage of the path normalization that rev_parse__git_dir is already doing. It also avoids returning the cwd if rev_parse__git_dir really returns no data (which shouldn't happen), but keeps this safer.

Suggested change

	// We can assume rev_parse__git_dir will always return a value since we know we are in a repo
	({ commonPath: data } = (await this.rev_parse__git_dir(cwd)) as {
	path: string;
	commonPath?: string;
	});
	// If the git dir is .git or a path pointed to by gitdir: ...,
	// we should treat it as an "empty" version of a bare clone
	// This is the case when git dir == git common dir, or when commonPath is undefined
	data = data ?? '.';
	const result = await this.rev_parse__git_dir(cwd);
	const repoPath = result?.commonPath ?? result?.path;
	if (repoPath?.length) return [true, repoPath];

[hwangh95]

Hmmm the issue is this doesn't solve the case where it's a bare clone with a .git folder and worktrees in it. Something like

repo/
repo/.git
repo/worktree1
repo/worktree2

doesn't get collapsed into one repo, but several repos with repeating worktrees. I think we should check when dotGitPath == commonDotGitPath but I don't know if we should change rev_parse__git_dir or just write a custom check like this

Suggested change

	// We can assume rev_parse__git_dir will always return a value since we know we are in a repo
	({ commonPath: data } = (await this.rev_parse__git_dir(cwd)) as {
	path: string;
	commonPath?: string;
	});
	// If the git dir is .git or a path pointed to by gitdir: ...,
	// we should treat it as an "empty" version of a bare clone
	// This is the case when git dir == git common dir, or when commonPath is undefined
	data = data ?? '.';
	data = await this.git<string>(
	{ cwd: cwd, errors: GitErrorHandling.Ignore },
	'rev-parse',
	'--git-dir',
	'--git-common-dir',
	);
	data = data.trim();
	if (data.length) {
	const [path, commonPath] = data.split('\n').map(r => r.trim());
	return [true, normalizePath((commonPath === '.' || commonPath === path ? cwd : commonPath).trimStart().replace(/[\r|\n]+$/, ''))];
	}
	}