@effected/cli 0.18.0 → 0.20.0

package/ui/internal/ScreenContext.js

@@ -1,6 +1,6 @@
 import { fromReact, inkModules } from "./ink.js";
 
-//#region src/ui/internal/ScreenContext.ts
+// src/ui/internal/ScreenContext.ts
 /**
 * The React context carrying {@link ScreenContextValue}, built on the loaded React.
 *
@@ -48,5 +48,4 @@ const useScreenGuard = () => {
 	};
 };
 
-//#endregion
 export { screenContext, useScreenCancel, useScreenGuard };

package/ui/internal/UiProviders.js

@@ -1,7 +1,7 @@
 import { inkModules } from "./ink.js";
 import { screenContext } from "./ScreenContext.js";
 
-//#region src/ui/internal/UiProviders.ts
+// src/ui/internal/UiProviders.ts
 /**
 * Wrap `children` in the kit's providers: the theme, the glyph set, the optional size override, and a screen's cancel
 * and defect route when it has them.
@@ -17,5 +17,4 @@ const uiProviders = (value, children) => inkModules().react.createElement(screen
 	children
 });
 
-//#endregion
 export { uiProviders };

package/ui/internal/ink.js

@@ -1,7 +1,7 @@
 import { inkChalk } from "./inkChalk.js";
 import { Effect, Option } from "effect";
 
-//#region src/ui/internal/ink.ts
+// src/ui/internal/ink.ts
 const MISSING_PEERS = "@effected/cli/ui could not load its optional peers ink and react: install both beside @effected/cli to mount a screen";
 const READ_BEFORE_LOAD = "@effected/cli/ui read Ink before loading it: run CliUi.context (or mount a screen with CliUi.run) before rendering UiProvider or a kit component in a tree of your own";
 const UNRESOLVED_CHALK = "@effected/cli/ui could not resolve the chalk Ink uses (is ink bundled?), so Ink decides its own colour level";
@@ -118,5 +118,4 @@ const holdChalkLevel = (found, colour) => Option.match(found, {
 */
 const withInkColour = (colour) => Effect.flatMap(resolveChalk, (found) => holdChalkLevel(found, colour));
 
-//#endregion
 export { fromReact, holdChalkLevel, inkModules, levelOf, loadInk, withInkColour };

package/ui/internal/inkChalk.js

@@ -3,7 +3,7 @@ import { Option } from "effect";
 import { realpathSync } from "node:fs";
 import { fileURLToPath, pathToFileURL } from "node:url";
 
-//#region src/ui/internal/inkChalk.ts
+// src/ui/internal/inkChalk.ts
 const isInkChalk = (value) => (typeof value === "function" || typeof value === "object" && value !== null) && typeof value.level === "number";
 /** The runtime's `import.meta.resolve`, when it has one. */
 const esmResolve = typeof import.meta.resolve === "function" ? (specifier) => import.meta.resolve(specifier) : void 0;
@@ -54,5 +54,4 @@ const inkChalk = async (inkEntryOf = () => resolveInkEntry()) => {
 	}
 };
 
-//#endregion
 export { inkChalk, resolveInkEntry };

package/ui/internal/inkConsole.js

@@ -2,7 +2,7 @@ import { inkModules } from "./ink.js";
 import { UiStreams } from "../UiStreams.js";
 import { Effect, Inspectable } from "effect";
 
-//#region src/ui/internal/inkConsole.ts
+// src/ui/internal/inkConsole.ts
 /** One argument as a console shows it: a string as is, an `Error` with its stack, anything else as data (JSON). */
 const shown = (arg) => arg instanceof Error ? arg.stack ?? String(arg) : Inspectable.toStringUnknown(arg, 0);
 /** A console call's arguments as one line of text, joined by spaces. */
@@ -147,5 +147,4 @@ const makeInkConsole = Effect.gen(function* () {
 	};
 });
 
-//#endregion
 export { makeInkConsole };

package/ui/internal/lazyView.js

@@ -1,6 +1,6 @@
 import { Effect } from "effect";
 
-//#region src/ui/internal/lazyView.ts
+// src/ui/internal/lazyView.ts
 /** Where a lazy view keeps its loader: a `Symbol.for` key, so two copies of the package agree on it. */
 const LOAD = Symbol.for("@effected/cli/ui/lazyView");
 const NOT_LOADED = "@effected/cli/ui: a CliUi.lazyView render was called before its module loaded; only CliUi.live loads it first";
