@effected/cli 0.12.0 → 0.13.0

package/CliRuntime.js

@@ -1,4 +1,6 @@
+import { Cancelled } from "./Cancelled.js";
 import { sanitize } from "./Fmt.js";
+import { NotInteractive } from "./NotInteractive.js";
 import { FailureTargetCell, currentTarget, fallbackTarget, guardConsumerLines, linesOf, plainFailureLines, readSpans, refreshFailureTarget } from "./internal/failureTarget.js";
 import { CliColor } from "./CliColor.js";
 import { CliEnv } from "./CliEnv.js";
@@ -173,6 +175,8 @@ var CliRuntime = class CliRuntime {
 			const details = {
 				cause,
 				isDefect: !Cause.hasFails(cause),
+				isCancelled: error instanceof Cancelled,
+				isNotInteractive: error instanceof NotInteractive,
 				defaultLines,
 				lines: (options) => options?.status === false || options?.spans !== void 0 ? reportLines(options?.status !== false, options?.spans) : defaultLines
 			};

package/index.d.ts

@@ -2568,6 +2568,24 @@ interface FailureDetails {
    * failure from the error channel.
    */
   readonly isDefect: boolean;
+  /**
+   * `true` when the squashed `error` is the kit's {@link Cancelled}: the person quit a prompt or screen (Esc, Ctrl-C).
+   * It is not a bug and there is nothing to report, whichever channel it arrived through.
+   *
+   * @remarks
+   * A cancel from `CliPrompt.fallback` is a defect (`isDefect` is `true`) and one from `CliUi.run` is a typed failure
+   * (`isDefect` is `false`), so a `render` that gives a defect the "please report this" treatment must test this flag
+   * first, or Esc prints an issue-report request. `isDefect` keeps its plain meaning, the absence of a typed failure,
+   * and the exit code is unchanged (`130` for the `interrupt` reason). `defaultLines` and `lines()` already draw it as
+   * its one fixed line.
+   */
+  readonly isCancelled: boolean;
+  /**
+   * `true` when the squashed `error` is the kit's {@link NotInteractive}: the program asked for a prompt or a screen in
+   * a run that cannot show one (a pipe, an agent, a CI). It is a usage problem, not a bug, whichever channel it
+   * arrived through; `isDefect` is as for {@link FailureDetails.isCancelled}.
+   */
+  readonly isNotInteractive: boolean;
   /**
    * The report the kit writes for this failure when there is no `render`: for this run, in this audience, with its
    * colour, links and `displayPath`. A `render` that hands a failure back returns these lines unchanged, and the
@@ -2687,9 +2705,11 @@ interface MainOptions<RP, EP> extends ReportFailuresOptions {
    * one that writes output must use `Console` or `Stdio`, never `Terminal`.
    *
    * Stderr's colour mirrors stdout's terminal check unless `env.stderrIsTerminal` says otherwise, so with stderr
-   * redirected and stdout a terminal the failure report is painted into the file. On Node, pass the real check:
-   * `env: { stderrIsTerminal: Effect.sync(() => process.stderr.isTTY === true) }` (core's `Stdio` reports only
-   * stdout; upstream Effect-TS/effect#8639).
+   * redirected and stdout a terminal the failure report is painted into the file. On Node, pass the real check from
+   * the bin's entry, the one place it reads the host:
+   * `env: { stderrIsTerminal: Effect.sync(() => process.stderr.isTTY === true) }`. Core's `Stdio` reports only
+   * stdout (upstream Effect-TS/effect#8639); once core has a stderr check, this option reads it and the bin passes
+   * nothing.
    */
   readonly env?: CliEnvOptions | undefined;
   /**
@@ -2706,8 +2726,12 @@ interface MainOptions<RP, EP> extends ReportFailuresOptions {
    *
    * Two cases keep help on stdout even under `"stderr"`. A `CliOutput`
    * Formatter or a `Console` provided inside `program` is not seen by
-   * `main`, so its help is not rerouted; provide the Formatter through
-   * `platform` instead. And with `Command.runWith`'s `renderErrors: false`
+   * `main`, so its help is not rerouted. To change the Formatter, pass
+   * `env.formatter` (for example `formatVersion`): `main` installs its own
+   * Formatter inside the platform, so that is the way in, and a Formatter
+   * provided inside the program is invisible to the routing. A Formatter
+   * the platform provides is shadowed by `main`'s, so pass it through
+   * `env.formatter` as well. And with `Command.runWith`'s `renderErrors: false`
    * no errors are printed, so nothing marks the help as a usage error's.
    */
   readonly helpOnUsageError?: "stdout" | "stderr" | undefined;

package/internal/renderMarkdown.js

@@ -52,7 +52,7 @@ const codeSpan = (text, mode) => {
 	const longest = Math.max(0, ...[...flat.matchAll(/`+/g)].map((run) => run[0].length));
 	const fence = "`".repeat(longest + 1);
 	const padded = /^`|`$/.test(flat) || /^ .* $/.test(flat) && flat.trim() !== "" || flat === "";
-	const body = mode === "cell" ? flat.replace(/\|/g, "\\|") : flat;
+	const body = mode === "cell" ? flat.split("|").join("\\|") : flat;
 	const pad = padded ? " " : "";
 	return `${fence}${pad}${body === "" ? " " : body}${pad}${fence}`;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/cli",
-	"version": "0.12.0",
+	"version": "0.13.0",
 	"private": false,
 	"description": "The presentation boundary of an effect/cli program: audience-aware output, a document IR and renderers, editor links, failure reports and logging, plus opt-in Ink screens, widgets and a live view",
 	"keywords": [
@@ -60,7 +60,7 @@
 		"@effected/github-commands": "^0.1.0"
 	},
 	"peerDependencies": {
-		"@effected/config-file": "^0.14.1",
+		"@effected/config-file": "^0.14.2",
 		"@effected/env": "^0.1.0",
 		"@effected/glob": "^0.10.0",
 		"@effected/walker": "^0.15.0",