braeburn 1.4.0 → 1.4.1

package/README.md

@@ -24,7 +24,9 @@ braeburn homebrew npm # run specific steps only
 |---|---|
 | `braeburn [steps...] [-y]` | Run update steps (default) |
 | `braeburn log [step]` | View the latest output log for a step |
-| `braeburn config` | View current configuration |
+| `braeburn config` | Show config subcommand help |
+| `braeburn config list` | Print current configuration |
+| `braeburn config update` | Open interactive configuration editor |
 | `braeburn config update --no-<step>` | Disable a step |
 | `braeburn config update --<step>` | Re-enable a step |
 

package/dist/commands/config.d.ts

@@ -2,6 +2,7 @@ import { type BraeburnConfig } from "../config.js";
 import type { Step } from "../steps/index.js";
 type RunConfigCommandOptions = {
     allSteps: Step[];
+    outputMode: "interactive" | "non-interactive";
 };
 type DesiredState = "enable" | "disable";
 type RunConfigUpdateCommandOptions = {
@@ -20,4 +21,10 @@ type ConfigUpdateResult = {
 };
 export declare function applyConfigUpdates(config: BraeburnConfig, settingUpdates: Record<string, DesiredState>): ConfigUpdateResult;
 export declare function runConfigUpdateCommand(options: RunConfigUpdateCommandOptions): Promise<void>;
+type BuildConfigTableOutputOptions = {
+    config: BraeburnConfig;
+    configPath: string;
+    allSteps: Step[];
+};
+export declare function buildConfigTableOutput(options: BuildConfigTableOutputOptions): string;
 export {};

package/dist/commands/config.js

@@ -1,33 +1,22 @@
+import readline from "node:readline";
 import chalk from "chalk";
 import { readConfig, writeConfig, resolveConfigPath, isSettingEnabled, isStepEnabled, isLogoEnabled, applySettingToConfig, PROTECTED_STEP_IDS, DEFAULT_OFF_STEP_IDS, } from "../config.js";
+import { createScreenRenderer } from "../ui/screen.js";
+import { hideCursorDuringExecution } from "../ui/terminal.js";
 export async function runConfigCommand(options) {
-    const { allSteps } = options;
+    const { allSteps, outputMode } = options;
     const config = await readConfig();
     const configPath = await resolveConfigPath();
-    const STEP_COL = 12;
-    const DIVIDER = "─".repeat(STEP_COL + 16);
-    process.stdout.write(`Config: ${chalk.dim(configPath)}\n\n`);
-    process.stdout.write(`${"Step".padEnd(STEP_COL)}Status\n`);
-    process.stdout.write(`${DIVIDER}\n`);
-    const logoEnabled = isLogoEnabled(config);
-    process.stdout.write(`${"logo".padEnd(STEP_COL)}${logoEnabled ? chalk.green("enabled") : chalk.red("disabled")}\n`);
-    process.stdout.write(`${DIVIDER}\n`);
-    for (const step of allSteps) {
-        const isProtected = PROTECTED_STEP_IDS.has(step.id);
-        const enabled = isStepEnabled(config, step.id);
-        let statusText;
-        if (isProtected) {
-            statusText = chalk.dim("always enabled");
-        }
-        else if (enabled) {
-            statusText = chalk.green("enabled");
-        }
-        else {
-            statusText = chalk.red("disabled");
-        }
-        process.stdout.write(`${step.id.padEnd(STEP_COL)}${statusText}\n`);
+    if (outputMode === "non-interactive") {
+        process.stdout.write(buildConfigTableOutput({ config, configPath, allSteps }));
+        return;
+    }
+    if (!process.stdin.isTTY || !process.stdout.isTTY) {
+        process.stderr.write("Interactive mode requires a TTY. Showing non-interactive output.\n\n");
+        process.stdout.write(buildConfigTableOutput({ config, configPath, allSteps }));
+        return;
     }
-    process.stdout.write(`\n`);
+    await runInteractiveConfigView({ config, configPath, allSteps });
 }
 export function applyConfigUpdates(config, settingUpdates) {
     let updatedConfig = config;
@@ -74,6 +63,180 @@ export async function runConfigUpdateCommand(options) {
     const configPath = await resolveConfigPath();
     process.stdout.write(`\nConfig saved to ${chalk.dim(configPath)}\n`);
 }
+export function buildConfigTableOutput(options) {
+    const { config, configPath, allSteps } = options;
+    const lines = [];
+    const stepColumnWidth = 12;
+    const divider = "─".repeat(stepColumnWidth + 16);
+    lines.push(`Config: ${chalk.dim(configPath)}`);
+    lines.push("");
+    lines.push(`${"Step".padEnd(stepColumnWidth)}Status`);
+    lines.push(divider);
+    const logoEnabled = isLogoEnabled(config);
+    lines.push(`${"logo".padEnd(stepColumnWidth)}${logoEnabled ? chalk.green("enabled") : chalk.red("disabled")}`);
+    lines.push(divider);
+    for (const step of allSteps) {
+        const isProtected = PROTECTED_STEP_IDS.has(step.id);
+        const enabled = isStepEnabled(config, step.id);
+        let statusText;
+        if (isProtected) {
+            statusText = chalk.dim("always enabled");
+        }
+        else if (enabled) {
+            statusText = chalk.green("enabled");
+        }
+        else {
+            statusText = chalk.red("disabled");
+        }
+        lines.push(`${step.id.padEnd(stepColumnWidth)}${statusText}`);
+    }
+    lines.push("");
+    return lines.join("\n") + "\n";
+}
+function buildConfigViewItems(config, allSteps) {
+    const viewItems = [
+        {
+            id: "logo",
+            label: "logo",
+            description: "Show the braeburn logo in command output",
+            protection: "configurable",
+            selection: isLogoEnabled(config) ? "enabled" : "disabled",
+        },
+    ];
+    for (const step of allSteps) {
+        viewItems.push({
+            id: step.id,
+            label: step.id,
+            description: step.description,
+            protection: PROTECTED_STEP_IDS.has(step.id) ? "protected" : "configurable",
+            selection: isStepEnabled(config, step.id) ? "enabled" : "disabled",
+        });
+    }
+    return viewItems;
+}
+function buildInteractiveConfigScreen(options) {
+    const { configPath, items, cursorIndex } = options;
+    const lines = [];
+    lines.push(`Config: ${chalk.dim(configPath)}`);
+    lines.push("");
+    lines.push(`  ${chalk.dim("↑↓ navigate    Space toggle    Return save    q quit")}`);
+    lines.push("");
+    for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
+        const item = items[itemIndex];
+        const isCursor = itemIndex === cursorIndex;
+        const cursor = isCursor ? chalk.cyan("›") : " ";
+        const marker = item.selection === "enabled" ? chalk.green("●") : chalk.dim("○");
+        const label = isCursor ? chalk.bold.white(item.label.padEnd(12)) : chalk.white(item.label.padEnd(12));
+        let status;
+        if (item.protection === "protected") {
+            status = chalk.dim("always enabled");
+        }
+        else if (item.selection === "enabled") {
+            status = chalk.green("enabled");
+        }
+        else {
+            status = chalk.red("disabled");
+        }
+        lines.push(`  ${cursor} ${marker}  ${label} ${status}`);
+        if (isCursor) {
+            lines.push(`        ${chalk.dim(item.description)}`);
+        }
+    }
+    const enabledCount = items.filter((item) => item.selection === "enabled").length;
+    lines.push("");
+    lines.push(`  ${chalk.dim(`${enabledCount} of ${items.length} settings enabled`)}`);
+    lines.push("");
+    return lines.join("\n") + "\n";
+}
+async function runInteractiveConfigView(options) {
+    const { config, configPath, allSteps } = options;
+    const render = createScreenRenderer();
+    const restoreCursor = hideCursorDuringExecution({ screenBuffer: "alternate" });
+    const items = buildConfigViewItems(config, allSteps);
+    let cursorIndex = 0;
+    let completionOutput = "";
+    try {
+        render(buildInteractiveConfigScreen({ configPath, items, cursorIndex }));
+        const interactionResult = await new Promise((resolve) => {
+            readline.emitKeypressEvents(process.stdin);
+            if (process.stdin.isTTY) {
+                process.stdin.setRawMode(true);
+            }
+            const completeInteraction = (result) => {
+                process.stdin.removeListener("keypress", onKeypress);
+                if (process.stdin.isTTY) {
+                    process.stdin.setRawMode(false);
+                }
+                process.stdin.pause();
+                resolve(result);
+            };
+            const onKeypress = (_char, key) => {
+                if (key.ctrl && key.name === "c") {
+                    process.exit(130);
+                }
+                if (key.name === "up" || key.name === "k") {
+                    cursorIndex = Math.max(0, cursorIndex - 1);
+                    render(buildInteractiveConfigScreen({ configPath, items, cursorIndex }));
+                    return;
+                }
+                if (key.name === "down" || key.name === "j") {
+                    cursorIndex = Math.min(items.length - 1, cursorIndex + 1);
+                    render(buildInteractiveConfigScreen({ configPath, items, cursorIndex }));
+                    return;
+                }
+                if (key.name === "space") {
+                    const selectedItem = items[cursorIndex];
+                    if (selectedItem.protection === "configurable") {
+                        selectedItem.selection = selectedItem.selection === "enabled" ? "disabled" : "enabled";
+                        render(buildInteractiveConfigScreen({ configPath, items, cursorIndex }));
+                    }
+                    return;
+                }
+                if (key.name === "return") {
+                    completeInteraction("save");
+                    return;
+                }
+                if (key.name === "q" || key.name === "escape") {
+                    completeInteraction("cancel");
+                }
+            };
+            process.stdin.on("keypress", onKeypress);
+            process.stdin.resume();
+        });
+        if (interactionResult === "cancel") {
+            completionOutput = "No changes saved.\n";
+        }
+        else {
+            const settingUpdates = {};
+            for (const item of items) {
+                if (item.protection === "protected") {
+                    continue;
+                }
+                settingUpdates[item.id] = item.selection === "enabled" ? "enable" : "disable";
+            }
+            const { updatedConfig, changes } = applyConfigUpdates(config, settingUpdates);
+            if (changes.length === 0) {
+                completionOutput = "No changes — already set as requested.\n";
+            }
+            else {
+                await writeCleanConfig(updatedConfig);
+                const outputLines = [];
+                for (const { label, from, to } of changes) {
+                    const fromLabel = from === "enable" ? chalk.green("enabled") : chalk.red("disabled");
+                    const toLabel = to === "enable" ? chalk.green("enabled") : chalk.red("disabled");
+                    outputLines.push(`  ${label.padEnd(12)} ${fromLabel} → ${toLabel}`);
+                }
+                outputLines.push("");
+                outputLines.push(`Config saved to ${chalk.dim(configPath)}`);
+                completionOutput = `${outputLines.join("\n")}\n`;
+            }
+        }
+    }
+    finally {
+        restoreCursor();
+    }
+    process.stdout.write(completionOutput);
+}
 async function writeCleanConfig(config) {
     const cleaned = { steps: {} };
     for (const [stepId, value] of Object.entries(config.steps)) {

package/dist/index.js

@@ -103,15 +103,25 @@ Examples:
 const configCommand = program
     .command("config")
     .description("View or edit braeburn configuration")
+    .action(() => {
+    configCommand.outputHelp();
+});
+configCommand
+    .command("list")
+    .description("Print current configuration")
     .action(async () => {
-    await runConfigCommand({ allSteps: ALL_STEPS });
+    await runConfigCommand({
+        allSteps: ALL_STEPS,
+        outputMode: "non-interactive",
+    });
 });
 const configurableSteps = ALL_STEPS.filter((step) => !PROTECTED_STEP_IDS.has(step.id));
 const configUpdateCommand = configCommand
     .command("update")
-    .description("Enable or disable individual update steps")
+    .description("Edit configuration (interactive by default, flags for direct updates)")
     .addHelpText("after", `
 Examples:
+  braeburn config update                     Open interactive config editor
   braeburn config update --no-logo           Hide the logo
   braeburn config update --no-ohmyzsh        Disable Oh My Zsh updates
   braeburn config update --no-pip --no-nvm   Disable pip and nvm updates
@@ -123,7 +133,7 @@ for (const step of configurableSteps) {
     configUpdateCommand.option(`--no-${step.id}`, `Disable ${step.name} updates`);
     configUpdateCommand.option(`--${step.id}`, `Enable ${step.name} updates`);
 }
-configUpdateCommand.action(function () {
+configUpdateCommand.action(async function () {
     // Commander defaults --no-* to true, so we use getOptionValueSource to detect explicit CLI flags.
     const settingUpdates = {};
     for (const step of configurableSteps) {
@@ -136,7 +146,14 @@ configUpdateCommand.action(function () {
     if (logoSource === "cli") {
         settingUpdates["logo"] = configUpdateCommand.opts().logo ? "enable" : "disable";
     }
-    runConfigUpdateCommand({ settingUpdates, allSteps: ALL_STEPS });
+    if (Object.keys(settingUpdates).length === 0) {
+        await runConfigCommand({
+            allSteps: ALL_STEPS,
+            outputMode: "interactive",
+        });
+        return;
+    }
+    await runConfigUpdateCommand({ settingUpdates, allSteps: ALL_STEPS });
 });
 function resolveStepsByIds(stepIds) {
     const resolvedSteps = [];

package/dist/ui/screen.js

@@ -4,13 +4,8 @@ import { buildOutputBoxLines } from "./outputBox.js";
 import { buildPromptLines } from "./prompt.js";
 import { buildVersionReportLines } from "./versionReport.js";
 export function createScreenRenderer(output = process.stdout) {
-    let hasAnchor = false;
     return (content) => {
-        if (!hasAnchor) {
-            output.write("\x1b7");
-            hasAnchor = true;
-        }
-        output.write("\x1b8\x1b[J");
+        output.write("\x1b[H\x1b[2J");
         output.write(content);
     };
 }

package/package.json

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