braeburn 1.5.0 → 1.5.2

package/README.md

@@ -42,6 +42,7 @@ Steps are grouped by system capability. For new setups, braeburn uses a conserva
 | `mas` | Apps & Packages | off | `mas` |
 | `macos` | Apps & Packages | off | — |
 | `npm` | CLI Tools | on | `npm` |
+| `braeburn` | CLI Tools | on | `npm` |
 | `pip` | CLI Tools | on | `pip3` |
 | `dotnet` | CLI Tools | on | `dotnet` |
 | `ohmyzsh` | Shell | off | `~/.oh-my-zsh` |

package/dist/commands/update.js

@@ -1,14 +1,54 @@
+import readline from "node:readline";
 import { collectVersions } from "../update/versionCollector.js";
 import { captureYesNo } from "../ui/prompt.js";
 import { buildScreen, buildScreenWithAnimationFrame, createScreenRenderer } from "../ui/screen.js";
 import { hideCursorDuringExecution } from "../ui/terminal.js";
 import { runUpdateEngine } from "../update/engine.js";
+import { cancelActiveShellCommand } from "../runner.js";
+function shouldCaptureRuntimeAbortKey(state) {
+    return state?.currentPhase === "running" || state?.currentPhase === "installing";
+}
 export async function runUpdateCommand(options) {
     const renderScreen = createScreenRenderer();
     const restoreCursor = hideCursorDuringExecution({ screenBuffer: "alternate" });
     let finalScreen = "";
     let latestState = undefined;
+    let runtimeAbortKeyCaptureEnabled = false;
     let animationFrameIndex = 0;
+    const handleRuntimeKeypress = (typedCharacter, key) => {
+        if (key?.ctrl && key?.name === "c") {
+            process.stdout.write("\x1b[?25h\n");
+            process.exit(130);
+        }
+        const isQuitRequest = typedCharacter === "q" || typedCharacter === "Q";
+        if (!isQuitRequest) {
+            return;
+        }
+        cancelActiveShellCommand();
+    };
+    const enableRuntimeAbortKeyCapture = () => {
+        if (runtimeAbortKeyCaptureEnabled) {
+            return;
+        }
+        readline.emitKeypressEvents(process.stdin);
+        process.stdin.on("keypress", handleRuntimeKeypress);
+        if (process.stdin.isTTY) {
+            process.stdin.setRawMode(true);
+        }
+        process.stdin.resume();
+        runtimeAbortKeyCaptureEnabled = true;
+    };
+    const disableRuntimeAbortKeyCapture = () => {
+        if (!runtimeAbortKeyCaptureEnabled) {
+            return;
+        }
+        process.stdin.removeListener("keypress", handleRuntimeKeypress);
+        if (process.stdin.isTTY) {
+            process.stdin.setRawMode(false);
+        }
+        process.stdin.pause();
+        runtimeAbortKeyCaptureEnabled = false;
+    };
     const animationTimer = setInterval(() => {
         if (!latestState) {
             return;
@@ -32,12 +72,19 @@ export async function runUpdateCommand(options) {
             collectVersions,
             onStateChanged: (state) => {
                 latestState = state;
+                if (shouldCaptureRuntimeAbortKey(state)) {
+                    enableRuntimeAbortKeyCapture();
+                }
+                else {
+                    disableRuntimeAbortKeyCapture();
+                }
                 renderScreen(buildScreenWithAnimationFrame(state, animationFrameIndex));
             },
         });
         finalScreen = buildScreen(finalState);
     }
     finally {
+        disableRuntimeAbortKeyCapture();
         clearInterval(animationTimer);
         restoreCursor();
     }

package/dist/config.js

@@ -4,7 +4,7 @@ import { homedir } from "node:os";
 import { parse, stringify } from "smol-toml";
 export const PROTECTED_STEP_IDS = new Set(["homebrew"]);
 export const LEGACY_DEFAULT_OFF_STEP_IDS = new Set(["nvm", "pyenv"]);
-export const CONSERVATIVE_DEFAULT_ON_STEP_IDS = new Set(["homebrew", "npm", "pip", "dotnet"]);
+export const CONSERVATIVE_DEFAULT_ON_STEP_IDS = new Set(["homebrew", "npm", "braeburn", "pip", "dotnet"]);
 const EMPTY_CONFIG = { steps: {} };
 const LOGO_SETTING_ID = "logo";
 const DEFAULTS_PROFILE_SETTING_ID = "defaultsProfile";

package/dist/index.js

@@ -39,6 +39,7 @@ Step descriptions:
 
   System / CLI Tools:
   npm        Update global npm packages  (requires: npm)
+  braeburn   Update braeburn CLI itself  (requires: npm)
   pip        Update global pip3 packages (requires: pip3) ⚠ may be fragile
   dotnet     Update .NET global tools    (requires: dotnet)
 
@@ -84,6 +85,7 @@ program
     .option("--mas", "Show latest Mac App Store log")
     .option("--ohmyzsh", "Show latest Oh My Zsh log")
     .option("--npm", "Show latest npm log")
+    .option("--braeburn", "Show latest braeburn log")
     .option("--pip", "Show latest pip3 log")
     .option("--pyenv", "Show latest pyenv log")
     .option("--nvm", "Show latest nvm log")

package/dist/runner.d.ts

@@ -10,6 +10,12 @@ type RunCommandOptions = {
     onOutputLine: OutputLineCallback;
     logWriter: StepLogWriter;
 };
+export declare class ShellCommandCanceledError extends Error {
+    readonly shellCommand: string;
+    readonly originalError: unknown;
+    constructor(shellCommand: string, originalError: unknown);
+}
+export declare function cancelActiveShellCommand(): boolean;
 export declare function runShellCommand(options: RunCommandOptions): Promise<void>;
 type CheckCommandOptions = {
     shellCommand: string;

package/dist/runner.js

@@ -1,5 +1,25 @@
 import { execa } from "execa";
 const FAILURE_OUTPUT_TAIL_LINE_LIMIT = 20;
+let activeShellCommandSubprocess;
+const userCanceledSubprocesses = new WeakSet();
+export class ShellCommandCanceledError extends Error {
+    shellCommand;
+    originalError;
+    constructor(shellCommand, originalError) {
+        super(`Command canceled by user: ${shellCommand}`);
+        this.name = "ShellCommandCanceledError";
+        this.shellCommand = shellCommand;
+        this.originalError = originalError;
+    }
+}
+export function cancelActiveShellCommand() {
+    if (!activeShellCommandSubprocess) {
+        return false;
+    }
+    userCanceledSubprocesses.add(activeShellCommandSubprocess);
+    activeShellCommandSubprocess.kill("SIGTERM");
+    return true;
+}
 function splitNonEmptyLines(text) {
     if (!text) {
         return [];
@@ -45,6 +65,7 @@ export async function runShellCommand(options) {
         all: true,
         reject: true,
     });
+    activeShellCommandSubprocess = subprocess;
     subprocess.stdout?.on("data", (chunk) => {
         const lines = String(chunk).split(/\r?\n|\r/).filter(Boolean);
         for (const line of lines) {
@@ -63,12 +84,24 @@ export async function runShellCommand(options) {
         await subprocess;
     }
     catch (error) {
+        const commandWasCanceledByUser = userCanceledSubprocesses.has(subprocess);
         const failureSummaryLines = buildFailureSummaryLines(options.shellCommand, error);
+        if (commandWasCanceledByUser) {
+            failureSummaryLines.push("[braeburn] Command canceled by user input (q).");
+        }
         for (const line of failureSummaryLines) {
             await options.logWriter(line);
         }
+        if (commandWasCanceledByUser) {
+            throw new ShellCommandCanceledError(options.shellCommand, error);
+        }
         throw error;
     }
+    finally {
+        if (activeShellCommandSubprocess === subprocess) {
+            activeShellCommandSubprocess = undefined;
+        }
+    }
 }
 export async function doesShellCommandSucceed(options) {
     const result = await execa("bash", ["-c", options.shellCommand], {

package/dist/steps/braeburn.d.ts

@@ -0,0 +1,3 @@
+import type { Step } from "./types.js";
+declare const braeburnStep: Step;
+export default braeburnStep;

package/dist/steps/braeburn.js

@@ -0,0 +1,14 @@
+import { checkCommandExists } from "./runtime.js";
+const braeburnStep = {
+    id: "braeburn",
+    name: "braeburn",
+    categoryId: "cli-tools",
+    description: "Update the braeburn CLI to the latest npm release",
+    async checkIsAvailable() {
+        return checkCommandExists("npm");
+    },
+    async run(context) {
+        await context.runStep("npm install -g braeburn@latest");
+    },
+};
+export default braeburnStep;

package/dist/steps/catalog.js

@@ -1,4 +1,4 @@
-import { pyenvStep, nvmStep, homebrewStep, masStep, ohmyzshStep, npmStep, pipStep, dotnetStep, macosStep, cleanupStep, } from "./index.js";
+import { pyenvStep, nvmStep, homebrewStep, masStep, ohmyzshStep, npmStep, pipStep, dotnetStep, macosStep, cleanupStep, braeburnStep, } from "./index.js";
 const STEP_BY_ID = {
     pyenv: pyenvStep,
     nvm: nvmStep,
@@ -10,6 +10,7 @@ const STEP_BY_ID = {
     dotnet: dotnetStep,
     ohmyzsh: ohmyzshStep,
     cleanup: cleanupStep,
+    braeburn: braeburnStep,
 };
 const STEP_EXECUTION_ORDER = [
     "pyenv",
@@ -18,6 +19,7 @@ const STEP_EXECUTION_ORDER = [
     "mas",
     "macos",
     "npm",
+    "braeburn",
     "pip",
     "dotnet",
     "ohmyzsh",

package/dist/steps/index.d.ts

@@ -14,3 +14,4 @@ export { default as nvmStep } from "./nvm.js";
 export { default as dotnetStep } from "./dotnet.js";
 export { default as macosStep } from "./macos.js";
 export { default as cleanupStep } from "./cleanup.js";
+export { default as braeburnStep } from "./braeburn.js";

package/dist/steps/index.js

@@ -11,3 +11,4 @@ export { default as nvmStep } from "./nvm.js";
 export { default as dotnetStep } from "./dotnet.js";
 export { default as macosStep } from "./macos.js";
 export { default as cleanupStep } from "./cleanup.js";
+export { default as braeburnStep } from "./braeburn.js";

package/dist/ui/currentStep.js

@@ -11,7 +11,9 @@ export function buildActiveStepLines(options) {
         `  ${chalk.dim("·")} ${chalk.dim.italic(step.description)}`,
     ];
     if (isRunning) {
-        const label = phase === "installing" ? "Installing..." : "Running...";
+        const label = phase === "installing"
+            ? "Installing... press q to end this step"
+            : "Running... press q to end this step";
         lines.push(`  ${chalk.blue(getActivityIndicatorFrame(activityFrameIndex))} ${label}`);
     }
     return lines;

package/dist/ui/header.js

@@ -21,7 +21,9 @@ export function stepTrackerIcon(phase, activityFrameIndex = 0) {
         return chalk.green("✓ ");
     if (phase === "failed")
         return chalk.red("✗ ");
-    if (phase === "skipped" || phase === "not-available")
+    if (phase === "skipped")
+        return chalk.yellow("↷ ");
+    if (phase === "not-available")
         return chalk.dim("– ");
     if (phase === "running" || phase === "installing")
         return chalk.cyan(`${getActivityIndicatorFrame(activityFrameIndex)} `);

package/dist/ui/prompt.d.ts

@@ -1,4 +1,4 @@
 import type { CurrentPrompt } from "./state.js";
-export type YesNoForceAnswer = "yes" | "no" | "force";
+export type YesNoForceAnswer = "yes" | "no" | "skip" | "force";
 export declare function captureYesNo(): Promise<YesNoForceAnswer>;
 export declare function buildPromptLines(prompt: CurrentPrompt): string[];

package/dist/ui/prompt.js

@@ -13,8 +13,9 @@ export function captureYesNo() {
             }
             const isConfirm = character === "y" || character === "Y" || key?.name === "return";
             const isDecline = character === "n" || character === "N";
+            const isSkip = character === "s" || character === "S";
             const isForce = character === "f" || character === "F";
-            if (!isConfirm && !isDecline && !isForce)
+            if (!isConfirm && !isDecline && !isSkip && !isForce)
                 return;
             process.stdin.removeListener("keypress", handleKeypress);
             if (process.stdin.isTTY) {
@@ -23,6 +24,8 @@ export function captureYesNo() {
             process.stdin.pause();
             if (isForce)
                 resolve("force");
+            else if (isSkip)
+                resolve("skip");
             else if (isConfirm)
                 resolve("yes");
             else
@@ -38,6 +41,6 @@ export function buildPromptLines(prompt) {
         lines.push(`  ${chalk.yellow("⚠")}  ${chalk.yellow(prompt.warning)}`);
         lines.push("");
     }
-    lines.push(`  ${chalk.cyan("?")}  ${prompt.question} ${chalk.dim("[Y/n/f]")}`);
+    lines.push(`  ${chalk.cyan("?")}  ${prompt.question} ${chalk.dim("[Y/n/s/f]")}`);
     return lines;
 }

package/dist/update/engine.d.ts

@@ -3,7 +3,7 @@ import { runShellCommand } from "../runner.js";
 import { createDefaultStepRunContext, type Step } from "../steps/index.js";
 import { type LogoVisibility, type ResolvedVersion, type UpdateState } from "./state.js";
 export type PromptMode = "interactive" | "auto-accept";
-export type ConfirmationAnswer = "yes" | "no" | "force";
+export type ConfirmationAnswer = "yes" | "no" | "skip" | "force";
 type UpdateEngineDependencies = {
     createLogWriter: (stepId: string) => Promise<StepLogWriter>;
     runCommand: typeof runShellCommand;

package/dist/update/engine.js

@@ -1,5 +1,5 @@
 import { createLogWriterForStep } from "../logger.js";
-import { runShellCommand } from "../runner.js";
+import { runShellCommand, ShellCommandCanceledError } from "../runner.js";
 import { createDefaultStepRunContext } from "../steps/index.js";
 import { toDisplaySteps } from "./displayStep.js";
 import { createInitialUpdateState, } from "./state.js";
@@ -15,7 +15,7 @@ async function resolvePrompt(promptMode, askForConfirmation) {
         return { promptMode: "auto-accept", decision: "run" };
     }
     const answer = await askForConfirmation();
-    if (answer === "no") {
+    if (answer === "no" || answer === "skip") {
         return { promptMode: "interactive", decision: "skip" };
     }
     if (answer === "force") {
@@ -26,6 +26,9 @@ async function resolvePrompt(promptMode, askForConfirmation) {
 function reportState(state, onStateChanged) {
     onStateChanged(state);
 }
+function wasStepCanceledByUser(error) {
+    return error instanceof ShellCommandCanceledError;
+}
 export async function runUpdateEngine(options) {
     const dependencies = resolveDependencies(options.dependencies);
     const state = createInitialUpdateState(toDisplaySteps(options.steps), options.version, options.logoVisibility);
@@ -75,10 +78,16 @@ export async function runUpdateEngine(options) {
                     logWriter: installLogWriter,
                 });
             }
-            catch {
+            catch (error) {
+                if (wasStepCanceledByUser(error)) {
+                    promptMode = "interactive";
+                }
                 state.currentPhase = "failed";
                 reportState(state, options.onStateChanged);
-                state.completedStepRecords.push({ phase: "failed", summaryNote: "install failed" });
+                state.completedStepRecords.push({
+                    phase: "failed",
+                    summaryNote: wasStepCanceledByUser(error) ? "canceled by user" : "install failed",
+                });
                 continue;
             }
         }
@@ -109,11 +118,17 @@ export async function runUpdateEngine(options) {
             state.completedStepRecords.push({ phase: "complete", summaryNote: "updated" });
         }
         catch (error) {
+            if (wasStepCanceledByUser(error)) {
+                promptMode = "interactive";
+            }
             const errorMessage = error instanceof Error ? error.message : String(error);
             state.currentPhase = "failed";
             state.currentOutputLines = [];
             reportState(state, options.onStateChanged);
-            state.completedStepRecords.push({ phase: "failed", summaryNote: errorMessage });
+            state.completedStepRecords.push({
+                phase: "failed",
+                summaryNote: wasStepCanceledByUser(error) ? "canceled by user" : errorMessage,
+            });
         }
     }
     state.runCompletion = "finished";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braeburn",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "macOS system updater CLI",
   "type": "module",
   "bin": {