fix: add support for git worktree

fixes #87

Author: djcsdy

package.json

@@ -29,7 +29,6 @@
     "@softwareventures/array": "6.1.0",
     "@softwareventures/nullable": "3.2.0",
     "execa": "5.1.1",
-    "find-up": "5.0.0",
     "glob": "8.1.0",
     "ignore": "5.3.1",
     "mri": "1.2.0",

src/git-utils.ts

@@ -1,21 +1,17 @@
-import {sync as findUpSync} from "find-up";
-import {dirname} from "path";
-
-import {runCommandSync} from "./utils";
+import {normalize} from "path";
 import {hasProperty} from "unknown";
 import {notNull} from "@softwareventures/nullable";
+import {runCommandSync} from "./utils";
 
 interface DiffIndexFile {
     diffFilterChar: string;
     filename: string;
 }
 
-export function resolveNearestGitDirectoryParent(workingDirectory: string) {
-    const gitDirectoryPath = findUpSync(".git", {cwd: workingDirectory, type: "directory"});
-    if (!gitDirectoryPath) {
-        throw new Error("No .git directory found");
-    }
-    return dirname(gitDirectoryPath);
+export function resolveGitWorkingTreePath(workingDirectory: string): string {
+    return normalize(
+        runCommandSync("git", ["rev-parse", "--show-toplevel"], workingDirectory).stdout
+    );
 }
 
 export const index = Symbol("index");

src/index.ts

@@ -1,12 +1,7 @@
 import {isAbsolute, join, relative} from "path";
 
 import type {Observable} from "rxjs";
-import {
-    getModifiedFilenames,
-    index,
-    resolveNearestGitDirectoryParent,
-    workingTree
-} from "./git-utils";
+import {getModifiedFilenames, index, resolveGitWorkingTreePath, workingTree} from "./git-utils";
 import {NO_LINE_CHANGE_DATA_ERROR, generateFilesWhitelistPredicate} from "./utils";
 import {ModifiedFile} from "./modified-file";
 import {preciseFormatterPrettier} from "./precise-formatters/prettier";
@@ -87,15 +82,15 @@ export function main(
 
         emit({event: "Init", workingDirectory});
 
-        // Resolve the relevant .git directory's parent directory up front, as we will need this when
-        // executing various `git` commands.
-        const gitDirectoryParent = resolveNearestGitDirectoryParent(workingDirectory);
+        // Resolve the working tree path up front, as we will need this
+        // when executing various `git` commands.
+        const workingTreePath = resolveGitWorkingTreePath(workingDirectory);
 
         // We fundamentally check whether or not the file extensions are supported by the given formatter,
         // whether or not they are included in the optional `filesWhitelist` array, and that the user
         // has not chosen to ignore them via any supported "ignore" mechanism of the formatter.
-        const modifiedFiles = getModifiedFilenames(gitDirectoryParent, options.base, options.head)
-            .map(path => join(gitDirectoryParent, path))
+        const modifiedFiles = getModifiedFilenames(workingTreePath, options.base, options.head)
+            .map(path => join(workingTreePath, path))
             .map(path => relative(workingDirectory, path))
             .filter(path => !isAbsolute(path))
             .filter(selectedFormatter.hasSupportedFileExtension)
@@ -114,7 +109,7 @@ export function main(
             // Read the modified file contents and resolve the relevant formatter.
             const modifiedFile = new ModifiedFile({
                 fullPath,
-                gitDirectoryParent,
+                gitDirectoryParent: workingTreePath,
                 base: options.base,
                 head: options.head ?? index,
                 selectedFormatter
@@ -182,7 +177,7 @@ export function main(
             if (options.head == null) {
                 const workingTreeFile = new ModifiedFile({
                     fullPath,
-                    gitDirectoryParent,
+                    gitDirectoryParent: workingTreePath,
                     base: options.base,
                     head: workingTree,
                     selectedFormatter

test/git-utils.spec.ts

@@ -1,16 +1,20 @@
-import {TestBed, readFixtures} from "./test-utils";
+import {sep} from "path";
+import * as tempy from "tempy";
+import {mkdirp} from "mkdirp";
+import {runCommandSync} from "../src/utils";
 import {
     getDiffForFile,
-    resolveNearestGitDirectoryParent,
+    resolveGitWorkingTreePath,
     getModifiedFilenames,
     index
 } from "../src/git-utils";
+import {TestBed, readFixtures} from "./test-utils";
 
 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(resolveNearestGitDirectoryParent(tmpFile.directoryPath)).toEqual(
+                expect(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 => {
+                runCommandSync("git", ["worktree", "add", "-B", "worktree", worktreePath]);
+                const subdirPath = `${worktreePath}${sep}subdir`;
+                await mkdirp(subdirPath);
+                expect(resolveGitWorkingTreePath(subdirPath)).toEqual(worktreePath);
+                runCommandSync("git", ["worktree", "remove", worktreePath]);
+            });
+        });
     });
 
     describe("getDiffForFile()", () => {
@@ -46,8 +60,9 @@ describe("git-utils", () => {
             it(fixture.fixtureName, () => {
                 testBed.prepareFixtureInTmpDirectory(fixture);
                 const tmpFile = testBed.getTmpFileForFixture(fixture);
+                const gitDirectoryParent = resolveGitWorkingTreePath(tmpFile.directoryPath);
                 const diff = getDiffForFile(
-                    resolveNearestGitDirectoryParent(tmpFile.directoryPath),
+                    gitDirectoryParent,
                     tmpFile.path,
                     tmpFile.initialCommitSHA,
                     tmpFile.updatedCommitSHA ?? index
@@ -70,8 +85,9 @@ describe("git-utils", () => {
             it(fixture.fixtureName, () => {
                 testBed.prepareFixtureInTmpDirectory(fixture);
                 const tmpFile = testBed.getTmpFileForFixture(fixture);
+                const gitDirectoryParent = resolveGitWorkingTreePath(tmpFile.directoryPath);
                 const fileNames = getModifiedFilenames(
-                    resolveNearestGitDirectoryParent(tmpFile.directoryPath),
+                    gitDirectoryParent,
                     tmpFile.initialCommitSHA,
                     tmpFile.updatedCommitSHA
                 );

test/modified-file.spec.ts

@@ -2,7 +2,7 @@ import {TestBed, readFixtures} from "./test-utils";
 
 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";
 
 const fixtures = readFixtures();
 let testBed: TestBed;
@@ -21,9 +21,10 @@ describe("ModifiedFile", () => {
             it(fixture.fixtureName, () => {
                 testBed.prepareFixtureInTmpDirectory(fixture);
                 const tmpFile = testBed.getTmpFileForFixture(fixture);
+                const gitDirectoryParent = resolveGitWorkingTreePath(tmpFile.directoryPath);
                 const modifiedFile = new ModifiedFile({
                     fullPath: tmpFile.path,
-                    gitDirectoryParent: resolveNearestGitDirectoryParent(tmpFile.directoryPath),
+                    gitDirectoryParent,
                     base: tmpFile.initialCommitSHA,
                     head: tmpFile.updatedCommitSHA ?? workingTree,
                     selectedFormatter: preciseFormatterPrettier

test/utils.spec.ts

@@ -1,5 +1,5 @@
 import {TestBed, readFixtures} from "./test-utils";
-import {getDiffForFile, index, resolveNearestGitDirectoryParent} from "../src/git-utils";
+import {getDiffForFile, index, resolveGitWorkingTreePath} from "../src/git-utils";
 import {extractLineChangeData, calculateCharacterRangesFromLineChanges} from "../src/utils";
 
 const fixtures = readFixtures();
@@ -39,8 +39,9 @@ describe("utils", () => {
             it(fixture.fixtureName, () => {
                 testBed.prepareFixtureInTmpDirectory(fixture);
                 const tmpFile = testBed.getTmpFileForFixture(fixture);
+                const gitDirectoryParent = resolveGitWorkingTreePath(tmpFile.directoryPath);
                 const diff = getDiffForFile(
-                    resolveNearestGitDirectoryParent(tmpFile.directoryPath),
+                    gitDirectoryParent,
                     tmpFile.path,
                     tmpFile.initialCommitSHA,
                     tmpFile.updatedCommitSHA ?? index
@@ -64,8 +65,9 @@ describe("utils", () => {
             it(fixture.fixtureName, () => {
                 testBed.prepareFixtureInTmpDirectory(fixture);
                 const tmpFile = testBed.getTmpFileForFixture(fixture);
+                const gitDirectoryParent = resolveGitWorkingTreePath(tmpFile.directoryPath);
                 const diff = getDiffForFile(
-                    resolveNearestGitDirectoryParent(tmpFile.directoryPath),
+                    gitDirectoryParent,
                     tmpFile.path,
                     tmpFile.initialCommitSHA,
                     tmpFile.updatedCommitSHA ?? index