@ree-auz/nook 0.1.0 → 0.1.2

package/src/context.mjs

@@ -1,189 +1,189 @@
-import { existsSync, renameSync } from "node:fs";
-import { basename, join, relative } from "node:path";
-import { applyChanges, loadConfig, saveConfig, syncInPlace, withLock, withLockSync } from "./config.mjs";
-import { NookError } from "./errors.mjs";
-import { homePaths, isInside, nookHome, samePath } from "./home.mjs";
-import { normalizeName } from "./names.mjs";
-import { gitTry, listWorktrees } from "./git.mjs";
-import { line, useColor } from "./ui.mjs";
-
-/** Shared state for one command run. */
-export function createContext({ env = process.env, cwd = process.cwd(), out = process.stdout, err = process.stderr } = {}) {
-  const paths = homePaths(nookHome(env));
-  const config = loadConfig(paths.config);
-  const moveFailed = moveOldWorkspaceFolder(paths, config);
-  // What this run changed is config minus base; on save it goes onto what is on disk now,
-  // so changes another nk made meanwhile are kept.
-  let base = structuredClone(config);
-  const merge = () => {
-    const disk = applyChanges(base, config, loadConfig(paths.config));
-    saveConfig(paths.config, disk);
-    syncInPlace(config, disk);
-    base = structuredClone(config);
-  };
-  const color = useColor(err, env);
-  const say = (kind) => (text) => err.write(`${line(kind, text, color)}\n`);
-  if (moveFailed)
-    say("warn")(`Could not rename ${paths.workspaces} to ${join(paths.home, "workspace")} (${moveFailed}); still using the old folder. Close programs open in it (terminals, editors, dev servers) and run nk again.`);
-  return {
-    env,
-    cwd,
-    paths,
-    config,
-    out,
-    err,
-    save() {
-      withLockSync(paths.config, merge);
-    },
-    /**
-     * Brings config up to date with disk, runs fn on it and saves, all under the lock: for choices
-     * that must not clash with another nk running at the same time, such as a workspace's ports.
-     */
-    async update(fn) {
-      return withLock(paths.config, async () => {
-        merge();
-        const result = await fn(config);
-        merge();
-        return result;
-      });
-    },
-    print(text = "") {
-      out.write(`${text}\n`);
-    },
-    note(text = "") {
-      err.write(`${text}\n`);
-    },
-    step: say("step"),
-    ok: say("ok"),
-    warn: say("warn"),
-    info: say("info"),
-    item: say("item"),
-  };
-}
-
-/**
- * Before 0.1 the folder was called "workspaces". Renames it once and tells git
- * where the workspaces went. When it cannot (a file is open on Windows), keeps
- * using the old folder and returns why.
- */
-function moveOldWorkspaceFolder(paths, config) {
-  const old = join(paths.home, "workspaces");
-  if (!existsSync(old) || existsSync(paths.workspaces)) return;
-  const moves = [];
-  for (const repo of Object.values(config.repos ?? {}))
-    for (const ws of Object.values(repo.workspaces ?? {}))
-      if (isInside(ws.path, old)) moves.push({ repo, ws, path: join(paths.workspaces, relative(old, ws.path)) });
-  try {
-    renameSync(old, paths.workspaces);
-  } catch (error) {
-    paths.workspaces = old;
-    return error.code ?? error.message;
-  }
-  for (const move of moves) move.ws.path = move.path;
-  for (const repo of new Set(moves.map((move) => move.repo)))
-    gitTry(["worktree", "repair", ...moves.filter((move) => move.repo === repo).map((move) => move.path)], { cwd: repo.path });
-  if (moves.length) saveConfig(paths.config, config);
-  return null;
-}
-
-/** The registered repository `cwd` belongs to, or null. */
-export function repoFromCwd(ctx) {
-  for (const [name, repo] of Object.entries(ctx.config.repos)) {
-    if (isInside(ctx.cwd, join(ctx.paths.workspaces, name))) return name;
-    if (isInside(ctx.cwd, repo.path)) return name;
-    for (const ws of Object.values(repo.workspaces)) if (isInside(ctx.cwd, ws.path)) return name;
-  }
-  const top = gitTry(["rev-parse", "--show-toplevel"], { cwd: ctx.cwd });
-  if (top.ok) {
-    try {
-      const [main] = listWorktrees(ctx.cwd);
-      for (const [name, repo] of Object.entries(ctx.config.repos)) if (main && isInside(main.path, repo.path)) return name;
-    } catch {
-      /* Not a usable repository. */
-    }
-  }
-  return null;
-}
-
-function requireRepo(ctx, name) {
-  const repo = ctx.config.repos[name];
-  if (!repo) throw new NookError(`Unknown repository "${name}". Registered: ${Object.keys(ctx.config.repos).join(", ") || "none"}`);
-  return { name, repo };
-}
-
-/**
- * The repository a command acts on: --repo, else the one the current folder
- * belongs to (its main checkout or one of its workspaces). Like git and
- * worktrunk, nothing is guessed outside a repository.
- */
-export function resolveRepo(ctx, flag) {
-  if (flag) return requireRepo(ctx, flag);
-  const fromCwd = repoFromCwd(ctx);
-  if (fromCwd) return requireRepo(ctx, fromCwd);
-  if (!Object.keys(ctx.config.repos).length) throw new NookError("No repository yet. Run nk init inside a repository first");
-  throw new NookError(
-    `Not inside a registered repository. Run nk in the repository or one of its workspaces, or pass --repo (${Object.keys(ctx.config.repos).join(", ")})`,
-  );
-}
-
-/**
- * Every worktree of a repository, as git lists them, joined with what Nook
- * recorded (port, creation time). Git is the source of truth, like worktrunk:
- * worktrees made by other tools show up too, without a port. The main
- * checkout comes first with `main: true`; workspaces Nook recorded whose
- * folder is gone come last.
- */
-export function repoWorkspaces(repoName, repo) {
-  let trees = [];
-  try {
-    trees = listWorktrees(repo.path);
-  } catch {
-    /* Not a usable repository; nk doctor reports it. */
-  }
-  const items = [];
-  const recorded = new Set();
-  const taken = new Set(Object.keys(repo.workspaces));
-  trees.forEach((tree, index) => {
-    if (tree.bare) return;
-    const found = Object.entries(repo.workspaces).find(([, ws]) => samePath(ws.path, tree.path));
-    if (found) {
-      recorded.add(found[0]);
-      items.push({ repoName, repo, name: found[0], ws: { ...found[1], locked: tree.locked }, main: false, managed: true });
-      return;
-    }
-    let name = normalizeName(tree.branch ?? basename(tree.path));
-    if (index > 0 && (!name || taken.has(name))) name = normalizeName(basename(tree.path));
-    taken.add(name);
-    const ws = { path: tree.path, branch: tree.branch, locked: tree.locked };
-    items.push({ repoName, repo, name, ws, main: index === 0, managed: false });
-  });
-  for (const [name, ws] of Object.entries(repo.workspaces))
-    if (!recorded.has(name)) items.push({ repoName, repo, name, ws, main: false, managed: true });
-  return items;
-}
-
-/** An existing workspace of the current repository (or --repo) by name: its branch or folder name, converted the same way. */
-export function resolveWorkspace(ctx, name, flag) {
-  const { name: repoName, repo } = resolveRepo(ctx, flag);
-  const items = repoWorkspaces(repoName, repo);
-  const hit = items.find((item) => item.name === name) ?? items.find((item) => normalizeName(basename(item.ws.path)) === name);
-  if (hit) return hit;
-  throw new NookError(`No workspace named "${name}" in ${repoName}. Create it with: nk -b ${name}`);
-}
-
-/** The git branch of a workspace: its name, unless the branch had characters a name cannot use. */
-export function branchOf(name, ws) {
-  return "branch" in ws ? ws.branch : name;
-}
-
-/** Variables hooks and agents see. */
-export function workspaceEnv(ctx, { repoName, repo, name, ws }) {
-  return {
-    ...ctx.env,
-    NOOK_WORKSPACE: name,
-    NOOK_PATH: ws.path,
-    NOOK_REPO: repo.path,
-    NOOK_SHARED: join(ctx.paths.shared, repoName),
-    NOOK_PORT: String(ws.port ?? ""),
-  };
-}
+import { existsSync, renameSync } from "node:fs";
+import { basename, join, relative } from "node:path";
+import { applyChanges, loadConfig, saveConfig, syncInPlace, withLock, withLockSync } from "./config.mjs";
+import { NookError } from "./errors.mjs";
+import { homePaths, isInside, nookHome, samePath } from "./home.mjs";
+import { normalizeName } from "./names.mjs";
+import { gitTry, listWorktrees } from "./git.mjs";
+import { line, useColor } from "./ui.mjs";
+
+/** Shared state for one command run. */
+export function createContext({ env = process.env, cwd = process.cwd(), out = process.stdout, err = process.stderr } = {}) {
+  const paths = homePaths(nookHome(env));
+  const config = loadConfig(paths.config);
+  const moveFailed = moveOldWorkspaceFolder(paths, config);
+  // What this run changed is config minus base; on save it goes onto what is on disk now,
+  // so changes another nk made meanwhile are kept.
+  let base = structuredClone(config);
+  const merge = () => {
+    const disk = applyChanges(base, config, loadConfig(paths.config));
+    saveConfig(paths.config, disk);
+    syncInPlace(config, disk);
+    base = structuredClone(config);
+  };
+  const color = useColor(err, env);
+  const say = (kind) => (text) => err.write(`${line(kind, text, color)}\n`);
+  if (moveFailed)
+    say("warn")(`Could not rename ${paths.workspaces} to ${join(paths.home, "workspace")} (${moveFailed}); still using the old folder. Close programs open in it (terminals, editors, dev servers) and run nk again.`);
+  return {
+    env,
+    cwd,
+    paths,
+    config,
+    out,
+    err,
+    save() {
+      withLockSync(paths.config, merge);
+    },
+    /**
+     * Brings config up to date with disk, runs fn on it and saves, all under the lock: for choices
+     * that must not clash with another nk running at the same time, such as a workspace's ports.
+     */
+    async update(fn) {
+      return withLock(paths.config, async () => {
+        merge();
+        const result = await fn(config);
+        merge();
+        return result;
+      });
+    },
+    print(text = "") {
+      out.write(`${text}\n`);
+    },
+    note(text = "") {
+      err.write(`${text}\n`);
+    },
+    step: say("step"),
+    ok: say("ok"),
+    warn: say("warn"),
+    info: say("info"),
+    item: say("item"),
+  };
+}
+
+/**
+ * Before 0.1 the folder was called "workspaces". Renames it once and tells git
+ * where the workspaces went. When it cannot (a file is open on Windows), keeps
+ * using the old folder and returns why.
+ */
+function moveOldWorkspaceFolder(paths, config) {
+  const old = join(paths.home, "workspaces");
+  if (!existsSync(old) || existsSync(paths.workspaces)) return;
+  const moves = [];
+  for (const repo of Object.values(config.repos ?? {}))
+    for (const ws of Object.values(repo.workspaces ?? {}))
+      if (isInside(ws.path, old)) moves.push({ repo, ws, path: join(paths.workspaces, relative(old, ws.path)) });
+  try {
+    renameSync(old, paths.workspaces);
+  } catch (error) {
+    paths.workspaces = old;
+    return error.code ?? error.message;
+  }
+  for (const move of moves) move.ws.path = move.path;
+  for (const repo of new Set(moves.map((move) => move.repo)))
+    gitTry(["worktree", "repair", ...moves.filter((move) => move.repo === repo).map((move) => move.path)], { cwd: repo.path });
+  if (moves.length) saveConfig(paths.config, config);
+  return null;
+}
+
+/** The registered repository `cwd` belongs to, or null. */
+export function repoFromCwd(ctx) {
+  for (const [name, repo] of Object.entries(ctx.config.repos)) {
+    if (isInside(ctx.cwd, join(ctx.paths.workspaces, name))) return name;
+    if (isInside(ctx.cwd, repo.path)) return name;
+    for (const ws of Object.values(repo.workspaces)) if (isInside(ctx.cwd, ws.path)) return name;
+  }
+  const top = gitTry(["rev-parse", "--show-toplevel"], { cwd: ctx.cwd });
+  if (top.ok) {
+    try {
+      const [main] = listWorktrees(ctx.cwd);
+      for (const [name, repo] of Object.entries(ctx.config.repos)) if (main && isInside(main.path, repo.path)) return name;
+    } catch {
+      /* Not a usable repository. */
+    }
+  }
+  return null;
+}
+
+function requireRepo(ctx, name) {
+  const repo = ctx.config.repos[name];
+  if (!repo) throw new NookError(`Unknown repository "${name}". Registered: ${Object.keys(ctx.config.repos).join(", ") || "none"}`);
+  return { name, repo };
+}
+
+/**
+ * The repository a command acts on: --repo, else the one the current folder
+ * belongs to (its main checkout or one of its workspaces). Like git and
+ * worktrunk, nothing is guessed outside a repository.
+ */
+export function resolveRepo(ctx, flag) {
+  if (flag) return requireRepo(ctx, flag);
+  const fromCwd = repoFromCwd(ctx);
+  if (fromCwd) return requireRepo(ctx, fromCwd);
+  if (!Object.keys(ctx.config.repos).length) throw new NookError("No repository yet. Run nk init inside a repository first");
+  throw new NookError(
+    `Not inside a registered repository. Run nk in the repository or one of its workspaces, or pass --repo (${Object.keys(ctx.config.repos).join(", ")})`,
+  );
+}
+
+/**
+ * Every worktree of a repository, as git lists them, joined with what Nook
+ * recorded (port, creation time). Git is the source of truth, like worktrunk:
+ * worktrees made by other tools show up too, without a port. The main
+ * checkout comes first with `main: true`; workspaces Nook recorded whose
+ * folder is gone come last.
+ */
+export function repoWorkspaces(repoName, repo) {
+  let trees = [];
+  try {
+    trees = listWorktrees(repo.path);
+  } catch {
+    /* Not a usable repository; nk doctor reports it. */
+  }
+  const items = [];
+  const recorded = new Set();
+  const taken = new Set(Object.keys(repo.workspaces));
+  trees.forEach((tree, index) => {
+    if (tree.bare) return;
+    const found = Object.entries(repo.workspaces).find(([, ws]) => samePath(ws.path, tree.path));
+    if (found) {
+      recorded.add(found[0]);
+      items.push({ repoName, repo, name: found[0], ws: { ...found[1], locked: tree.locked }, main: false, managed: true });
+      return;
+    }
+    let name = normalizeName(tree.branch ?? basename(tree.path));
+    if (index > 0 && (!name || taken.has(name))) name = normalizeName(basename(tree.path));
+    taken.add(name);
+    const ws = { path: tree.path, branch: tree.branch, locked: tree.locked };
+    items.push({ repoName, repo, name, ws, main: index === 0, managed: false });
+  });
+  for (const [name, ws] of Object.entries(repo.workspaces))
+    if (!recorded.has(name)) items.push({ repoName, repo, name, ws, main: false, managed: true });
+  return items;
+}
+
+/** An existing workspace of the current repository (or --repo) by name: its branch or folder name, converted the same way. */
+export function resolveWorkspace(ctx, name, flag) {
+  const { name: repoName, repo } = resolveRepo(ctx, flag);
+  const items = repoWorkspaces(repoName, repo);
+  const hit = items.find((item) => item.name === name) ?? items.find((item) => normalizeName(basename(item.ws.path)) === name);
+  if (hit) return hit;
+  throw new NookError(`No workspace named "${name}" in ${repoName}. Create it with: nk -b ${name}`);
+}
+
+/** The git branch of a workspace: its name, unless the branch had characters a name cannot use. */
+export function branchOf(name, ws) {
+  return "branch" in ws ? ws.branch : name;
+}
+
+/** Variables hooks and agents see. */
+export function workspaceEnv(ctx, { repoName, repo, name, ws }) {
+  return {
+    ...ctx.env,
+    NOOK_WORKSPACE: name,
+    NOOK_PATH: ws.path,
+    NOOK_REPO: repo.path,
+    NOOK_SHARED: join(ctx.paths.shared, repoName),
+    NOOK_PORT: String(ws.port ?? ""),
+  };
+}