@@ -70,5 +70,4 @@ const loadView = (render) => {
 	}));
 };
 
-//#endregion
 export { LazyViewShapeError, lazyView, loadView };

package/ui/internal/lineText.js

@@ -1,6 +1,6 @@
 import { sanitize } from "../../Fmt.js";
 
-//#region src/ui/internal/lineText.ts
+// src/ui/internal/lineText.ts
 /**
 * Consumer text made safe for one row of a widget: sanitised as `Fmt.sanitize` does (no escape sequence, no other
 * control character), with each line break (CR, LF or CR LF) folded to a space.
@@ -15,5 +15,4 @@ import { sanitize } from "../../Fmt.js";
 */
 const lineText = (text) => sanitize(text).replace(/\r\n|\r|\n/g, " ");
 
-//#endregion
 export { lineText };

package/ui/internal/mountPermit.js

@@ -1,6 +1,6 @@
 import { Semaphore } from "effect";
 
-//#region src/ui/internal/mountPermit.ts
+// src/ui/internal/mountPermit.ts
 /**
 * One Ink mount at a time, process-wide: a `CliUi.run` screen, or one run of a live view.
 *
@@ -12,5 +12,4 @@ import { Semaphore } from "effect";
 */
 const mountPermit = Semaphore.makeUnsafe(1);
 
-//#endregion
 export { mountPermit };

package/ui/internal/processStreams.js

@@ -1,4 +1,4 @@
-//#region src/ui/internal/processStreams.ts
+// src/ui/internal/processStreams.ts
 /**
 * The process's own standard streams, the default `UiStreams`.
 *
@@ -15,5 +15,4 @@ const processStreams = () => ({
 	stderr: process.stderr
 });
 
-//#endregion
 export { processStreams };

package/ui/internal/renderOptions.js

@@ -1,6 +1,6 @@
 import { Context } from "effect";
 
-//#region src/ui/internal/renderOptions.ts
+// src/ui/internal/renderOptions.ts
 /**
 * The render-option overrides in force: none by default. Internal, so `CliUi.run`'s public signature stays as
 * specified; `CliUiTest` sets it.
@@ -9,5 +9,4 @@ import { Context } from "effect";
 */
 var UiRenderOptions = class extends Context.Reference("@effected/cli/ui/UiRenderOptions", { defaultValue: () => ({}) }) {};
 
-//#endregion
 export { UiRenderOptions };

package/ui/testing/CliUiTest.js

@@ -11,7 +11,7 @@ import { Cause, Console, Effect, Exit, Fiber, Inspectable, Layer, Option, Queue,
 import { TerminalEnv } from "@effected/env";
 import { TestClock } from "effect/testing";
 
-//#region src/ui/testing/CliUiTest.ts
+// src/ui/testing/CliUiTest.ts
 /** The tokens, in the order their marker colours are numbered. */
 const TOKENS = [
 	"success",
@@ -786,5 +786,4 @@ var CliUiTest = class {
 	};
 };
 
-//#endregion
 export { CliUiTest };

package/ui/testing/fakeStreams.js

@@ -1,6 +1,6 @@
 import { PassThrough, Writable } from "node:stream";
 
-//#region src/ui/testing/fakeStreams.ts
+// src/ui/testing/fakeStreams.ts
 /** The hide-cursor escape `cli-cursor` writes to a TTY stream as it arms the restore. */
 const HIDE_CURSOR = `${String.fromCharCode(27)}[?25l`;
 /** A cursor-show escape in a listener's source, as `restore-cursor` writes it (`'\u001B[?25h'`) or as the raw byte. */
@@ -101,5 +101,4 @@ const makeFakeStreams = (options = {}) => {
 	};
 };
 
-//#endregion
 export { makeFakeStreams };

package/ui/testing/terminalModel.js

