test: add git worktree tests for top-level and read

Add comprehensive tests for git worktree support:
- Test toplevel() works correctly in worktrees
- Test toplevel() works from subdirectories in worktrees
- Test reading edit commit message from worktree

Author: awojasinski

@commitlint/read/package.json

@@ -38,8 +38,12 @@
   "devDependencies": {
     "@commitlint/test": "^20.0.0",
     "@commitlint/utils": "^20.0.0",
+    "@types/fs-extra": "^11.0.3",
     "@types/git-raw-commits": "^2.0.3",
-    "@types/minimist": "^1.2.4"
+    "@types/minimist": "^1.2.4",
+    "@types/tmp": "^0.2.5",
+    "fs-extra": "^11.0.0",
+    "tmp": "^0.2.1"
   },
   "dependencies": {
     "@commitlint/top-level": "^20.0.0",

@commitlint/read/src/read.test.ts

@@ -1,8 +1,10 @@
 import { test, expect } from "vitest";
 import fs from "fs/promises";
+import fsExtra from "fs-extra";
 import path from "node:path";
 import { git } from "@commitlint/test";
 import { x } from "tinyexec";
+import tmp from "tmp";
 
 import read from "./read.js";
 
@@ -150,3 +152,49 @@ test("should not read any commits when there are no tags", async () => {
 
 	expect(result).toHaveLength(0);
 });
+
+test("get edit commit message from git worktree", async () => {
+	const tmpDir = tmp.dirSync({ keep: false, unsafeCleanup: true });
+	const mainRepoDir = path.join(tmpDir.name, "main");
+	const worktreeDir = path.join(tmpDir.name, "worktree");
+
+	// Initialize main repo
+	await fsExtra.mkdirp(mainRepoDir);
+	await x("git", ["init"], { nodeOptions: { cwd: mainRepoDir } });
+	await x("git", ["config", "user.email", "test@example.com"], {
+		nodeOptions: { cwd: mainRepoDir },
+	});
+	await x("git", ["config", "user.name", "test"], {
+		nodeOptions: { cwd: mainRepoDir },
+	});
+	await x("git", ["config", "commit.gpgsign", "false"], {
+		nodeOptions: { cwd: mainRepoDir },
+	});
+
+	// Create initial commit in main repo
+	await fs.writeFile(path.join(mainRepoDir, "file.txt"), "content");
+	await x("git", ["add", "."], { nodeOptions: { cwd: mainRepoDir } });
+	await x("git", ["commit", "-m", "initial"], {
+		nodeOptions: { cwd: mainRepoDir },
+	});
+
+	// Create a branch and worktree
+	await x("git", ["branch", "worktree-branch"], {
+		nodeOptions: { cwd: mainRepoDir },
+	});
+	await x("git", ["worktree", "add", worktreeDir, "worktree-branch"], {
+		nodeOptions: { cwd: mainRepoDir },
+	});
+
+	// Make a commit in the worktree
+	await fs.writeFile(path.join(worktreeDir, "worktree-file.txt"), "worktree");
+	await x("git", ["add", "."], { nodeOptions: { cwd: worktreeDir } });
+	await x("git", ["commit", "-m", "worktree commit"], {
+		nodeOptions: { cwd: worktreeDir },
+	});
+
+	// Read the edit commit message from the worktree
+	const expected = ["worktree commit\n\n"];
+	const actual = await read({ edit: true, cwd: worktreeDir });
+	expect(actual).toEqual(expected);
+});

@commitlint/top-level/package.json

@@ -36,7 +36,11 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@commitlint/utils": "^20.0.0"
+    "@commitlint/utils": "^20.0.0",
+    "@types/fs-extra": "^11.0.3",
+    "@types/tmp": "^0.2.5",
+    "fs-extra": "^11.0.0",
+    "tmp": "^0.2.1"
   },
   "gitHead": "e82f05a737626bb69979d14564f5ff601997f679"
 }

@commitlint/top-level/src/index.test.ts

