@ree-auz/nook 0.1.0 → 0.1.2

package/src/git.mjs

@@ -1,86 +1,86 @@
-import { spawnSync } from "node:child_process";
-import { resolve } from "node:path";
-import { NookError } from "./errors.mjs";
-
-export function gitTry(args, { cwd, input } = {}) {
-  const result = spawnSync("git", args, {
-    cwd,
-    input,
-    encoding: "utf8",
-    maxBuffer: 256 * 1024 * 1024,
-    windowsHide: true,
-  });
-  if (result.error) throw new NookError(`Cannot run git: ${result.error.message}`);
-  return { ok: result.status === 0, status: result.status, out: result.stdout.trimEnd(), err: result.stderr.trim() };
-}
-
-export function git(args, options) {
-  const result = gitTry(args, options);
-  if (!result.ok) throw new NookError(`git ${args.join(" ")} failed: ${result.err || `exit ${result.status}`}`);
-  return result.out;
-}
-
-/** Parses `git worktree list --porcelain`. The first entry is the main worktree. */
-export function listWorktrees(repo) {
-  const out = git(["worktree", "list", "--porcelain"], { cwd: repo });
-  const items = [];
-  let current = null;
-  for (const line of out.split(/\r?\n/)) {
-    if (line.startsWith("worktree ")) {
-      current = { path: resolve(line.slice(9)), branch: null, head: null, bare: false, locked: false };
-      items.push(current);
-    } else if (current && line.startsWith("HEAD ")) current.head = line.slice(5);
-    else if (current && line.startsWith("branch ")) current.branch = line.slice(7).replace(/^refs\/heads\//, "");
-    else if (current && line === "bare") current.bare = true;
-    else if (current && (line === "locked" || line.startsWith("locked "))) current.locked = true;
-  }
-  return items;
-}
-
-/** The main worktree of the repository that contains `cwd`. */
-export function mainWorktree(cwd) {
-  const inside = gitTry(["rev-parse", "--is-inside-work-tree"], { cwd });
-  if (!inside.ok || inside.out !== "true") throw new NookError("Not inside a git repository");
-  const [main] = listWorktrees(cwd);
-  if (!main || main.bare) throw new NookError("Bare repositories are not supported");
-  return main.path;
-}
-
-export function remoteUrl(repo, remote = "origin") {
-  const result = gitTry(["remote", "get-url", remote], { cwd: repo });
-  return result.ok ? result.out : "";
-}
-
-export function refExists(repo, ref) {
-  return gitTry(["show-ref", "--verify", "--quiet", ref], { cwd: repo }).ok;
-}
-
-export function defaultBranch(repo) {
-  const head = gitTry(["symbolic-ref", "--short", "refs/remotes/origin/HEAD"], { cwd: repo });
-  if (head.ok && head.out) return head.out.replace(/^origin\//, "");
-  const current = gitTry(["symbolic-ref", "--short", "HEAD"], { cwd: repo });
-  if (current.ok && current.out) return current.out;
-  return "main";
-}
-
-/** The ref new workspaces start from: origin/<default> when it exists, else <default>. */
-export function baseRef(repo, branch) {
-  return refExists(repo, `refs/remotes/origin/${branch}`) ? `origin/${branch}` : branch;
-}
-
-export function statusLines(path) {
-  const out = git(["status", "--porcelain", "--untracked-files=all"], { cwd: path });
-  return out ? out.split(/\r?\n/) : [];
-}
-
-/** Which of `paths` (relative to cwd) git ignores. */
-export function ignoredPaths(cwd, paths) {
-  if (!paths.length) return new Set();
-  const result = gitTry(["check-ignore", "-z", "--stdin"], { cwd, input: paths.join("\0") + "\0" });
-  if (!result.ok && result.status !== 1) throw new NookError(`git check-ignore failed: ${result.err}`);
-  return new Set(result.out.split("\0").filter(Boolean));
-}
-
-export function isTracked(cwd, path) {
-  return gitTry(["ls-files", "--error-unmatch", "--", path], { cwd }).ok;
-}
+import { spawnSync } from "node:child_process";
+import { resolve } from "node:path";
+import { NookError } from "./errors.mjs";
+
+export function gitTry(args, { cwd, input } = {}) {
+  const result = spawnSync("git", args, {
+    cwd,
+    input,
+    encoding: "utf8",
+    maxBuffer: 256 * 1024 * 1024,
+    windowsHide: true,
+  });
+  if (result.error) throw new NookError(`Cannot run git: ${result.error.message}`);
+  return { ok: result.status === 0, status: result.status, out: result.stdout.trimEnd(), err: result.stderr.trim() };
+}
+
+export function git(args, options) {
+  const result = gitTry(args, options);
+  if (!result.ok) throw new NookError(`git ${args.join(" ")} failed: ${result.err || `exit ${result.status}`}`);
+  return result.out;
+}
+
+/** Parses `git worktree list --porcelain`. The first entry is the main worktree. */
+export function listWorktrees(repo) {
+  const out = git(["worktree", "list", "--porcelain"], { cwd: repo });
+  const items = [];
+  let current = null;
+  for (const line of out.split(/\r?\n/)) {
+    if (line.startsWith("worktree ")) {
+      current = { path: resolve(line.slice(9)), branch: null, head: null, bare: false, locked: false };
+      items.push(current);
+    } else if (current && line.startsWith("HEAD ")) current.head = line.slice(5);
+    else if (current && line.startsWith("branch ")) current.branch = line.slice(7).replace(/^refs\/heads\//, "");
+    else if (current && line === "bare") current.bare = true;
+    else if (current && (line === "locked" || line.startsWith("locked "))) current.locked = true;
+  }
+  return items;
+}
+
+/** The main worktree of the repository that contains `cwd`. */
+export function mainWorktree(cwd) {
+  const inside = gitTry(["rev-parse", "--is-inside-work-tree"], { cwd });
+  if (!inside.ok || inside.out !== "true") throw new NookError("Not inside a git repository");
+  const [main] = listWorktrees(cwd);
+  if (!main || main.bare) throw new NookError("Bare repositories are not supported");
+  return main.path;
+}
+
+export function remoteUrl(repo, remote = "origin") {
+  const result = gitTry(["remote", "get-url", remote], { cwd: repo });
+  return result.ok ? result.out : "";
+}
+
+export function refExists(repo, ref) {
+  return gitTry(["show-ref", "--verify", "--quiet", ref], { cwd: repo }).ok;
+}
+
+export function defaultBranch(repo) {
+  const head = gitTry(["symbolic-ref", "--short", "refs/remotes/origin/HEAD"], { cwd: repo });
+  if (head.ok && head.out) return head.out.replace(/^origin\//, "");
+  const current = gitTry(["symbolic-ref", "--short", "HEAD"], { cwd: repo });
+  if (current.ok && current.out) return current.out;
+  return "main";
+}
+
+/** The ref new workspaces start from: origin/<default> when it exists, else <default>. */
+export function baseRef(repo, branch) {
+  return refExists(repo, `refs/remotes/origin/${branch}`) ? `origin/${branch}` : branch;
+}
+
+export function statusLines(path) {
+  const out = git(["status", "--porcelain", "--untracked-files=all"], { cwd: path });
+  return out ? out.split(/\r?\n/) : [];
+}
+
+/** Which of `paths` (relative to cwd) git ignores. */
+export function ignoredPaths(cwd, paths) {
+  if (!paths.length) return new Set();
+  const result = gitTry(["check-ignore", "-z", "--stdin"], { cwd, input: paths.join("\0") + "\0" });
+  if (!result.ok && result.status !== 1) throw new NookError(`git check-ignore failed: ${result.err}`);
+  return new Set(result.out.split("\0").filter(Boolean));
+}
+
+export function isTracked(cwd, path) {
+  return gitTry(["ls-files", "--error-unmatch", "--", path], { cwd }).ok;
+}

package/src/home.mjs

@@ -1,48 +1,48 @@
-import { existsSync, realpathSync } from "node:fs";
-import { homedir } from "node:os";
-import { join, relative, resolve, isAbsolute } from "node:path";
-
-/** Nook keeps everything in one folder. Only NOOK_HOME can move it. */
-export function nookHome(env = process.env) {
-  return resolve(env.NOOK_HOME || join(homedir(), "nook"));
-}
-
-export function homePaths(home) {
-  return {
-    home,
-    config: join(home, "config.toml"),
-    workspaces: join(home, "workspace"),
-    shared: join(home, "shared"),
-    backup: join(home, "backup"),
-    logs: join(home, "logs"),
-  };
-}
-
-/** Resolves symlinks (macOS /var -> /private/var) when the path exists. */
-export function realPath(path) {
-  const full = resolve(path);
-  try {
-    return realpathSync.native(full);
-  } catch {
-    return full;
-  }
-}
-
-function comparable(path, platform) {
-  const full = realPath(path);
-  return platform === "win32" ? full.toLowerCase() : full;
-}
-
-export function samePath(a, b, platform = process.platform) {
-  return comparable(a, platform) === comparable(b, platform);
-}
-
-/** True when `child` is `parent` or anywhere below it. */
-export function isInside(child, parent, platform = process.platform) {
-  const rel = relative(comparable(parent, platform), comparable(child, platform));
-  return rel === "" || (!rel.startsWith("..") && !isAbsolute(rel));
-}
-
-export function exists(path) {
-  return existsSync(path);
-}
+import { existsSync, realpathSync } from "node:fs";
+import { homedir } from "node:os";
+import { join, relative, resolve, isAbsolute } from "node:path";
+
+/** Nook keeps everything in one folder. Only NOOK_HOME can move it. */
+export function nookHome(env = process.env) {
+  return resolve(env.NOOK_HOME || join(homedir(), "nook"));
+}
+
+export function homePaths(home) {
+  return {
+    home,
+    config: join(home, "config.toml"),
+    workspaces: join(home, "workspace"),
+    shared: join(home, "shared"),
+    backup: join(home, "backup"),
+    logs: join(home, "logs"),
+  };
+}
+
+/** Resolves symlinks (macOS /var -> /private/var) when the path exists. */
+export function realPath(path) {
+  const full = resolve(path);
+  try {
+    return realpathSync.native(full);
+  } catch {
+    return full;
+  }
+}
+
+function comparable(path, platform) {
+  const full = realPath(path);
+  return platform === "win32" ? full.toLowerCase() : full;
+}
+
+export function samePath(a, b, platform = process.platform) {
+  return comparable(a, platform) === comparable(b, platform);
+}
+
+/** True when `child` is `parent` or anywhere below it. */
+export function isInside(child, parent, platform = process.platform) {
+  const rel = relative(comparable(parent, platform), comparable(child, platform));
+  return rel === "" || (!rel.startsWith("..") && !isAbsolute(rel));
+}
+
+export function exists(path) {
+  return existsSync(path);
+}

package/src/hooks.mjs

@@ -1,135 +1,135 @@
-import { createHash } from "node:crypto";
-import { createWriteStream, mkdirSync, readdirSync, readFileSync } from "node:fs";
-import { dirname, join } from "node:path";
-import spawn from "cross-spawn";
-import { which } from "./agents.mjs";
-import { NookError } from "./errors.mjs";
-import { line, useColor, indenter } from "./ui.mjs";
-
-export const HOOK_EVENTS = ["create", "open", "remove"];
-
-/** Extensions tried for a hook, in order. Platform scripts first, then portable ones. */
-export function hookExtensions(platform = process.platform) {
-  return platform === "win32" ? [".ps1", ".cmd", ".mjs", ".py"] : [".sh", ".mjs", ".py"];
-}
-
-/** Every hook in `<dir>/.nook/` for this platform. */
-export function findHooks(dir, platform = process.platform) {
-  return HOOK_EVENTS.map((event) => findHook(dir, event, platform)).filter(Boolean);
-}
-
-/** The hook file for `event` in `<dir>/.nook/`, or null. */
-export function findHook(dir, event, platform = process.platform) {
-  let entries;
-  try {
-    entries = readdirSync(join(dir, ".nook"));
-  } catch {
-    return null;
-  }
-  for (const ext of hookExtensions(platform)) {
-    const name = event + ext;
-    if (entries.includes(name)) return { event, ext, name, file: join(dir, ".nook", name) };
-  }
-  return null;
-}
-
-/**
- * Fingerprint of a hook's content. Line endings are normalized, so a Windows
- * checkout (CRLF) and the same file with LF count as one version.
- */
-export function hookHash(file) {
-  const text = readFileSync(file, "latin1").replace(/\r\n/g, "\n");
-  return createHash("sha256").update(text, "latin1").digest("hex");
-}
-
-/** How to run a hook file: { command, args }. */
-export function hookCommand(hook, { platform = process.platform, find = which } = {}) {
-  switch (hook.ext) {
-    case ".ps1": {
-      const shell = find("pwsh") ?? (platform === "win32" ? "powershell.exe" : "pwsh");
-      return { command: shell, args: ["-NoProfile", "-NonInteractive", "-ExecutionPolicy", "Bypass", "-File", hook.file] };
-    }
-    case ".cmd":
-      return { command: hook.file, args: [] };
-    case ".sh":
-      return { command: find("bash") ?? "sh", args: [hook.file] };
-    case ".mjs":
-      return { command: process.execPath, args: [hook.file] };
-    case ".py": {
-      const python = find("python3") ?? find("python") ?? "python3";
-      return { command: python, args: [hook.file] };
-    }
-    default:
-      throw new NookError(`Unknown hook type: ${hook.name}`);
-  }
-}
-
-/** "trusted", "new" or "changed" for a hook of a repository. */
-export function trustState(repoConfig, hook) {
-  const saved = repoConfig.hooks?.[hook.name];
-  if (!saved) return "new";
-  return saved === hookHash(hook.file) ? "trusted" : "changed";
-}
-
-/**
- * Asks once before hooks run for the first time, and again after one changes,
- * listing every such hook of the repository (like worktrunk's approval prompt).
- * The file contents are not printed; the paths say where to read them.
- * `ui` is the command context (warn, info, item, note). Calls `save` after a yes.
- */
-export async function ensureTrusted({ repoName, repoConfig, hooks, prompter, save, ui }) {
-  const pending = hooks.filter((hook) => trustState(repoConfig, hook) !== "trusted");
-  if (!pending.length) return;
-  const changed = pending.some((hook) => trustState(repoConfig, hook) === "changed");
-  const count = pending.length === 1 ? "1 hook" : `${pending.length} hooks`;
-  ui.warn(`${repoName} needs approval to run ${count}${changed ? " (changed since you allowed them)" : ""}:`);
-  for (const hook of pending)
-    ui.item(`${hook.event}: .nook/${hook.name}${trustState(repoConfig, hook) === "changed" ? " (changed)" : ""}`);
-  ui.info(`Read them in ${dirname(pending[0].file)}`);
-  let ok;
-  try {
-    ok = await prompter.confirm("Allow and remember?", false);
-  } catch {
-    throw new NookError(`Hooks of ${repoName} need your OK. Run nk in a terminal once, or nk init --allow-hooks after reading them`);
-  }
-  if (!ok) throw new NookError("Hooks were not allowed; nothing ran. Allow them by answering yes in a terminal, or with nk init --allow-hooks after reading them");
-  repoConfig.hooks ??= {};
-  for (const hook of pending) repoConfig.hooks[hook.name] = hookHash(hook.file);
-  save();
-}
-
-function stamp(date = new Date()) {
-  const pad = (n) => String(n).padStart(2, "0");
-  return `${date.getFullYear()}${pad(date.getMonth() + 1)}${pad(date.getDate())}-${pad(date.getHours())}${pad(date.getMinutes())}${pad(date.getSeconds())}`;
-}
-
-/**
- * Runs a hook in the workspace. Output goes to the terminal and to a log file.
- * Resolves to { status, log }.
- */
-export function runHook(hook, { cwd, env, logsDir, label, output = process.stderr }) {
-  mkdirSync(logsDir, { recursive: true });
-  const log = join(logsDir, `${label}-${hook.event}-${stamp()}.log`);
-  const stream = createWriteStream(log);
-  const { command, args } = hookCommand(hook);
-  output.write(`${line("step", `Running ${hook.event} hook .nook/${hook.name}`, useColor(output))}\n`);
-  return new Promise((done) => {
-    const child = spawn(command, args, { cwd, env, stdio: ["inherit", "pipe", "pipe"], windowsHide: true });
-    // Indented under the "Running … hook" line; the log keeps the output as it was.
-    const forward = (indent) => (chunk) => {
-      stream.write(chunk);
-      output.write(indent(chunk));
-    };
-    child.stdout.on("data", forward(indenter()));
-    child.stderr.on("data", forward(indenter()));
-    let finished = false;
-    const finish = (status, error) => {
-      if (finished) return;
-      finished = true;
-      if (error) stream.write(`\n${error.message}\n`);
-      stream.end(() => done({ status, log }));
-    };
-    child.on("error", (error) => finish(127, error));
-    child.on("close", (code, signal) => finish(code ?? (signal ? 1 : 0)));
-  });
-}
+import { createHash } from "node:crypto";
+import { createWriteStream, mkdirSync, readdirSync, readFileSync } from "node:fs";
+import { dirname, join } from "node:path";
+import spawn from "cross-spawn";
+import { which } from "./agents.mjs";
+import { NookError } from "./errors.mjs";
+import { line, useColor, indenter } from "./ui.mjs";
+
+export const HOOK_EVENTS = ["create", "open", "remove"];
+
+/** Extensions tried for a hook, in order. Platform scripts first, then portable ones. */
+export function hookExtensions(platform = process.platform) {
+  return platform === "win32" ? [".ps1", ".cmd", ".mjs", ".py"] : [".sh", ".mjs", ".py"];
+}
+
+/** Every hook in `<dir>/.nook/` for this platform. */
+export function findHooks(dir, platform = process.platform) {
+  return HOOK_EVENTS.map((event) => findHook(dir, event, platform)).filter(Boolean);
+}
+
+/** The hook file for `event` in `<dir>/.nook/`, or null. */
+export function findHook(dir, event, platform = process.platform) {
+  let entries;
+  try {
+    entries = readdirSync(join(dir, ".nook"));
+  } catch {
+    return null;
+  }
+  for (const ext of hookExtensions(platform)) {
+    const name = event + ext;
+    if (entries.includes(name)) return { event, ext, name, file: join(dir, ".nook", name) };
+  }
+  return null;
+}
+
+/**
+ * Fingerprint of a hook's content. Line endings are normalized, so a Windows
+ * checkout (CRLF) and the same file with LF count as one version.
+ */
+export function hookHash(file) {
+  const text = readFileSync(file, "latin1").replace(/\r\n/g, "\n");
+  return createHash("sha256").update(text, "latin1").digest("hex");
+}
+
+/** How to run a hook file: { command, args }. */
+export function hookCommand(hook, { platform = process.platform, find = which } = {}) {
+  switch (hook.ext) {
+    case ".ps1": {
+      const shell = find("pwsh") ?? (platform === "win32" ? "powershell.exe" : "pwsh");
+      return { command: shell, args: ["-NoProfile", "-NonInteractive", "-ExecutionPolicy", "Bypass", "-File", hook.file] };
+    }
+    case ".cmd":
+      return { command: hook.file, args: [] };
+    case ".sh":
+      return { command: find("bash") ?? "sh", args: [hook.file] };
+    case ".mjs":
+      return { command: process.execPath, args: [hook.file] };
+    case ".py": {
+      const python = find("python3") ?? find("python") ?? "python3";
+      return { command: python, args: [hook.file] };
+    }
+    default:
+      throw new NookError(`Unknown hook type: ${hook.name}`);
+  }
+}
+
+/** "trusted", "new" or "changed" for a hook of a repository. */
+export function trustState(repoConfig, hook) {
+  const saved = repoConfig.hooks?.[hook.name];
+  if (!saved) return "new";
+  return saved === hookHash(hook.file) ? "trusted" : "changed";
+}
+
+/**
+ * Asks once before hooks run for the first time, and again after one changes,
+ * listing every such hook of the repository (like worktrunk's approval prompt).
+ * The file contents are not printed; the paths say where to read them.
+ * `ui` is the command context (warn, info, item, note). Calls `save` after a yes.
+ */
+export async function ensureTrusted({ repoName, repoConfig, hooks, prompter, save, ui }) {
+  const pending = hooks.filter((hook) => trustState(repoConfig, hook) !== "trusted");
+  if (!pending.length) return;
+  const changed = pending.some((hook) => trustState(repoConfig, hook) === "changed");
+  const count = pending.length === 1 ? "1 hook" : `${pending.length} hooks`;
+  ui.warn(`${repoName} needs approval to run ${count}${changed ? " (changed since you allowed them)" : ""}:`);
+  for (const hook of pending)
+    ui.item(`${hook.event}: .nook/${hook.name}${trustState(repoConfig, hook) === "changed" ? " (changed)" : ""}`);
+  ui.info(`Read them in ${dirname(pending[0].file)}`);
+  let ok;
+  try {
+    ok = await prompter.confirm("Allow and remember?", false);
+  } catch {
+    throw new NookError(`Hooks of ${repoName} need your OK. Run nk in a terminal once, or nk init --allow-hooks after reading them`);
+  }
+  if (!ok) throw new NookError("Hooks were not allowed; nothing ran. Allow them by answering yes in a terminal, or with nk init --allow-hooks after reading them");
+  repoConfig.hooks ??= {};
+  for (const hook of pending) repoConfig.hooks[hook.name] = hookHash(hook.file);
+  save();
+}
+
+function stamp(date = new Date()) {
+  const pad = (n) => String(n).padStart(2, "0");
+  return `${date.getFullYear()}${pad(date.getMonth() + 1)}${pad(date.getDate())}-${pad(date.getHours())}${pad(date.getMinutes())}${pad(date.getSeconds())}`;
+}
+
+/**
+ * Runs a hook in the workspace. Output goes to the terminal and to a log file.
+ * Resolves to { status, log }.
+ */
+export function runHook(hook, { cwd, env, logsDir, label, output = process.stderr }) {
+  mkdirSync(logsDir, { recursive: true });
+  const log = join(logsDir, `${label}-${hook.event}-${stamp()}.log`);
+  const stream = createWriteStream(log);
+  const { command, args } = hookCommand(hook);
+  output.write(`${line("step", `Running ${hook.event} hook .nook/${hook.name}`, useColor(output))}\n`);
+  return new Promise((done) => {
+    const child = spawn(command, args, { cwd, env, stdio: ["inherit", "pipe", "pipe"], windowsHide: true });
+    // Indented under the "Running … hook" line; the log keeps the output as it was.
+    const forward = (indent) => (chunk) => {
+      stream.write(chunk);
+      output.write(indent(chunk));
+    };
+    child.stdout.on("data", forward(indenter()));
+    child.stderr.on("data", forward(indenter()));
+    let finished = false;
+    const finish = (status, error) => {
+      if (finished) return;
+      finished = true;
+      if (error) stream.write(`\n${error.message}\n`);
+      stream.end(() => done({ status, log }));
+    };
+    child.on("error", (error) => finish(127, error));
+    child.on("close", (code, signal) => finish(code ?? (signal ? 1 : 0)));
+  });
+}