@@ -1,4 +1,4 @@
-//#region src/ui/testing/terminalModel.ts
+// src/ui/testing/terminalModel.ts
 const ESC = String.fromCharCode(27);
 /**
 * A small terminal model for the production render path: what a terminal shows after `written`, as its non-empty
@@ -64,5 +64,4 @@ const screenAfter = (written, rows) => {
 	return lines.map((line) => line.trimEnd()).filter((line) => line !== "");
 };
 
-//#endregion
 export { screenAfter };

package/ui-testing-serializer.d.ts

@@ -1,4 +1,3 @@
-//#region src/ui-testing-serializer.d.ts
 /**
  * `CliUiTest.serializer`: it claims a string carrying escapes or token markup and prints it as token markup with each
  * line's trailing spaces trimmed. See `CliUiTest.serializer` for what it claims.
@@ -9,6 +8,5 @@ declare const serializer: {
   readonly test: (value: unknown) => boolean;
   readonly serialize: (value: unknown) => string;
 };
-//#endregion
 export { serializer as default };
 //# sourceMappingURL=ui-testing-serializer.d.ts.map

package/ui-testing-serializer.js

@@ -1,6 +1,6 @@
 import { CliUiTest } from "./ui/testing/CliUiTest.js";
 
-//#region src/ui-testing-serializer.ts
+// src/ui-testing-serializer.ts
 /**
 * `CliUiTest.serializer` as a module's default export, for Vitest's `snapshotSerializers` config.
 *
@@ -29,5 +29,4 @@ import { CliUiTest } from "./ui/testing/CliUiTest.js";
 */
 const serializer = CliUiTest.serializer;
 
-//#endregion
 export { serializer as default };

package/ui-testing.d.ts

@@ -3,7 +3,6 @@ import { KeyName, LiveHandle, LiveOptions, Screen } from "@effected/cli/ui";
 import { ColorLevel } from "@effected/env";
 import { Cause, Duration, Effect, Exit, Layer, Option, Scope } from "effect";
 import { ReactElement } from "react";
-//#region src/ui/testing/CliUiTest.d.ts
 /**
  * Options for {@link CliUiTest.render}, {@link CliUiTest.view} and {@link CliUiTest.session}, and the terminal's
  * half of {@link CliUiTest.live}'s.
@@ -555,6 +554,5 @@ export declare class CliUiTest {
     readonly serialize: (value: unknown) => string;
   };
 }
-//#endregion
 export type { CliUiTestHandle, CliUiTestLive, CliUiTestNextOptions, CliUiTestOptions, CliUiTestScreen, CliUiTestSession, CliUiTestSessionOptions, CliUiTestView };
 //# sourceMappingURL=ui-testing.d.ts.map

package/ui.d.ts

@@ -4,7 +4,6 @@ import { Param } from "effect/cli";
 import { ReactElement, ReactNode } from "react";
 import { Key } from "ink";
 import { ColorLevel } from "@effected/env";
-//#region src/ui/CliUiLive.d.ts
 /**
  * Options for `CliUi.live`.
  *
@@ -178,8 +177,6 @@ interface LiveHandle<S> {
    */
   readonly close: Effect.Effect<void>;
 }
-//#endregion
-//#region src/ui/UiProvider.d.ts
 /**
  * What the kit's hooks read in a tree the kit did not mount: the theme, the glyph set, and optionally the size.
  *
@@ -245,8 +242,6 @@ interface UiProviderProps {
  * @public
  */
 export declare const UiProvider: (props: UiProviderProps) => ReactElement;
-//#endregion
-//#region src/ui/CliUi.d.ts
 /**
  * How a screen ends: with a result, or cancelled for a reason.
  *
@@ -598,8 +593,6 @@ export declare class CliUi {
    */
   static readonly map: <A, B>(screen: Screen<A>, f: (value: A) => B) => Screen<B>;
 }
-//#endregion
-//#region src/ui/UiKey.d.ts
 /**
  * The named keys a screen understands and a test can press.
  *
@@ -641,8 +634,6 @@ export declare const UiKey: {
   /** Typed text. */
   readonly char: (char: string) => UiKey;
 };
-//#endregion
-//#region src/ui/KeyTable.d.ts
 /**
  * One row of a {@link KeyTable}: the keys that trigger an action, and the help line that names it.
  *
@@ -751,8 +742,6 @@ export declare class KeyTable<Action> {
  * @public
  */
 export declare const useKeys: <Action>(table: KeyTable<Action>, dispatch: (action: Action) => void, options?: UseKeysOptions) => void;
-//#endregion
-//#region src/ui/Confirm.d.ts
 /**
  * An extra on/off row a {@link Confirm} hosts beneath its yes/no answer.
  *
@@ -903,8 +892,6 @@ export declare class Confirm {
    */
   static readonly screen: <K extends string>(options: ConfirmScreenOptions<K>) => Screen<ConfirmResult<K>>;
 }
