@effected/cli 0.16.2 → 0.18.0

package/CliPrompt.js

@@ -32,10 +32,9 @@ var CliPrompt = class {
 	* `CliRuntime.reportFailures`) renders it as one line with exit `130`; under a bare `runMain` it prints a
 	* stack.
 	*
-	* Pair it with `CliPrompt.gateTerminal`, which `CliEnv.layer` installs: core still runs `Prompt.run` on the
-	* answered prompt it is handed, and `Prompt.run` subscribes the terminal's input, which on a real terminal
-	* attaches a reader to stdin and drops piped input. The gate makes that subscription harmless when the run is
-	* not interactive.
+	* Core runs `Prompt.run` on the answered prompt it is handed, and an answered prompt never reads the terminal's
+	* input (core acquires it only when a prompt needs a key), so piped stdin is left untouched without any gate.
+	* `CliPrompt.gateTerminal`, which `CliEnv.layer` installs, covers the prompts this function does not wrap.
 	*
 	* @param prompt - the prompt to show
 	* @param options - the parameter it stands in for, and the non-interactive default
@@ -51,12 +50,12 @@ var CliPrompt = class {
 	* Gates core's `Terminal` on `CliInteractive`, so a run that is not interactive never touches the real one.
 	*
 	* @remarks
-	* Core's prompt runner subscribes the terminal's input even for a prompt that is already answered, and the
-	* real Node terminal then attaches a readline to stdin, which drops piped input and puts a TTY stdin into raw
-	* mode. Not interactive, this terminal's input is an already-ended queue, its `readLine` fails as quit and its
-	* `display` writes nothing, so any prompt, the wizard included, is quit at once and the real terminal is never
-	* read. Its `columns` and `rows` always come from the real one, so layout keeps working. Interactive, every
-	* call passes through to the real terminal.
+	* A prompt that needs a key reads the terminal's input, and the real Node terminal then attaches a readline to
+	* stdin, which drops piped input and puts a TTY stdin into raw mode. Core's `withFallbackPrompt`, a `Prompt.run`
+	* in a handler and the command wizard all do so whether or not anyone is there to answer. Not interactive, this
+	* terminal's input is an already-ended queue, its `readLine` fails as quit and its `display` writes nothing, so
+	* any such prompt is quit at once and the real terminal is never read. Its `columns` and `rows` always come
+	* from the real one, so layout keeps working. Interactive, every call passes through to the real terminal.
 	*
 	* The decision is made on every call, not when the layer is built, so a scope that narrows `CliInteractive`
 	* later, such as an audience flag under `CliAudience.runWith`, gates it too.

package/CliTheme.js

@@ -118,9 +118,10 @@ var CliTheme = class CliTheme extends Context.Service()("@effected/cli/CliTheme"
 	* Sets core's `Prompt.Theme` from the tokens, so built-in prompts match the rest of the output.
 	*
 	* @remarks
-	* The colour fields are raw SGR openers and are empty strings when colour is `none`. Under ASCII glyphs the
-	* prompt symbols fall back to ASCII too. A colourless theme is not byte-clean: core's `Ansi.annotate`
-	* appends a `\x1b[0m` reset, and prompts write cursor and underline codes, whatever the theme says.
+	* The colour fields are raw SGR openers and are empty strings when colour is `none`, and `colors` is the theme's
+	* own decision (`false` at `none`), so core's prompts and its command wizard write no colour or style escape, not
+	* even a reset, and core never re-reads the host for `NO_COLOR` or a TTY. Cursor and redraw controls are still
+	* written, whatever the theme says. Under ASCII glyphs the prompt symbols fall back to ASCII too.
 	*/
 	static promptTheme = Layer.effect(Prompt.Theme, Effect.gen(function* () {
 		const theme = yield* CliTheme;
@@ -128,6 +129,7 @@ var CliTheme = class CliTheme extends Context.Service()("@effected/cli/CliTheme"
 		return Prompt.makeTheme({
 			...theme.glyphs.kind === "ascii" ? ASCII_PROMPT_GLYPHS : {},
 			ellipsis: theme.glyphs.ellipsis,
+			colors: theme.color !== "none",
 			primaryColor: open("accent"),
 			mutedColor: open("muted"),
 			successColor: open("success"),

package/index.d.ts

@@ -656,9 +656,10 @@ export declare class CliTheme extends CliTheme_base {
    * Sets core's `Prompt.Theme` from the tokens, so built-in prompts match the rest of the output.
    *
    * @remarks
-   * The colour fields are raw SGR openers and are empty strings when colour is `none`. Under ASCII glyphs the
-   * prompt symbols fall back to ASCII too. A colourless theme is not byte-clean: core's `Ansi.annotate`
-   * appends a `\x1b[0m` reset, and prompts write cursor and underline codes, whatever the theme says.
+   * The colour fields are raw SGR openers and are empty strings when colour is `none`, and `colors` is the theme's
+   * own decision (`false` at `none`), so core's prompts and its command wizard write no colour or style escape, not
+   * even a reset, and core never re-reads the host for `NO_COLOR` or a TTY. Cursor and redraw controls are still
+   * written, whatever the theme says. Under ASCII glyphs the prompt symbols fall back to ASCII too.
    */
   static readonly promptTheme: Layer.Layer<never, never, CliTheme>;
 }
@@ -2007,13 +2008,13 @@ interface CliEnvOptions {
   /** The environment variable that overrides the audience, read through `Config`; see `Audience.layer`. */
   readonly audienceEnvVar?: string | undefined;
   /**
-   * Overrides the stderr terminal check; `Stdio` reports only stdout, so stderr mirrors it otherwise.
+   * Overrides the stderr terminal check; omitted, core's `Stdio.stderrIsTerminal` answers.
    *
    * @remarks
-   * Mirroring means a program whose stdout is a terminal but whose stderr is redirected to a file still paints
-   * stderr (a failure report, a warning) with colour escapes. A Node host that redirects stderr passes the real
-   * answer: `env: { stderrIsTerminal: Effect.sync(() => process.stderr.isTTY === true) }`. Core's `Stdio` has no
-   * stderr terminal check to read instead; that gap is tracked upstream as Effect-TS/effect#8639.
+   * The platform `Stdio` reads the host (`process.stderr.isTTY` on Node), so a program whose stdout is a terminal
+   * but whose stderr is redirected to a file writes its failure report and warnings there unpainted, with nothing
+   * passed here. A `Stdio` built with `Stdio.make` without the field answers `false`; pass this only for a host
+   * whose `Stdio` cannot say.
    */
   readonly stderrIsTerminal?: Effect.Effect<boolean> | undefined;
   /** Options for the theme; see {@link CliThemeOptions}. */
@@ -2521,10 +2522,9 @@ export declare class CliPrompt {
    * `CliRuntime.reportFailures`) renders it as one line with exit `130`; under a bare `runMain` it prints a
    * stack.
    *
-   * Pair it with `CliPrompt.gateTerminal`, which `CliEnv.layer` installs: core still runs `Prompt.run` on the
-   * answered prompt it is handed, and `Prompt.run` subscribes the terminal's input, which on a real terminal
-   * attaches a reader to stdin and drops piped input. The gate makes that subscription harmless when the run is
-   * not interactive.
+   * Core runs `Prompt.run` on the answered prompt it is handed, and an answered prompt never reads the terminal's
+   * input (core acquires it only when a prompt needs a key), so piped stdin is left untouched without any gate.
+   * `CliPrompt.gateTerminal`, which `CliEnv.layer` installs, covers the prompts this function does not wrap.
    *
    * @param prompt - the prompt to show
    * @param options - the parameter it stands in for, and the non-interactive default
@@ -2534,12 +2534,12 @@ export declare class CliPrompt {
    * Gates core's `Terminal` on `CliInteractive`, so a run that is not interactive never touches the real one.
    *
    * @remarks
-   * Core's prompt runner subscribes the terminal's input even for a prompt that is already answered, and the
-   * real Node terminal then attaches a readline to stdin, which drops piped input and puts a TTY stdin into raw
-   * mode. Not interactive, this terminal's input is an already-ended queue, its `readLine` fails as quit and its
-   * `display` writes nothing, so any prompt, the wizard included, is quit at once and the real terminal is never
-   * read. Its `columns` and `rows` always come from the real one, so layout keeps working. Interactive, every
-   * call passes through to the real terminal.
+   * A prompt that needs a key reads the terminal's input, and the real Node terminal then attaches a readline to
+   * stdin, which drops piped input and puts a TTY stdin into raw mode. Core's `withFallbackPrompt`, a `Prompt.run`
+   * in a handler and the command wizard all do so whether or not anyone is there to answer. Not interactive, this
+   * terminal's input is an already-ended queue, its `readLine` fails as quit and its `display` writes nothing, so
+   * any such prompt is quit at once and the real terminal is never read. Its `columns` and `rows` always come
+   * from the real one, so layout keeps working. Interactive, every call passes through to the real terminal.
    *
    * The decision is made on every call, not when the layer is built, so a scope that narrows `CliInteractive`
    * later, such as an audience flag under `CliAudience.runWith`, gates it too.
@@ -2715,12 +2715,9 @@ interface MainOptions<RP, EP> extends ReportFailuresOptions {
    * already ended and its `display` writes nothing. A program that reads piped data must read `Stdio.stdin`, and
    * 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 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.
+   * Stderr's colour follows its own terminal check, read from core's `Stdio`, so with stderr redirected and stdout
+   * a terminal the failure report goes into the file unpainted. `env.stderrIsTerminal` replaces that check for a
+   * host whose `Stdio` cannot say; a bin on the platform `Stdio` passes nothing.
    */
   readonly env?: CliEnvOptions | undefined;
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/cli",
-	"version": "0.16.2",
+	"version": "0.18.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": [
@@ -57,15 +57,15 @@
 		"./package.json": "./package.json"
 	},
 	"dependencies": {
-		"@effected/github-commands": "^0.2.2"
+		"@effected/github-commands": "^0.4.0"
 	},
 	"peerDependencies": {
-		"@effected/config-file": "^0.14.3",
-		"@effected/env": "^0.1.2",
-		"@effected/glob": "^0.10.1",
-		"@effected/walker": "^0.15.1",
+		"@effected/config-file": "^0.16.0",
+		"@effected/env": "^0.3.0",
+		"@effected/glob": "^0.12.0",
+		"@effected/walker": "^0.17.0",
 		"@types/react": "^19.3.0",
-		"effect": "4.0.2",
+		"effect": "^4.0.0",
 		"ink": "^8.0.0",
 		"react": "^19.3.0"
 	},