package/src/errors.mjs

@@ -1,8 +1,8 @@
-/** An expected failure: printed as one line, without a stack trace. */
-export class NookError extends Error {
-  constructor(message, { code = 1 } = {}) {
-    super(message);
-    this.name = "NookError";
-    this.code = code;
-  }
-}
+/** An expected failure: printed as one line, without a stack trace. */
+export class NookError extends Error {
+  constructor(message, { code = 1 } = {}) {
+    super(message);
+    this.name = "NookError";
+    this.code = code;
+  }
+}

package/src/forge.mjs

@@ -1,75 +1,75 @@
-import spawn from "cross-spawn";
-import { which } from "./agents.mjs";
-
-const FAILED = new Set(["FAILURE", "ERROR", "CANCELLED", "TIMED_OUT", "ACTION_REQUIRED", "STARTUP_FAILURE"]);
-const PENDING = new Set(["PENDING", "EXPECTED", "QUEUED", "IN_PROGRESS", "WAITING", "REQUESTED"]);
-
-/** One word for a PR's checks: passed, failed, running or no-ci. */
-export function ciState(checks = []) {
-  if (!checks.length) return "no-ci";
-  let running = false;
-  for (const check of checks) {
-    const result = check.conclusion || check.state || "";
-    if (FAILED.has(result)) return "failed";
-    if ((check.status && check.status !== "COMPLETED") || PENDING.has(result)) running = true;
-  }
-  return running ? "running" : "passed";
-}
-
-/** Newest PR per head branch, from `gh pr list --json` output (newest first). */
-export function parsePrList(text) {
-  const prs = new Map();
-  for (const pr of JSON.parse(text)) {
-    if (prs.has(pr.headRefName)) continue;
-    prs.set(pr.headRefName, {
-      number: pr.number,
-      state: pr.state.toLowerCase(),
-      head: pr.headRefOid,
-      url: pr.url,
-      ci: pr.state === "OPEN" ? ciState(pr.statusCheckRollup) : null,
-    });
-  }
-  return prs;
-}
-
-function explain(output) {
-  if (/auth login|not logged|authentication/i.test(output)) return "gh is not logged in (run gh auth login)";
-  if (/none of the git remotes|not a git repository|no git remotes/i.test(output)) return null;
-  return `gh failed: ${output.split(/\r?\n/)[0] || "no output"}`;
-}
-
-/**
- * PRs of a repository from GitHub, keyed by branch, through the gh CLI.
- * Resolves to { prs } or { error } (null error: the repository is not on GitHub).
- */
-export function githubPrs(repoPath, env = process.env) {
-  const gh = which("gh", env);
-  if (!gh) return Promise.resolve({ error: "gh is not installed" });
-  const fields = "number,state,headRefName,headRefOid,url,statusCheckRollup";
-  return new Promise((done) => {
-    const child = spawn(gh, ["pr", "list", "--state", "all", "--limit", "200", "--json", fields], {
-      cwd: repoPath,
-      env: { ...env, GH_PROMPT_DISABLED: "1", NO_COLOR: "1" },
-      windowsHide: true,
-    });
-    let out = "";
-    let err = "";
-    const timer = setTimeout(() => child.kill(), 20000);
-    child.stdout.on("data", (chunk) => (out += chunk));
-    child.stderr.on("data", (chunk) => (err += chunk));
-    child.on("error", (error) => {
-      clearTimeout(timer);
-      done({ error: `gh failed: ${error.message}` });
-    });
-    child.on("close", (code, signal) => {
-      clearTimeout(timer);
-      if (signal) return done({ error: "gh timed out" });
-      if (code !== 0) return done({ error: explain(err.trim()) });
-      try {
-        done({ prs: parsePrList(out) });
-      } catch {
-        done({ error: "gh returned output nk could not read" });
-      }
-    });
-  });
-}
+import spawn from "cross-spawn";
+import { which } from "./agents.mjs";
+
+const FAILED = new Set(["FAILURE", "ERROR", "CANCELLED", "TIMED_OUT", "ACTION_REQUIRED", "STARTUP_FAILURE"]);
+const PENDING = new Set(["PENDING", "EXPECTED", "QUEUED", "IN_PROGRESS", "WAITING", "REQUESTED"]);
+
+/** One word for a PR's checks: passed, failed, running or no-ci. */
+export function ciState(checks = []) {
+  if (!checks.length) return "no-ci";
+  let running = false;
+  for (const check of checks) {
+    const result = check.conclusion || check.state || "";
+    if (FAILED.has(result)) return "failed";
+    if ((check.status && check.status !== "COMPLETED") || PENDING.has(result)) running = true;
+  }
+  return running ? "running" : "passed";
+}
+
+/** Newest PR per head branch, from `gh pr list --json` output (newest first). */
+export function parsePrList(text) {
+  const prs = new Map();
+  for (const pr of JSON.parse(text)) {
+    if (prs.has(pr.headRefName)) continue;
+    prs.set(pr.headRefName, {
+      number: pr.number,
+      state: pr.state.toLowerCase(),
+      head: pr.headRefOid,
+      url: pr.url,
+      ci: pr.state === "OPEN" ? ciState(pr.statusCheckRollup) : null,
+    });
+  }
+  return prs;
+}
+
+function explain(output) {
+  if (/auth login|not logged|authentication/i.test(output)) return "gh is not logged in (run gh auth login)";
+  if (/none of the git remotes|not a git repository|no git remotes/i.test(output)) return null;
+  return `gh failed: ${output.split(/\r?\n/)[0] || "no output"}`;
+}
+
+/**
+ * PRs of a repository from GitHub, keyed by branch, through the gh CLI.
+ * Resolves to { prs } or { error } (null error: the repository is not on GitHub).
+ */
+export function githubPrs(repoPath, env = process.env) {
+  const gh = which("gh", env);
+  if (!gh) return Promise.resolve({ error: "gh is not installed" });
+  const fields = "number,state,headRefName,headRefOid,url,statusCheckRollup";
+  return new Promise((done) => {
+    const child = spawn(gh, ["pr", "list", "--state", "all", "--limit", "200", "--json", fields], {
+      cwd: repoPath,
+      env: { ...env, GH_PROMPT_DISABLED: "1", NO_COLOR: "1" },
+      windowsHide: true,
+    });
+    let out = "";
+    let err = "";
+    const timer = setTimeout(() => child.kill(), 20000);
+    child.stdout.on("data", (chunk) => (out += chunk));
+    child.stderr.on("data", (chunk) => (err += chunk));
+    child.on("error", (error) => {
+      clearTimeout(timer);
+      done({ error: `gh failed: ${error.message}` });
+    });
+    child.on("close", (code, signal) => {
+      clearTimeout(timer);
+      if (signal) return done({ error: "gh timed out" });
+      if (code !== 0) return done({ error: explain(err.trim()) });
+      try {
+        done({ prs: parsePrList(out) });
+      } catch {
+        done({ error: "gh returned output nk could not read" });
+      }
+    });
+  });
+}