fix: add support for git worktree

fixes #87

Author: djcsdy

package.json

@@ -30,7 +30,6 @@
     "@softwareventures/array": "7.0.0",
     "@softwareventures/nullable": "3.2.0",
     "execa": "5.1.1",
-    "find-up": "5.0.0",
     "glob": "10.3.10",
     "ignore": "5.3.1",
     "mri": "1.2.0",

src/git-utils.ts

@@ -1,20 +1,17 @@
-import {dirname} from "path";
+import {normalize} from "path";
 import {hasProperty} from "unknown";
 import {notNull} from "@softwareventures/nullable";
-import findUp = require("find-up");
 import {runCommand} from "./utils";
 
 interface DiffIndexFile {
     diffFilterChar: string;
     filename: string;
 }
 
-export async function resolveNearestGitDirectoryParent(workingDirectory: string): Promise<string> {
-    const gitDirectoryPath = await findUp(".git", {cwd: workingDirectory, type: "directory"});
-    if (gitDirectoryPath == null) {
-        throw new Error("No .git directory found");
-    }
-    return dirname(gitDirectoryPath);
+export async function resolveGitWorkingTreePath(workingDirectory: string): Promise<string> {
+    return runCommand("git", ["rev-parse", "--show-toplevel"], workingDirectory)
+        .then(({stdout}) => stdout)
+        .then(normalize);
 }
 
 export const index = Symbol("index");

src/index.ts

@@ -14,12 +14,7 @@ import {
     of,
     scan
 } from "rxjs";
-import {
-    getModifiedFilenames,
-    index,
-    resolveNearestGitDirectoryParent,
-    workingTree
-} from "./git-utils";
+import {getModifiedFilenames, index, resolveGitWorkingTreePath, workingTree} from "./git-utils";
 import {generateFilesWhitelistPredicate, noLineChangeDataError} from "./utils";
 import {preciseFormatterPrettier} from "./precise-formatters/prettier";
 import {ModifiedFile} from "./modified-file";
@@ -81,19 +76,19 @@ export function main(
 
             const selectedFormatter = await preciseFormatterPrettier();
 
-            // Resolve the relevant .git directory's parent directory up front, as we will need this when
-            // executing various `git` commands.
-            const gitDirectoryParent = await resolveNearestGitDirectoryParent(workingDirectory);
+            // Resolve the working tree path up front, as we will need this
+            // when executing various `git` commands.
+            const workingTreePath = await resolveGitWorkingTreePath(workingDirectory);
 
             // Find files that we should process. A file is relevant if:
             //  * The file extension is supported by the given formatter.
             //  * The file is included in the optional `filesWhitelist` array, or no whitelist is specified.
             //  * The file is not ignored as a result of any supported "ignore" mechanism of the formatter.
             const relevantFiles = from(
-                getModifiedFilenames(gitDirectoryParent, options.base, options.head)
+                getModifiedFilenames(workingTreePath, options.base, options.head)
             ).pipe(
                 mergeMap(array => array),
-                map(path => join(gitDirectoryParent, path)),
+                map(path => join(workingTreePath, path)),
                 map(path => relative(workingDirectory, path)),
                 filter(path => !isAbsolute(path)),
                 filter(selectedFormatter.hasSupportedFileExtension),
@@ -117,7 +112,7 @@ export function main(
                     // Read the modified file contents and resolve the relevant formatter.
                     const modifiedFile = await ModifiedFile.read({
                         fullPath,
-                        gitDirectoryParent,
+                        gitDirectoryParent: workingTreePath,
                         base: options.base,
                         head: options.head ?? index,
                         selectedFormatter
@@ -181,7 +176,7 @@ export function main(
                     if (options.head == null) {
                         const workingTreeFile = await ModifiedFile.read({
                             fullPath,
-                            gitDirectoryParent,
+                            gitDirectoryParent: workingTreePath,
                             base: options.base,
                             head: workingTree,
                             selectedFormatter

test/git-utils.spec.ts

@@ -1,6 +1,10 @@
+import {sep} from "path";
+import * as tempy from "tempy";
+import {mkdirp} from "mkdirp";
+import {runCommand} from "@softwareventures/precise-commits/lib/utils";
 import {
     getDiffForFile,
-    resolveNearestGitDirectoryParent,
+    resolveGitWorkingTreePath,
     getModifiedFilenames,
     index
 } from "../src/git-utils";
@@ -10,7 +14,7 @@ const fixtures = readFixtures();
 let testBed: TestBed;
 
 describe("git-utils", () => {
-    describe("resolveNearestGitDirectoryParent()", () => {
+    describe("resolveGitWorkingTreePath()", () => {
         beforeAll(() => {
             testBed = new TestBed();
         });
@@ -26,11 +30,21 @@ describe("git-utils", () => {
                 /**
                  * The tmpFile should resolve to its own .git directory
                  */
-                expect(await resolveNearestGitDirectoryParent(tmpFile.directoryPath)).toEqual(
+                expect(await resolveGitWorkingTreePath(tmpFile.directoryPath)).toEqual(
                     tmpFile.directoryPath
                 );
             });
         });
+
+        it(`should resolve the correct working tree path in a working tree created by git worktree`, async () => {
+            await tempy.directory.task(async worktreePath => {
+                await runCommand("git", ["worktree", "add", "-B", "worktree", worktreePath]);
+                const subdirPath = `${worktreePath}${sep}subdir`;
+                await mkdirp(subdirPath);
+                expect(await resolveGitWorkingTreePath(subdirPath)).toEqual(worktreePath);
+                await runCommand("git", ["worktree", "remove", worktreePath]);
+            });
+        });
     });
 
     describe("getDiffForFile()", () => {
@@ -46,9 +60,7 @@ describe("git-utils", () => {
             it(fixture.fixtureName, async () => {
                 await testBed.prepareFixtureInTmpDirectory(fixture);
                 const tmpFile = testBed.getTmpFileForFixture(fixture);
-                const gitDirectoryParent = await resolveNearestGitDirectoryParent(
-                    tmpFile.directoryPath
-                );
+                const gitDirectoryParent = await resolveGitWorkingTreePath(tmpFile.directoryPath);
                 const diff = await getDiffForFile(
                     gitDirectoryParent,
                     tmpFile.path,
@@ -73,9 +85,7 @@ describe("git-utils", () => {
             it(fixture.fixtureName, async () => {
                 await testBed.prepareFixtureInTmpDirectory(fixture);
                 const tmpFile = testBed.getTmpFileForFixture(fixture);
-                const gitDirectoryParent = await resolveNearestGitDirectoryParent(
-                    tmpFile.directoryPath
-                );
+                const gitDirectoryParent = await resolveGitWorkingTreePath(tmpFile.directoryPath);
                 const fileNames = await getModifiedFilenames(
                     gitDirectoryParent,
                     tmpFile.initialCommitSHA,

test/modified-file.spec.ts

@@ -1,6 +1,6 @@
 import {ModifiedFile} from "../src/modified-file";
 import {preciseFormatterPrettier} from "../src/precise-formatters/prettier";
-import {resolveNearestGitDirectoryParent, workingTree} from "../src/git-utils";
+import {resolveGitWorkingTreePath, workingTree} from "../src/git-utils";
 import {TestBed, readFixtures} from "./test-utils";
 
 const fixtures = readFixtures();
@@ -20,9 +20,7 @@ describe("ModifiedFile", () => {
             it(fixture.fixtureName, async () => {
                 await testBed.prepareFixtureInTmpDirectory(fixture);
                 const tmpFile = testBed.getTmpFileForFixture(fixture);
-                const gitDirectoryParent = await resolveNearestGitDirectoryParent(
-                    tmpFile.directoryPath
-                );
+                const gitDirectoryParent = await resolveGitWorkingTreePath(tmpFile.directoryPath);
                 const selectedFormatter = await preciseFormatterPrettier();
                 const modifiedFile = await ModifiedFile.read({
                     fullPath: tmpFile.path,

test/utils.spec.ts

@@ -1,4 +1,4 @@
-import {getDiffForFile, index, resolveNearestGitDirectoryParent} from "../src/git-utils";
+import {getDiffForFile, index, resolveGitWorkingTreePath} from "../src/git-utils";
 import {extractLineChangeData, calculateCharacterRangesFromLineChanges} from "../src/utils";
 import {TestBed, readFixtures} from "./test-utils";
 
@@ -39,9 +39,7 @@ describe("utils", () => {
             it(fixture.fixtureName, async () => {
                 await testBed.prepareFixtureInTmpDirectory(fixture);
                 const tmpFile = testBed.getTmpFileForFixture(fixture);
-                const gitDirectoryParent = await resolveNearestGitDirectoryParent(
-                    tmpFile.directoryPath
-                );
+                const gitDirectoryParent = await resolveGitWorkingTreePath(tmpFile.directoryPath);
                 const diff = await getDiffForFile(
                     gitDirectoryParent,
                     tmpFile.path,
@@ -67,9 +65,7 @@ describe("utils", () => {
             it(fixture.fixtureName, async () => {
                 await testBed.prepareFixtureInTmpDirectory(fixture);
                 const tmpFile = testBed.getTmpFileForFixture(fixture);
-                const gitDirectoryParent = await resolveNearestGitDirectoryParent(
-                    tmpFile.directoryPath
-                );
+                const gitDirectoryParent = await resolveGitWorkingTreePath(tmpFile.directoryPath);
                 const diff = await getDiffForFile(
                     gitDirectoryParent,
                     tmpFile.path,

yarn.lock

@@ -1719,7 +1719,6 @@ __metadata:
     eslint-plugin-prefer-arrow: "npm:1.2.3"
     eslint-plugin-sonarjs: "npm:0.25.1"
     execa: "npm:5.1.1"
-    find-up: "npm:5.0.0"
     glob: "npm:10.3.10"
     husky: "npm:9.0.11"
     ignore: "npm:5.3.1"