-//#endregion
-//#region src/ui/DocView.d.ts
 /**
  * Props of {@link DocView}.
  *
@@ -941,8 +928,6 @@ interface DocViewProps {
  * @public
  */
 export declare const DocView: (props: DocViewProps) => ReactElement;
-//#endregion
-//#region src/ui/KeyHelp.d.ts
 /**
  * Props of {@link KeyHelp}.
  *
@@ -969,8 +954,6 @@ interface KeyHelpProps {
  * @public
  */
 export declare const KeyHelp: (props: KeyHelpProps) => ReactElement;
-//#endregion
-//#region src/ui/Viewport.d.ts
 /**
  * Where a viewport is: the selected item, the first item in view, how many items fit, and how many there are.
  *
@@ -1069,8 +1052,6 @@ export declare class Viewport {
    */
   static readonly View: (props: ViewportViewProps) => ReactElement;
 }
-//#endregion
-//#region src/ui/MultiSelect.d.ts
 /**
  * One item of a {@link MultiSelect} section.
  *
@@ -1234,8 +1215,6 @@ export declare class MultiSelect {
    */
   static readonly screen: <A>(options: MultiSelectScreenOptions<A>) => Screen<ReadonlyArray<A>>;
 }
-//#endregion
-//#region src/ui/Select.d.ts
 /**
  * One choice of a {@link Select}.
  *
@@ -1393,8 +1372,6 @@ export declare class Select {
    */
   static readonly screen: <A>(options: SelectScreenOptions<A>) => Screen<A>;
 }
-//#endregion
-//#region src/ui/Tabs.d.ts
 /**
  * What a key does to a {@link Tabs} row: move to the previous or next tab (wrapping), or jump to one by index.
  *
@@ -1482,8 +1459,6 @@ export declare class Tabs {
    */
   static readonly View: <N extends string>(props: TabsProps<N>) => ReactElement;
 }
-//#endregion
-//#region src/ui/TextInput.d.ts
 /**
  * Where a {@link TextInput} is: its value, the cursor within it, and whether enter was pressed.
  *
@@ -1629,8 +1604,6 @@ export declare class TextInput {
    */
   static readonly screen: (options: TextInputScreenOptions) => Screen<string>;
 }
-//#endregion
-//#region src/ui/Toggle.d.ts
 /**
  * Props of {@link Toggle.View}.
  *
@@ -1659,8 +1632,6 @@ export declare class Toggle {
    */
   static readonly View: (props: ToggleViewProps) => ReactElement;
 }
-//#endregion
-//#region src/ui/UiStreams.d.ts
 /**
  * The streams a screen mounts on: Node streams, because Ink's stream contract is Node's.
  *
@@ -1693,8 +1664,6 @@ declare const UiStreams_base: Context.Reference<UiStreamsShape>;
  * @public
  */
 export declare class UiStreams extends UiStreams_base {}
-//#endregion
-//#region src/ui/UiTheme.d.ts
 /**
  * The styling props of an Ink `Text` that a {@link @effected/cli!Style} maps to.
  *
@@ -1812,6 +1781,5 @@ export declare const Styled: (props: StyledProps) => ReactElement;
  * @public
  */
 export declare const useTerminalSize: () => TerminalSize;
-//#endregion
 export type { Binding, CliUiFallbackOptions, CliUiPromptOptions, CliUiRunOptions, ConfirmAction, ConfirmInitOptions, ConfirmResult, ConfirmScreenOptions, ConfirmState, ConfirmToggle, ConfirmViewProps, DocViewProps, InkTextProps, KeyHelpProps, KeyHelpRow, KeyName, LiveHandle, LiveOptions, MultiSelectAction, MultiSelectInitOptions, MultiSelectItem, MultiSelectScreenOptions, MultiSelectSection, MultiSelectState, MultiSelectViewProps, Screen, ScreenControl, SelectAction, SelectChoice, SelectInitOptions, SelectScreenOptions, SelectState, SelectViewProps, StyledProps, Tab, TabsAction, TabsProps, TerminalSize, TextInputInitOptions, TextInputScreenOptions, TextInputState, TextInputViewProps, ToggleViewProps, UiContextValue, UiProviderProps, UiStreamsShape, UseKeysOptions, ViewportMove, ViewportRow, ViewportState, ViewportViewProps };
 //# sourceMappingURL=ui.d.ts.map