@@ -0,0 +1,127 @@
+import { test, expect, describe } from "vitest";
+import path from "node:path";
+import fs from "fs-extra";
+import tmp from "tmp";
+import { execFile } from "node:child_process";
+import { promisify } from "node:util";
+import { realpathSync } from "node:fs";
+
+import toplevel from "./index.js";
+
+const execFileAsync = promisify(execFile);
+
+/**
+ * Normalize a path for cross-platform comparison.
+ * On Windows, tmp paths may use short names (e.g., RUNNER~1) while git returns long names.
+ * This resolves symlinks and normalizes the path format.
+ */
+function normalizePath(p: string): string {
+	return realpathSync(p).replace(/\\/g, "/");
+}
+
+async function initGitRepo(cwd: string): Promise<void> {
+	await execFileAsync("git", ["init"], { cwd });
+	await execFileAsync("git", ["config", "user.email", "test@example.com"], {
+		cwd,
+	});
+	await execFileAsync("git", ["config", "user.name", "test"], { cwd });
+	await execFileAsync("git", ["config", "commit.gpgsign", "false"], { cwd });
+}
+
+describe("toplevel", () => {
+	test("should return git root for a regular repository", async () => {
+		const tmpDir = tmp.dirSync({ keep: false, unsafeCleanup: true });
+		const repoDir = tmpDir.name;
+
+		await initGitRepo(repoDir);
+
+		const result = await toplevel(repoDir);
+		expect(normalizePath(result!)).toBe(normalizePath(repoDir));
+	});
+
+	test("should return git root from a subdirectory", async () => {
+		const tmpDir = tmp.dirSync({ keep: false, unsafeCleanup: true });
+		const repoDir = tmpDir.name;
+
+		await initGitRepo(repoDir);
+
+		const subDir = path.join(repoDir, "sub", "dir");
+		await fs.mkdirp(subDir);
+
+		const result = await toplevel(subDir);
+		expect(normalizePath(result!)).toBe(normalizePath(repoDir));
+	});
+
+	test("should return undefined for a non-git directory", async () => {
+		const tmpDir = tmp.dirSync({ keep: false, unsafeCleanup: true });
+
+		const result = await toplevel(tmpDir.name);
+		expect(result).toBeUndefined();
+	});
+
+	test("should work with git worktrees", async () => {
+		const tmpDir = tmp.dirSync({ keep: false, unsafeCleanup: true });
+		const mainRepoDir = path.join(tmpDir.name, "main");
+		const worktreeDir = path.join(tmpDir.name, "worktree");
+
+		await fs.mkdirp(mainRepoDir);
+		await initGitRepo(mainRepoDir);
+
+		// Create an initial commit (required for worktree)
+		await fs.writeFile(path.join(mainRepoDir, "file.txt"), "content");
+		await execFileAsync("git", ["add", "."], { cwd: mainRepoDir });
+		await execFileAsync("git", ["commit", "-m", "initial"], {
+			cwd: mainRepoDir,
+		});
+
+		// Create a new branch for the worktree
+		await execFileAsync("git", ["branch", "worktree-branch"], {
+			cwd: mainRepoDir,
+		});
+
+		// Create the worktree
+		await execFileAsync(
+			"git",
+			["worktree", "add", worktreeDir, "worktree-branch"],
+			{ cwd: mainRepoDir },
+		);
+
+		// toplevel should return the worktree directory, not the main repo
+		const result = await toplevel(worktreeDir);
+		expect(normalizePath(result!)).toBe(normalizePath(worktreeDir));
+	});
+
+	test("should work from a subdirectory of a git worktree", async () => {
+		const tmpDir = tmp.dirSync({ keep: false, unsafeCleanup: true });
+		const mainRepoDir = path.join(tmpDir.name, "main");
+		const worktreeDir = path.join(tmpDir.name, "worktree");
+
+		await fs.mkdirp(mainRepoDir);
+		await initGitRepo(mainRepoDir);
+
+		// Create an initial commit
+		await fs.writeFile(path.join(mainRepoDir, "file.txt"), "content");
+		await execFileAsync("git", ["add", "."], { cwd: mainRepoDir });
+		await execFileAsync("git", ["commit", "-m", "initial"], {
+			cwd: mainRepoDir,
+		});
+
+		// Create a new branch and worktree
+		await execFileAsync("git", ["branch", "worktree-branch"], {
+			cwd: mainRepoDir,
+		});
+		await execFileAsync(
+			"git",
+			["worktree", "add", worktreeDir, "worktree-branch"],
+			{ cwd: mainRepoDir },
+		);
+
+		// Create a subdirectory in the worktree
+		const subDir = path.join(worktreeDir, "sub", "dir");
+		await fs.mkdirp(subDir);
+
+		// toplevel from subdirectory should return the worktree root
+		const result = await toplevel(subDir);
+		expect(normalizePath(result!)).toBe(normalizePath(worktreeDir));
+	});
+});