@paleo/workspace 0.11.0

package/dist/worktree.js

@@ -0,0 +1,124 @@
+import { execFileSync } from "node:child_process";
+import { existsSync } from "node:fs";
+import { basename, dirname, join, resolve } from "node:path";
+export function detectWorktree() {
+    const currentWorktree = execFileSync("git", ["rev-parse", "--show-toplevel"], {
+        encoding: "utf-8",
+    }).trim();
+    const gitCommonDir = execFileSync("git", ["rev-parse", "--path-format=absolute", "--git-common-dir"], { encoding: "utf-8" }).trim();
+    const mainWorktree = dirname(gitCommonDir);
+    const isMainWorktree = resolve(currentWorktree) === resolve(mainWorktree);
+    return { currentWorktree, mainWorktree, isMainWorktree };
+}
+export function enforceWorktreeMode(command, ctx) {
+    // Adding a worktree for a branch must happen from the main worktree. A branch-less
+    // `workspace setup` runs anywhere: linked worktree (retry path) or main (initial bootstrap).
+    if (command.kind === "setup" && command.branch !== undefined && !ctx.isMainWorktree) {
+        console.error("Error: Adding a workspace for a branch must be run from the main worktree.");
+        process.exit(1);
+    }
+}
+export function useExistingBranch(branch, ctx, run, dirNameFn = defaultWorktreeDirName) {
+    if (!branchExists(branch)) {
+        console.error(`Error: Branch "${branch}" does not exist locally or on the remote.`);
+        process.exit(1);
+    }
+    const worktreePath = dedupeWorktreePath(computeWorktreePath(ctx.mainWorktree, branch, dirNameFn));
+    execFileSync("git", ["worktree", "add", worktreePath, branch], { stdio: stdioFor(run) });
+    return { ...ctx, currentWorktree: worktreePath, isMainWorktree: false };
+}
+export function createBranch(requestedBranch, ctx, run, dirNameFn = defaultWorktreeDirName) {
+    let finalBranch = requestedBranch;
+    if (branchExists(finalBranch)) {
+        let suffix = 2;
+        while (branchExists(`${requestedBranch}-${suffix}`)) {
+            ++suffix;
+        }
+        finalBranch = `${requestedBranch}-${suffix}`;
+        console.warn(`Warning: Branch "${requestedBranch}" already exists; using "${finalBranch}" instead.`);
+    }
+    const worktreePath = dedupeWorktreePath(computeWorktreePath(ctx.mainWorktree, finalBranch, dirNameFn));
+    execFileSync("git", ["worktree", "add", "-b", finalBranch, worktreePath], {
+        stdio: stdioFor(run),
+    });
+    return { ...ctx, currentWorktree: worktreePath, isMainWorktree: false };
+}
+export function verifyBranchAbsentFromRemote(branch, run) {
+    execFileSync("git", ["fetch"], { stdio: stdioFor(run) });
+    const remoteBranches = execFileSync("git", ["branch", "-r", "--list", `origin/${branch}`], {
+        encoding: "utf-8",
+    }).trim();
+    if (remoteBranches.length > 0) {
+        console.error(`Error: Branch "${branch}" still exists on the remote. Use --no-remote-check to skip this verification.`);
+        process.exit(1);
+    }
+}
+export function getWorktreeBranch(worktreePath) {
+    try {
+        const out = execFileSync("git", ["branch", "--show-current"], {
+            stdio: "pipe",
+            cwd: worktreePath,
+        })
+            .toString("utf-8")
+            .trim();
+        return out.length > 0 ? out : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+export function removeWorktree(worktreePath, run) {
+    execFileSync("git", ["worktree", "remove", "--force", worktreePath], { stdio: stdioFor(run) });
+}
+/**
+ * Default {@link WorktreeDirNameFn}. Strips a recognizable ticket suffix from the last branch
+ * segment (`feat/ABC-123-extra` → `feat-ABC-123`), caps the result at 22 chars, and strips
+ * trailing dashes. Falls back to the full sanitized branch when no ticket pattern is found.
+ */
+export const defaultWorktreeDirName = ({ branch, repoName }) => {
+    return `${repoName}-${shortenBranchSegment(branch)}`;
+};
+function shortenBranchSegment(branch) {
+    const parts = branch.split("/");
+    const last = parts[parts.length - 1] ?? "";
+    const match = last.match(/^([A-Za-z]+-\d+|\d+)/);
+    if (match) {
+        parts[parts.length - 1] = match[1];
+    }
+    let result = parts.join("-");
+    if (result.length > 22) {
+        result = result.slice(0, 22);
+    }
+    return result.replace(/-+$/, "");
+}
+export function computeWorktreePath(mainWorktree, branch, dirNameFn = defaultWorktreeDirName) {
+    const repoName = basename(mainWorktree);
+    return join(dirname(mainWorktree), dirNameFn({ branch, repoName }));
+}
+function dedupeWorktreePath(candidate) {
+    if (!existsSync(candidate))
+        return candidate;
+    let suffix = 2;
+    while (existsSync(`${candidate}-${suffix}`)) {
+        ++suffix;
+    }
+    return `${candidate}-${suffix}`;
+}
+function branchExists(branch) {
+    try {
+        execFileSync("git", ["rev-parse", "--verify", branch], { stdio: "pipe" });
+        return true;
+    }
+    catch {
+        try {
+            execFileSync("git", ["rev-parse", "--verify", `origin/${branch}`], { stdio: "pipe" });
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+}
+function stdioFor(ctx) {
+    return ctx.verbose ? "inherit" : "pipe";
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@paleo/workspace",
+  "version": "0.11.0",
+  "description": "Run multiple git-worktree dev environments side by side.",
+  "keywords": [
+    "workspace",
+    "worktree",
+    "environment",
+    "concurrent",
+    "local"
+  ],
+  "license": "CC0-1.0",
+  "author": "Thomas MUR",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/paleo/alignfirst.git",
+    "directory": "packages/workspace"
+  },
+  "engines": {
+    "node": ">=22.11.0"
+  },
+  "packageManager": "npm@11.11.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "clear": "rimraf dist/*",
+    "lint": "biome check",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "devDependencies": {
+    "@types/node": "~24.12.4",
+    "rimraf": "~6.1.3",
+    "typescript": "~6.0.3",
+    "vitest": "~4.1.7"
+  }
+}