@savvy-web/cli 3.3.0 → 3.4.1

package/cli/index.js

@@ -12,7 +12,7 @@ import { Git } from "@effected/git";
 import { PackageManagerDetector, WorkspaceDiscovery, WorkspaceRoot, Workspaces } from "@effected/workspaces";
 import { ManagedSection } from "@effected/templates";
 import { ToolDiscovery } from "@effected/commands";
-import { NodeServices } from "@effect/platform-node";
+import * as NodeServices from "@effect/platform-node/NodeServices";
 
 //#region src/cli/index.ts
 /**

package/internal/failure-line.js

@@ -1,9 +1,8 @@
+import { Cause } from "effect";
+
 //#region src/internal/failure-line.ts
-/**
-* How a failure that reaches `CliRuntime.main` reads on stderr.
-*
-* @packageDocumentation
-*/
+/** Where a defect report asks to be filed; mirrors `package.json#bugs.url`. */
+const ISSUES_URL = "https://github.com/savvy-web/systems/issues";
 const HIDDEN = /* @__PURE__ */ new Set([
 	"_tag",
 	"message",
@@ -11,28 +10,50 @@ const HIDDEN = /* @__PURE__ */ new Set([
 	"stack",
 	"cause"
 ]);
+/** A field value as text; never throws, since a bigint or circular field would make `JSON.stringify` hide the failure. */
+const field = (value) => {
+	if (typeof value === "string") return value;
+	try {
+		return JSON.stringify(value) ?? String(value);
+	} catch {
+		return String(value);
+	}
+};
+/** One line for a typed failure: its own message, else its tag with its fields, else `String`. */
+const describe = (error) => {
+	if (error instanceof Error && error.message !== "") return error.message;
+	if (typeof error === "object" && error !== null && "_tag" in error) {
+		const fields = Object.entries(error).filter(([key]) => !HIDDEN.has(key)).map(([key, value]) => `${key}: ${field(value)}`);
+		const tag = String(error._tag);
+		return fields.length > 0 ? `${tag}: ${fields.join(", ")}` : tag;
+	}
+	return String(error);
+};
 /**
 * Renders a failure for `CliRuntime.main`'s `render` option.
 *
 * @remarks
-* The kit's default is `String(error)`, which prints a `Data.TaggedError`
-* with no `message` as its bare tag and drops the fields that say what went
-* wrong (`CleanError`, with the `reason` lost). This prefers the error's own
-* message, then its tag with its fields, then `String`.
+* The kit tells the renderer whether the squashed error is a typed failure
+* or a defect, so nothing here guesses that from the error's shape.
+*
+* - A typed failure is an expected outcome and reads as one line. The kit's
+*   default is `String(error)`, which prints a `Data.TaggedError` with no
+*   `message` as its bare tag and drops the fields that say what went wrong
+*   (`CleanError`, with the `reason` lost), so this prefers the error's own
+*   message, then its tag with its fields, then `String`.
+* - A defect — a `die`, a thrown exception — is a bug in savvy. It gets the
+*   issue-report treatment: a headline, the whole pretty-printed cause with
+*   its stack, and where to report it.
 *
 * @internal
 */
 var FailureLine = class {
 	constructor() {}
-	static render = (error) => {
-		if (error instanceof Error && error.message !== "") return error.message;
-		if (typeof error === "object" && error !== null && "_tag" in error) {
-			const fields = Object.entries(error).filter(([key]) => !HIDDEN.has(key)).map(([key, value]) => `${key}: ${typeof value === "string" ? value : JSON.stringify(value)}`);
-			const tag = String(error._tag);
-			return fields.length > 0 ? `${tag}: ${fields.join(", ")}` : tag;
-		}
-		return String(error);
-	};
+	static render = (error, details) => details.isDefect ? [
+		`savvy hit an unexpected error: ${describe(error)}`,
+		...Cause.pretty(details.cause).split("\n"),
+		`This is a bug in savvy. Please report it with the output above at ${ISSUES_URL}`
+	] : describe(error);
 };
 
 //#endregion

package/main.js

@@ -5,7 +5,7 @@ import { CLI_VERSION } from "./version.js";
 import { Command } from "effect/unstable/cli";
 import { CliColor, CliRuntime } from "@effected/cli";
 import { Effect, Layer, Option } from "effect";
-import { NodeRuntime } from "@effect/platform-node";
+import * as NodeRuntime from "@effect/platform-node/NodeRuntime";
 import { CurrentDistribution } from "@effected/engine";
 
 //#region src/main.ts
@@ -18,8 +18,11 @@ import { CurrentDistribution } from "@effected/engine";
 * `AppLive` stack and the carrier-aware version formatter, and hands the
 * program to `@effected/cli`'s `CliRuntime.main`, which provides the platform
 * and the kit-default CLI logger (every log line on stderr), reports failures
-* through that logger, applies the `CliExit` code a command set, and exits
-* `64` on a usage error.
+* through that logger (a typed failure as one line, a defect as a bug report),
+* applies the `CliExit` code a command set, and exits `64` on a usage error
+* with the help document on stderr, so stdout stays clean for a caller that
+* parses it. The version formatter rides in `platform`, not `program`: help
+* routing only sees a Formatter provided there.
 * No type casts: the layer graph is validated by the compiler.
 *
 * @packageDocumentation
@@ -33,10 +36,12 @@ import { CurrentDistribution } from "@effected/engine";
 const main = (options = {}) => {
 	const distribution = Option.fromNullishOr(options.distribution);
 	const VersionFormatterLive = CliColor.formatterLayer({ formatVersion: (name, version) => VersionLine.format(name, version, distribution) });
-	const program = Command.run(rootCommand, { version: CLI_VERSION }).pipe(Effect.provide(Layer.merge(AppLive, VersionFormatterLive)), Effect.provideService(CurrentDistribution, distribution));
+	const program = Command.run(rootCommand, { version: CLI_VERSION }).pipe(Effect.provide(AppLive), Effect.provideService(CurrentDistribution, distribution));
+	const platform = VersionFormatterLive.pipe(Layer.provideMerge(CliPlatform));
 	NodeRuntime.runMain(CliRuntime.main(program, {
-		platform: CliPlatform,
-		render: FailureLine.render
+		platform,
+		render: FailureLine.render,
+		helpOnUsageError: "stderr"
 	}));
 };
 /* v8 ignore stop */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@savvy-web/cli",
-	"version": "3.3.0",
+	"version": "3.4.1",
 	"private": false,
 	"description": "The savvy CLI — unified commit, changeset, and lint commands for the Silk Suite",
 	"homepage": "https://github.com/savvy-web/systems/tree/main/packages/cli",
@@ -37,15 +37,15 @@
 	},
 	"dependencies": {
 		"@effect/platform-node": "4.0.0-rc.117",
-		"@effected/cli": "^0.8.0",
+		"@effected/cli": "^0.9.0",
 		"@effected/commands": "^0.9.0",
 		"@effected/engine": "^0.1.0",
 		"@effected/git": "^0.17.0",
 		"@effected/jsonc": "^0.13.0",
 		"@effected/templates": "^0.8.0",
-		"@effected/workspaces": "^0.26.0",
+		"@effected/workspaces": "^0.28.0",
 		"@effected/yaml": "^0.17.0",
-		"@savvy-web/silk-effects": "9.1.3",
+		"@savvy-web/silk-effects": "9.2.0",
 		"effect": "4.0.0-rc.117"
 	}
 }

package/version.js

@@ -7,7 +7,7 @@
 * @packageDocumentation
 */
 /** @internal */
-const CLI_VERSION = "3.3.0";
+const CLI_VERSION = "3.4.1";
 
 //#endregion
 export { CLI_VERSION };