rolldown-pnpm-config 1.0.10 → 2.0.0

package/README.md

@@ -89,6 +89,8 @@ For repos that develop the plugin itself and cannot consume it as a config depen
 
 The `rolldown-pnpm-config preview` command opens an interactive tabbed view — Changes, Full and Simulated — without writing anything. In a non-interactive terminal it falls back to printing the Changes diff, so it is safe to run in CI.
 
+Every command adapts its output to who is reading it: colour and interactive screens for a person, plain escape-free text for a coding agent (`--agent`) or a CI job (`--ci`), detected automatically when no flag is given. Exit codes are scriptable — `0` success, `1` drift or failure, `64` a usage error, `130` a quit from an interactive screen. See [upgrading catalogs](https://github.com/spencerbeggs/rolldown-pnpm-config/blob/main/docs/05-upgrading-catalogs.md#output-audience-and-exit-codes).
+
 The optional `local` field on `PluginConfig` adjusts managed settings for this repo's export only — the built pnpmfile and its runtime behavior are unaffected. A bare value overwrites the managed value; the directive form merges it:
 
 ```ts

package/bin/rolldown-pnpm-config.js

@@ -1,18 +1,8 @@
 #!/usr/bin/env node
-import { exportCommand } from "../cli/commands/export.js";
-import { previewCommand } from "../cli/commands/preview.js";
-import { upgradeCommand } from "../cli/commands/upgrade.js";
-import { Effect } from "effect";
-import { NodeRuntime, NodeServices } from "@effect/platform-node";
-import { Command } from "effect/cli";
+import { main } from "../cli/main.js";
 
 //#region src/cli/bin.ts
-const root = Command.make("rolldown-pnpm-config").pipe(Command.withSubcommands([
-	upgradeCommand,
-	exportCommand,
-	previewCommand
-]));
-Command.run(root, { version: "1.0.10" }).pipe(Effect.provide(NodeServices.layer), NodeRuntime.runMain);
+main();
 
 //#endregion
 export {  };

package/cli/commands/export.js

@@ -2,20 +2,22 @@ import { discoverOwnedPatches, withResolvedBuildPatches } from "../../patches/bu
 import { DESCRIPTORS } from "../../descriptors/index.js";
 import { freeze } from "../../plugin/freeze.js";
 import { resolveRootName } from "../../runtime/ctx.js";
+import { canonicalize, renderWorkspace } from "../workspace-file.js";
+import { WorkingDirectory, resolveWorkspacePath } from "../cwd.js";
 import { reconcilePatches } from "../../patches/reconcile.js";
 import { buildDiff } from "../diff/build.js";
 import { renderExportDiff } from "../diff/render.js";
 import { effectiveManaged } from "../effective.js";
-import { canonicalize, renderWorkspace } from "../workspace-file.js";
 import { loadConfigAndWorkspace } from "../load-config.js";
+import { legend } from "../render/legend.js";
+import { printView } from "../render/print.js";
+import { failureDoc } from "../render/report.js";
 import { findConfigFiles, pickConfigCandidate } from "../select-file.js";
-import { toAnsi } from "../ui/ansi.js";
-import { detectCapabilities } from "../ui/env.js";
-import { legendLines } from "../ui/legend.js";
 import { overlayWorkspace } from "../workspace-overlay.js";
 import { Data, Effect, Option, Predicate } from "effect";
 import { existsSync, writeFileSync } from "node:fs";
 import { dirname, relative } from "node:path";
+import { CliDoc, CliMessage } from "@effected/cli";
 import { Argument, Command, Flag } from "effect/cli";
 
 //#region src/cli/commands/export.ts
@@ -24,7 +26,12 @@ import { Argument, Command, Flag } from "effect/cli";
 *
 * @internal
 */
-var ExportError = class extends Data.TaggedError("ExportError") {};
+var ExportError = class extends Data.TaggedError("ExportError") {
+	/** The failure report `CliRuntime.main` prints: the message, without the class name. */
+	[CliDoc]() {
+		return failureDoc(this.message);
+	}
+};
 /**
 * The set of pnpm config keys that belong in pnpm-workspace.yaml
 * (i.e. descriptors with `workspaceYaml: true`).
@@ -96,9 +103,9 @@ function runExport(opts) {
 		};
 	});
 }
-const pathArg = Argument.File("path").pipe(Argument.optional);
-const dryRunFlag = Flag.Boolean("dry-run").pipe(Flag.withDefault(false));
-const fullFlag = Flag.Boolean("full").pipe(Flag.withDefault(false));
+const pathArg = Argument.File("path").pipe(Argument.withDescription("The pnpm-workspace.yaml to write (the nearest one upward when omitted)"), Argument.optional);
+const dryRunFlag = Flag.Boolean("dry-run").pipe(Flag.withDescription("Print the diff instead of writing the file"), Flag.withDefault(false));
+const fullFlag = Flag.Boolean("full").pipe(Flag.withDescription("Show every line of the diff, not just the changes and their context"), Flag.withDefault(false));
 /**
 * The "export" command. Materializes the plugin config into pnpm-workspace.yaml.
 * An optional path argument overrides the auto-detected workspace file. --dry-run
@@ -112,26 +119,22 @@ const exportCommand = Command.make("export", {
 	dryRun: dryRunFlag,
 	full: fullFlag
 }, ({ path, dryRun, full }) => Effect.gen(function* () {
-	const matches = yield* findConfigFiles(process.cwd());
+	const matches = yield* findConfigFiles(yield* WorkingDirectory);
 	const picked = pickConfigCandidate(matches);
 	if (!picked.ok) return yield* Effect.fail(new ExportError({ message: picked.message }));
-	const workspacePath = Option.getOrUndefined(path);
 	const result = yield* runExport({
 		configFile: picked.file,
-		...workspacePath !== void 0 ? { workspacePath } : {},
+		workspacePath: yield* resolveWorkspacePath(Option.getOrUndefined(path)),
 		preview: dryRun,
 		full
 	});
-	yield* Effect.sync(() => {
-		if (dryRun) {
-			const caps = detectCapabilities();
-			process.stdout.write(`${result.path} (dry run — not written)\n\n`);
-			const legend = caps.color ? `${toAnsi(legendLines(), { color: caps.color })}\n\n` : "";
-			process.stdout.write(`${legend}${toAnsi(result.diff, { color: caps.color })}\n`);
-		} else process.stdout.write(`Exported to ${result.path}\n`);
-		for (const k of result.report.staleEntries) process.stderr.write(`warning: patch entry "${k}" has no file on disk\n`);
-		for (const k of result.report.keyMismatches) process.stderr.write(`warning: patch entry "${k}" does not match its filename\n`);
+	if (dryRun) yield* printView(result.diff, {
+		legend: legend(),
+		heading: `${result.path} (dry run — not written)`
 	});
+	else yield* CliMessage.success(`Exported to ${result.path}`);
+	for (const k of result.report.staleEntries) yield* CliMessage.warning(`patch entry "${k}" has no file on disk`);
+	for (const k of result.report.keyMismatches) yield* CliMessage.warning(`patch entry "${k}" does not match its filename`);
 })).pipe(Command.withDescription("Materialize the plugin config into pnpm-workspace.yaml (--dry-run to preview)"));
 
 //#endregion

package/cli/commands/preview.js

@@ -1,22 +1,31 @@
 import { freeze } from "../../plugin/freeze.js";
 import { resolveRootName } from "../../runtime/ctx.js";
+import { WorkingDirectory, resolveWorkspacePath } from "../cwd.js";
 import { loadConfigAndWorkspace } from "../load-config.js";
+import { legend } from "../render/legend.js";
+import { printView } from "../render/print.js";
+import { failureDoc } from "../render/report.js";
 import { findConfigFiles, pickConfigCandidate } from "../select-file.js";
-import { toAnsi } from "../ui/ansi.js";
-import { detectCapabilities } from "../ui/env.js";
-import { legendLines } from "../ui/legend.js";
 import { WORKSPACE_FIELDS } from "./export.js";
 import { buildPreviewViews } from "../preview-views.js";
+import { previewScreen } from "../ui/screens.js";
 import { Data, Effect, Option } from "effect";
 import { dirname } from "node:path";
+import { CliDoc, CliInteractive } from "@effected/cli";
 import { Argument, Command } from "effect/cli";
+import { CliUi } from "@effected/cli/ui";
 
 //#region src/cli/commands/preview.ts
 /** Typed failure for the preview run. @internal */
-var PreviewError = class extends Data.TaggedError("PreviewError") {};
+var PreviewError = class extends Data.TaggedError("PreviewError") {
+	/** The failure report `CliRuntime.main` prints: the message, without the class name. */
+	[CliDoc]() {
+		return failureDoc(this.message);
+	}
+};
 /**
 * Build the three preview views from a config + workspace file. Pure of any
-* terminal interaction; the command wraps this with interactive/non-TTY output.
+* terminal interaction; the command wraps this with interactive/non-interactive output.
 *
 * @internal
 */
@@ -35,31 +44,25 @@ function runPreviewViews(opts) {
 		});
 	});
 }
-const pathArg = Argument.File("path").pipe(Argument.optional);
+const pathArg = Argument.File("path").pipe(Argument.withDescription("The pnpm-workspace.yaml to preview against (the nearest one upward when omitted)"), Argument.optional);
 /**
-* The "preview" command: interactive ink-tab explorer of the export diff
-* (Changes / Full / Simulated). Falls back to printing the Changes view when
-* the terminal is non-interactive.
+* The "preview" command: an interactive tabbed explorer of the export diff
+* (Changes / Full / Simulated). When the run cannot prompt — a pipe, CI, an
+* agent — it prints the Changes view instead. The explorer is read-only, so
+* closing it any way (q, Enter, Esc, Ctrl-C) is a normal exit.
 *
 * @internal
 */
 const previewCommand = Command.make("preview", { path: pathArg }, ({ path }) => Effect.gen(function* () {
-	const matches = yield* findConfigFiles(process.cwd());
+	const matches = yield* findConfigFiles(yield* WorkingDirectory);
 	const picked = pickConfigCandidate(matches);
 	if (!picked.ok) return yield* Effect.fail(new PreviewError({ message: picked.message }));
-	const workspacePath = Option.getOrUndefined(path);
 	const views = yield* runPreviewViews({
 		configFile: picked.file,
-		...workspacePath !== void 0 ? { workspacePath } : {}
-	});
-	const caps = detectCapabilities();
-	if (caps.interactive) {
-		const { runPreview } = yield* Effect.promise(() => import("../ui/run-preview.js"));
-		yield* runPreview(views);
-	} else yield* Effect.sync(() => {
-		const legend = caps.color ? `${toAnsi(legendLines(), { color: caps.color })}\n\n` : "";
-		process.stdout.write(`${legend}${toAnsi(views.changes, { color: caps.color })}\n`);
+		workspacePath: yield* resolveWorkspacePath(Option.getOrUndefined(path))
 	});
+	if (!(yield* CliInteractive)) return yield* printView(views.changes, { legend: legend() });
+	yield* CliUi.run(previewScreen(views)).pipe(Effect.catchTag("Cancelled", () => Effect.void));
 })).pipe(Command.withDescription("Interactively preview how pnpm-workspace.yaml would change"));
 
 //#endregion