@kjanat/dreamcli 3.0.0-rc.1 → 3.0.0-rc.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +37 -1
- package/dist/core/cli/dispatch.mjs +214 -1
- package/dist/core/cli/help-links.mjs +41 -1
- package/dist/core/cli/index.mjs +901 -1
- package/dist/core/cli/planner.mjs +300 -1
- package/dist/core/cli/plugin.mjs +41 -1
- package/dist/core/cli/propagate.mjs +57 -1
- package/dist/core/cli/root-help.mjs +208 -4
- package/dist/core/cli/root-surface.mjs +27 -1
- package/dist/core/cli/runtime-preflight.mjs +168 -1
- package/dist/core/completion/index.mjs +90 -1
- package/dist/core/completion/shells/bash.mjs +304 -3
- package/dist/core/completion/shells/fish.mjs +159 -2
- package/dist/core/completion/shells/powershell.mjs +353 -2
- package/dist/core/completion/shells/shared.mjs +154 -1
- package/dist/core/completion/shells/zsh.mjs +244 -2
- package/dist/core/config/index.mjs +246 -1
- package/dist/core/config/package-json.mjs +385 -3
- package/dist/core/errors/index.mjs +87 -1
- package/dist/core/execution/index.mjs +189 -1
- package/dist/core/help/ansi.mjs +122 -2
- package/dist/core/help/index.mjs +329 -7
- package/dist/core/json-schema/index.mjs +487 -9
- package/dist/core/json-schema/meta-descriptions.generated.mjs +93 -28
- package/dist/core/output/activity.mjs +452 -1
- package/dist/core/output/bind.mjs +56 -1
- package/dist/core/output/contracts.mjs +57 -1
- package/dist/core/output/display-value.mjs +32 -1
- package/dist/core/output/index.d.mts +21 -0
- package/dist/core/output/index.mjs +442 -2
- package/dist/core/output/renderers.mjs +46 -1
- package/dist/core/output/writer.mjs +12 -1
- package/dist/core/parse/index.mjs +555 -1
- package/dist/core/prompt/index.d.mts +0 -1
- package/dist/core/prompt/index.mjs +348 -6
- package/dist/core/resolve/args.mjs +105 -1
- package/dist/core/resolve/coerce.mjs +279 -1
- package/dist/core/resolve/config.mjs +19 -1
- package/dist/core/resolve/errors.mjs +140 -2
- package/dist/core/resolve/flags.mjs +196 -1
- package/dist/core/resolve/index.mjs +85 -1
- package/dist/core/resolve/property.d.mts +0 -1
- package/dist/core/resolve/property.mjs +45 -1
- package/dist/core/schema/arg.mjs +463 -1
- package/dist/core/schema/command.d.mts +18 -0
- package/dist/core/schema/command.mjs +712 -1
- package/dist/core/schema/flag.mjs +453 -1
- package/dist/core/schema/middleware.mjs +41 -1
- package/dist/core/schema/number-constraints.mjs +60 -1
- package/dist/core/schema-dsl/runtime.mjs +271 -2
- package/dist/core/schema-dsl/to-json-schema.mjs +74 -1
- package/dist/core/testkit/index.mjs +83 -1
- package/dist/index.d.mts +2 -1
- package/dist/index.mjs +22 -1
- package/dist/runtime/adapter.mjs +82 -1
- package/dist/runtime/auto.mjs +46 -1
- package/dist/runtime/bun.mjs +28 -1
- package/dist/runtime/deno.mjs +217 -2
- package/dist/runtime/detect.mjs +45 -1
- package/dist/runtime/node.mjs +169 -2
- package/dist/runtime/paths.mjs +48 -1
- package/dist/runtime.mjs +7 -1
- package/dist/strings.mjs +22 -1
- package/dist/testkit.mjs +5 -1
- package/dist/version.d.mts +7 -3
- package/dist/version.mjs +7 -1
- package/package.json +21 -26
- package/src/core/cli/dispatch.ts +0 -355
- package/src/core/cli/help-links.ts +0 -82
- package/src/core/cli/index.ts +0 -1614
- package/src/core/cli/planner.ts +0 -656
- package/src/core/cli/plugin.ts +0 -117
- package/src/core/cli/propagate.ts +0 -97
- package/src/core/cli/root-help.ts +0 -342
- package/src/core/cli/root-surface.ts +0 -87
- package/src/core/cli/runtime-preflight.ts +0 -456
- package/src/core/completion/index.ts +0 -138
- package/src/core/completion/shells/bash.ts +0 -459
- package/src/core/completion/shells/fish.ts +0 -259
- package/src/core/completion/shells/powershell.ts +0 -439
- package/src/core/completion/shells/shared.ts +0 -310
- package/src/core/completion/shells/zsh.ts +0 -381
- package/src/core/config/index.ts +0 -417
- package/src/core/config/package-json.ts +0 -560
- package/src/core/errors/index.ts +0 -193
- package/src/core/execution/index.ts +0 -265
- package/src/core/help/ansi.ts +0 -144
- package/src/core/help/index.ts +0 -563
- package/src/core/json-schema/index.ts +0 -910
- package/src/core/json-schema/meta-descriptions.generated.ts +0 -202
- package/src/core/output/activity.ts +0 -575
- package/src/core/output/bind.ts +0 -59
- package/src/core/output/contracts.ts +0 -194
- package/src/core/output/display-value.ts +0 -48
- package/src/core/output/index.ts +0 -704
- package/src/core/output/renderers.ts +0 -125
- package/src/core/output/writer.ts +0 -46
- package/src/core/parse/index.ts +0 -742
- package/src/core/prompt/index.ts +0 -623
- package/src/core/resolve/args.ts +0 -144
- package/src/core/resolve/coerce.ts +0 -500
- package/src/core/resolve/config.ts +0 -26
- package/src/core/resolve/contracts.ts +0 -135
- package/src/core/resolve/errors.ts +0 -227
- package/src/core/resolve/flags.ts +0 -269
- package/src/core/resolve/index.ts +0 -108
- package/src/core/resolve/property.ts +0 -99
- package/src/core/schema/activity.ts +0 -240
- package/src/core/schema/arg.ts +0 -841
- package/src/core/schema/command.ts +0 -1500
- package/src/core/schema/flag.ts +0 -917
- package/src/core/schema/index.ts +0 -96
- package/src/core/schema/middleware.ts +0 -171
- package/src/core/schema/number-constraints.ts +0 -153
- package/src/core/schema/prompt.ts +0 -171
- package/src/core/schema/run.ts +0 -198
- package/src/core/schema-dsl/index.ts +0 -109
- package/src/core/schema-dsl/parse.ts +0 -262
- package/src/core/schema-dsl/runtime.ts +0 -609
- package/src/core/schema-dsl/to-json-schema.ts +0 -102
- package/src/core/testkit/index.ts +0 -147
- package/src/index.ts +0 -181
- package/src/runtime/adapter.ts +0 -303
- package/src/runtime/auto.ts +0 -86
- package/src/runtime/bun.ts +0 -48
- package/src/runtime/deno.ts +0 -367
- package/src/runtime/detect.ts +0 -105
- package/src/runtime/index.ts +0 -21
- package/src/runtime/node-builtins.d.ts +0 -27
- package/src/runtime/node.ts +0 -289
- package/src/runtime/paths.ts +0 -64
- package/src/runtime/support.ts +0 -77
- package/src/runtime.ts +0 -31
- package/src/schema.ts +0 -16
- package/src/strings.ts +0 -34
- package/src/testkit.ts +0 -25
- package/src/version.ts +0 -20
|
@@ -1,28 +1,93 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
1
|
+
//#region src/core/json-schema/meta-descriptions.generated.ts
|
|
2
|
+
/**
|
|
3
|
+
* Generated definition meta-schema descriptions from normalized TypeDoc output.
|
|
4
|
+
*
|
|
5
|
+
* @module
|
|
6
|
+
*/
|
|
7
|
+
const definitionMetaSchemaDescriptions = {
|
|
8
|
+
root: {
|
|
9
|
+
description: "Runtime descriptor for the CLI program.\n\nStores the program name, version, description, and registered commands.\\\nBuilt incrementally by CLIBuilder.",
|
|
10
|
+
properties: {
|
|
11
|
+
name: { description: "Program name (used in help text, usage lines, and completion scripts)." },
|
|
12
|
+
version: { description: "Program version (shown by `--version`)." },
|
|
13
|
+
description: { description: "Program description (shown in root help)." },
|
|
14
|
+
defaultCommand: { description: "Default command dispatched when no subcommand matches.\n\nWhen set, the CLI root behaves like a hybrid command group: subcommands\ndispatch by name as usual, but empty argv or flags-only argv falls\nthrough to this command instead of showing root help.\n\nSet via the .default() builder method." },
|
|
15
|
+
commands: { description: "Registered commands (type-erased for heterogeneous storage)." }
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
defs: {
|
|
19
|
+
command: {
|
|
20
|
+
description: "Runtime descriptor produced by CommandBuilder.\n\nConsumers (parser, help generator, CLI dispatcher) read this to\nunderstand the command's shape — flags, args, aliases, subcommands,\nmiddleware, and interactive resolver.",
|
|
21
|
+
properties: {
|
|
22
|
+
name: { description: "The command name (used for dispatch, e.g. `'deploy'`)." },
|
|
23
|
+
description: { description: "Human-readable description for help text." },
|
|
24
|
+
aliases: { description: "Alternative names for this command." },
|
|
25
|
+
hidden: { description: "Whether this command is hidden from help listings." },
|
|
26
|
+
examples: { description: "Usage examples for help text." },
|
|
27
|
+
flags: { description: "Named flag schemas, keyed by flag name." },
|
|
28
|
+
args: { description: "Ordered positional arg entries (name + schema)." },
|
|
29
|
+
commands: { description: "Nested subcommand schemas (for help rendering and completion).\n\nPure data — no execution closures. Populated by `.command()` on\n`CommandBuilder`. Empty for leaf commands." }
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
flag: {
|
|
33
|
+
description: "The runtime descriptor stored inside every FlagBuilder. Consumers (parser,\nhelp generator, resolution chain) read this to understand the flag's shape\nwithout touching generics.",
|
|
34
|
+
properties: {
|
|
35
|
+
kind: { description: "What kind of value this flag accepts." },
|
|
36
|
+
presence: { description: "Presence describes whether a flag value is guaranteed to exist when the\naction handler runs:\n\n- `'optional'` — not required; unresolved value follows the kind-specific\n optional fallback (`undefined` for most flags, `[]` for arrays)\n- `'required'` — must be supplied; error if missing\n- `'defaulted'` — always present (falls back to default value)" },
|
|
37
|
+
defaultValue: { description: "Runtime default value (if any)." },
|
|
38
|
+
aliases: { description: "Short/long aliases (e.g. `[{ name: 'f', hidden: false }]` for `--force`)." },
|
|
39
|
+
envVar: { description: "Environment variable name for v0.2+ resolution." },
|
|
40
|
+
configPath: { description: "Dotted config path for v0.2+ resolution (e.g. `'deploy.region'`)." },
|
|
41
|
+
description: { description: "Human-readable description for help text." },
|
|
42
|
+
enumValues: { description: "Allowed literal values when `kind === 'enum'`." },
|
|
43
|
+
elementSchema: { description: "Element schema when `kind === 'array'`." },
|
|
44
|
+
prompt: { description: "Interactive prompt configuration for v0.3+ resolution." },
|
|
45
|
+
deprecated: { description: "Deprecation marker.\n\n- `undefined` — not deprecated (default)\n- `true` — deprecated with no migration message\n- `string` — deprecated with a reason/migration message\n\nWhen a deprecated flag is used, a warning is emitted to stderr.\nHelp text shows `[deprecated]` or `[deprecated: <reason>]`." },
|
|
46
|
+
propagate: { description: "Whether this flag propagates to subcommands in nested command trees.\n\nWhen `true`, the flag is automatically available to all descendant\ncommands. A child command that defines a flag with the same name\nshadows the propagated parent flag." }
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
arg: {
|
|
50
|
+
description: "The runtime descriptor stored inside every ArgBuilder. Consumers (parser,\nhelp generator) read this to understand the arg's shape without touching\ngenerics.",
|
|
51
|
+
properties: {
|
|
52
|
+
name: { description: "A named positional argument entry in the command schema.\n\nPairs a user-facing arg name with its ArgSchema descriptor.\nThe array ordering in CommandSchema.args determines CLI position." },
|
|
53
|
+
kind: { description: "What kind of value this arg accepts." },
|
|
54
|
+
presence: { description: "Presence describes whether a positional arg is guaranteed to exist when the\naction handler runs:\n\n- `'required'` — must be supplied; error if missing (default)\n- `'optional'` — may be `undefined` if not supplied\n- `'defaulted'` — always present (falls back to default value)" },
|
|
55
|
+
variadic: { description: "Whether this arg consumes all remaining positionals." },
|
|
56
|
+
stdinMode: { description: "Whether this arg may read from stdin during resolution." },
|
|
57
|
+
defaultValue: { description: "Runtime default value (if any)." },
|
|
58
|
+
description: { description: "Human-readable description for help text." },
|
|
59
|
+
envVar: { description: "Environment variable name for env resolution.\n\nWhen set and the CLI value is absent, the resolver reads this env var\nand coerces the string to the arg's declared kind." },
|
|
60
|
+
enumValues: { description: "Allowed literal values when `kind === 'enum'`." },
|
|
61
|
+
deprecated: { description: "Deprecation marker.\n\n- `undefined` — not deprecated (default)\n- `true` — deprecated with no migration message\n- `string` — deprecated with a reason/migration message\n\nWhen a deprecated arg is used, a warning is emitted to stderr.\nHelp text shows `[deprecated]` or `[deprecated: <reason>]`." }
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
prompt: {
|
|
65
|
+
description: "Discriminated union of all prompt configurations.\n\nUse the `kind` field to narrow:\n```ts\nif (config.kind === 'select') {\n config.choices // readonly SelectChoice[] | undefined\n}\n```",
|
|
66
|
+
properties: {
|
|
67
|
+
kind: { description: "The kind of interactive prompt to present.\n\n- `'confirm'` — yes/no boolean question\n- `'input'` — free-text string input\n- `'select'` — single selection from a list\n- `'multiselect'` — multiple selections from a list" },
|
|
68
|
+
message: { description: "The question displayed to the user." },
|
|
69
|
+
placeholder: { description: "Placeholder text shown before user types (informational only)." },
|
|
70
|
+
choices: { description: "Available choices. When omitted for `enum` flags, the enum values\nfrom the flag schema are used automatically." },
|
|
71
|
+
min: { description: "Minimum number of selections required." },
|
|
72
|
+
max: { description: "Maximum number of selections allowed." }
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
choice: {
|
|
76
|
+
description: "A selectable option for SelectPromptConfig and MultiselectPromptConfig prompts.",
|
|
77
|
+
properties: {
|
|
78
|
+
value: { description: "The value returned when this choice is selected." },
|
|
79
|
+
label: { description: "Display label shown to the user." },
|
|
80
|
+
description: { description: "Optional description shown alongside the choice." }
|
|
81
|
+
}
|
|
82
|
+
},
|
|
83
|
+
example: {
|
|
84
|
+
description: "A single usage example shown in help text.",
|
|
85
|
+
properties: {
|
|
86
|
+
command: { description: "The command invocation (e.g. `'deploy production --force'`)." },
|
|
87
|
+
description: { description: "Optional description of what this example does." }
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
};
|
|
92
|
+
//#endregion
|
|
93
|
+
export { definitionMetaSchemaDescriptions };
|
|
@@ -1 +1,452 @@
|
|
|
1
|
-
import{bindMethods
|
|
1
|
+
import { bindMethods } from "./bind.mjs";
|
|
2
|
+
import { writeLine } from "./writer.mjs";
|
|
3
|
+
//#region src/core/output/activity.ts
|
|
4
|
+
/**
|
|
5
|
+
* Noop spinner handle singleton.
|
|
6
|
+
*
|
|
7
|
+
* All methods are no-ops. Used when spinners should produce no output
|
|
8
|
+
* at all — `jsonMode`, or non-TTY with `fallback: 'silent'` (default).
|
|
9
|
+
*
|
|
10
|
+
* @internal
|
|
11
|
+
*/
|
|
12
|
+
const noopSpinnerHandle = {
|
|
13
|
+
update() {},
|
|
14
|
+
succeed() {},
|
|
15
|
+
fail() {},
|
|
16
|
+
stop() {},
|
|
17
|
+
wrap(promise) {
|
|
18
|
+
return promise;
|
|
19
|
+
}
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* Noop progress handle singleton.
|
|
23
|
+
*
|
|
24
|
+
* All methods are no-ops. Used when progress bars should produce no
|
|
25
|
+
* output at all — `jsonMode`, or non-TTY with `fallback: 'silent'`.
|
|
26
|
+
*
|
|
27
|
+
* @internal
|
|
28
|
+
*/
|
|
29
|
+
const noopProgressHandle = {
|
|
30
|
+
increment() {},
|
|
31
|
+
update() {},
|
|
32
|
+
done() {},
|
|
33
|
+
fail() {}
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* Static spinner handle — emits plain text at lifecycle boundaries.
|
|
37
|
+
*
|
|
38
|
+
* Used in non-TTY environments with `fallback: 'static'`. No animation,
|
|
39
|
+
* no ANSI codes. Emits text on start and terminal events only.
|
|
40
|
+
*
|
|
41
|
+
* Terminal methods are idempotent — calling after stop is a no-op.
|
|
42
|
+
*
|
|
43
|
+
* @internal
|
|
44
|
+
*/
|
|
45
|
+
var StaticSpinnerHandle = class {
|
|
46
|
+
write;
|
|
47
|
+
/** Whether the handle has been stopped (terminal state reached). */
|
|
48
|
+
stopped = false;
|
|
49
|
+
constructor(text, write) {
|
|
50
|
+
this.write = write;
|
|
51
|
+
writeLine(write, text);
|
|
52
|
+
bindMethods(this);
|
|
53
|
+
}
|
|
54
|
+
update(_text) {}
|
|
55
|
+
succeed(text) {
|
|
56
|
+
if (this.stopped) return;
|
|
57
|
+
this.stopped = true;
|
|
58
|
+
if (text !== void 0) writeLine(this.write, text);
|
|
59
|
+
}
|
|
60
|
+
fail(text) {
|
|
61
|
+
if (this.stopped) return;
|
|
62
|
+
this.stopped = true;
|
|
63
|
+
if (text !== void 0) writeLine(this.write, text);
|
|
64
|
+
}
|
|
65
|
+
stop() {
|
|
66
|
+
if (this.stopped) return;
|
|
67
|
+
this.stopped = true;
|
|
68
|
+
}
|
|
69
|
+
async wrap(promise, options) {
|
|
70
|
+
try {
|
|
71
|
+
const value = await promise;
|
|
72
|
+
this.succeed(options?.succeed);
|
|
73
|
+
return value;
|
|
74
|
+
} catch (error) {
|
|
75
|
+
this.fail(options?.fail);
|
|
76
|
+
throw error;
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
* Static progress handle — emits plain text at lifecycle boundaries.
|
|
82
|
+
*
|
|
83
|
+
* Used in non-TTY environments with `fallback: 'static'`. No animation,
|
|
84
|
+
* no progress bar rendering. Emits label on start, text on done/fail.
|
|
85
|
+
*
|
|
86
|
+
* Terminal methods are idempotent — calling after stop is a no-op.
|
|
87
|
+
*
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
var StaticProgressHandle = class {
|
|
91
|
+
write;
|
|
92
|
+
/** Whether the handle has been stopped (terminal state reached). */
|
|
93
|
+
stopped = false;
|
|
94
|
+
constructor(label, write) {
|
|
95
|
+
this.write = write;
|
|
96
|
+
if (label !== void 0) writeLine(write, label);
|
|
97
|
+
bindMethods(this);
|
|
98
|
+
}
|
|
99
|
+
increment(_n) {}
|
|
100
|
+
update(_value) {}
|
|
101
|
+
done(text) {
|
|
102
|
+
if (this.stopped) return;
|
|
103
|
+
this.stopped = true;
|
|
104
|
+
if (text !== void 0) writeLine(this.write, text);
|
|
105
|
+
}
|
|
106
|
+
fail(text) {
|
|
107
|
+
if (this.stopped) return;
|
|
108
|
+
this.stopped = true;
|
|
109
|
+
if (text !== void 0) writeLine(this.write, text);
|
|
110
|
+
}
|
|
111
|
+
};
|
|
112
|
+
/** Hide the terminal cursor. @internal */
|
|
113
|
+
const HIDE_CURSOR = "\x1B[?25l";
|
|
114
|
+
/** Show the terminal cursor. @internal */
|
|
115
|
+
const SHOW_CURSOR = "\x1B[?25h";
|
|
116
|
+
/** Erase the entire current line. @internal */
|
|
117
|
+
const ERASE_LINE = "\x1B[2K";
|
|
118
|
+
/**
|
|
119
|
+
* Braille-dot spinner frames.
|
|
120
|
+
*
|
|
121
|
+
* Provides smooth animation across most terminal emulators. The 10-frame
|
|
122
|
+
* sequence completes a full rotation of the braille clock pattern.
|
|
123
|
+
*
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
126
|
+
const SPINNER_FRAMES = [
|
|
127
|
+
"⠋",
|
|
128
|
+
"⠙",
|
|
129
|
+
"⠹",
|
|
130
|
+
"⠸",
|
|
131
|
+
"⠼",
|
|
132
|
+
"⠴",
|
|
133
|
+
"⠦",
|
|
134
|
+
"⠧",
|
|
135
|
+
"⠇",
|
|
136
|
+
"⠏"
|
|
137
|
+
];
|
|
138
|
+
/** @internal */ const SPINNER_INTERVAL_MS = 80;
|
|
139
|
+
/** Success symbol for terminal output. @internal */
|
|
140
|
+
const CHECK = "✓";
|
|
141
|
+
/** Failure symbol for terminal output. @internal */
|
|
142
|
+
const CROSS = "✗";
|
|
143
|
+
/** Filled segment of a progress bar. @internal */
|
|
144
|
+
const BAR_FILLED = "█";
|
|
145
|
+
/** Empty segment of a progress bar. @internal */
|
|
146
|
+
const BAR_EMPTY = "░";
|
|
147
|
+
/** Width of the progress bar in characters. @internal */
|
|
148
|
+
const BAR_WIDTH = 20;
|
|
149
|
+
/** Pulse width for indeterminate progress (number of filled segments). @internal */
|
|
150
|
+
const PULSE_WIDTH = 3;
|
|
151
|
+
/** Animation interval for indeterminate progress pulse (ms). @internal */
|
|
152
|
+
const PULSE_INTERVAL_MS = 80;
|
|
153
|
+
/**
|
|
154
|
+
* TTY spinner handle — animated braille frames with ANSI line overwrite.
|
|
155
|
+
*
|
|
156
|
+
* Used in TTY environments (non-JSON mode). Renders a spinning indicator
|
|
157
|
+
* with configurable text, using `\r` + erase-line to overwrite in place.
|
|
158
|
+
* Hides the cursor during animation and restores it on any terminal method.
|
|
159
|
+
*
|
|
160
|
+
* Terminal methods (`succeed`, `fail`, `stop`) are idempotent — calling any
|
|
161
|
+
* of them after the handle is already stopped is a no-op.
|
|
162
|
+
*
|
|
163
|
+
* **Note:** If the process exits abnormally (e.g. `SIGKILL`) while a spinner
|
|
164
|
+
* is active, the cursor may remain hidden. Use {@link SpinnerHandle.wrap} to
|
|
165
|
+
* ensure cleanup on both success and failure paths.
|
|
166
|
+
*
|
|
167
|
+
* @internal
|
|
168
|
+
*/
|
|
169
|
+
var TTYSpinnerHandle = class {
|
|
170
|
+
write;
|
|
171
|
+
/** Whether the handle has been stopped (terminal state reached). */
|
|
172
|
+
stopped = false;
|
|
173
|
+
/** Animation timer handle — cleared on any terminal method. */
|
|
174
|
+
timer;
|
|
175
|
+
/** Current position in the braille frame sequence. */
|
|
176
|
+
frameIndex = 0;
|
|
177
|
+
/** Current spinner text (mutable via `update()`). */
|
|
178
|
+
text;
|
|
179
|
+
constructor(text, write) {
|
|
180
|
+
this.write = write;
|
|
181
|
+
this.text = text;
|
|
182
|
+
write(HIDE_CURSOR);
|
|
183
|
+
this.render();
|
|
184
|
+
this.timer = setInterval(() => {
|
|
185
|
+
this.frameIndex = (this.frameIndex + 1) % SPINNER_FRAMES.length;
|
|
186
|
+
this.render();
|
|
187
|
+
}, SPINNER_INTERVAL_MS);
|
|
188
|
+
bindMethods(this);
|
|
189
|
+
}
|
|
190
|
+
/** Render the current frame + text, overwriting the current line. */
|
|
191
|
+
render() {
|
|
192
|
+
const frame = SPINNER_FRAMES[this.frameIndex] ?? SPINNER_FRAMES[0];
|
|
193
|
+
this.write(`\r${ERASE_LINE}${frame} ${this.text}`);
|
|
194
|
+
}
|
|
195
|
+
/** Clear the animation timer, erase the line, and restore the cursor. */
|
|
196
|
+
cleanup() {
|
|
197
|
+
if (this.timer !== void 0) {
|
|
198
|
+
clearInterval(this.timer);
|
|
199
|
+
this.timer = void 0;
|
|
200
|
+
}
|
|
201
|
+
this.write(`\r${ERASE_LINE}${SHOW_CURSOR}`);
|
|
202
|
+
}
|
|
203
|
+
update(text) {
|
|
204
|
+
if (this.stopped) return;
|
|
205
|
+
this.text = text;
|
|
206
|
+
this.render();
|
|
207
|
+
}
|
|
208
|
+
succeed(text) {
|
|
209
|
+
if (this.stopped) return;
|
|
210
|
+
this.stopped = true;
|
|
211
|
+
this.cleanup();
|
|
212
|
+
if (text !== void 0) writeLine(this.write, `${CHECK} ${text}`);
|
|
213
|
+
}
|
|
214
|
+
fail(text) {
|
|
215
|
+
if (this.stopped) return;
|
|
216
|
+
this.stopped = true;
|
|
217
|
+
this.cleanup();
|
|
218
|
+
if (text !== void 0) writeLine(this.write, `${CROSS} ${text}`);
|
|
219
|
+
}
|
|
220
|
+
stop() {
|
|
221
|
+
if (this.stopped) return;
|
|
222
|
+
this.stopped = true;
|
|
223
|
+
this.cleanup();
|
|
224
|
+
}
|
|
225
|
+
async wrap(promise, options) {
|
|
226
|
+
try {
|
|
227
|
+
const value = await promise;
|
|
228
|
+
this.succeed(options?.succeed);
|
|
229
|
+
return value;
|
|
230
|
+
} catch (error) {
|
|
231
|
+
this.fail(options?.fail);
|
|
232
|
+
throw error;
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
};
|
|
236
|
+
/**
|
|
237
|
+
* TTY progress handle — bar rendering with ANSI line overwrite.
|
|
238
|
+
*
|
|
239
|
+
* Supports two modes:
|
|
240
|
+
* - **Determinate** (`total` provided) — renders `[████░░░░░░] 40% label`,
|
|
241
|
+
* re-rendered on each `increment()` / `update()` call. No timer.
|
|
242
|
+
* - **Indeterminate** (`total` omitted) — renders a pulsing highlight that
|
|
243
|
+
* bounces across the bar via `setInterval`.
|
|
244
|
+
*
|
|
245
|
+
* Terminal methods (`done`, `fail`) are idempotent — calling any of them
|
|
246
|
+
* after the handle is already stopped is a no-op.
|
|
247
|
+
*
|
|
248
|
+
* @internal
|
|
249
|
+
*/
|
|
250
|
+
var TTYProgressHandle = class {
|
|
251
|
+
write;
|
|
252
|
+
/** Whether the handle has been stopped (terminal state reached). */
|
|
253
|
+
stopped = false;
|
|
254
|
+
/** Animation timer for indeterminate mode — `undefined` in determinate mode. */
|
|
255
|
+
timer;
|
|
256
|
+
/** Current progress value (units completed). */
|
|
257
|
+
current = 0;
|
|
258
|
+
/** Total units of work (`undefined` = indeterminate mode). */
|
|
259
|
+
total;
|
|
260
|
+
/** Label displayed alongside the bar. */
|
|
261
|
+
label;
|
|
262
|
+
/** Pulse position for indeterminate animation (bouncing highlight). */
|
|
263
|
+
pulsePos = 0;
|
|
264
|
+
/** Pulse direction: 1 = forward, -1 = backward (for bounce). */
|
|
265
|
+
pulseDir = 1;
|
|
266
|
+
constructor(opts, write) {
|
|
267
|
+
this.write = write;
|
|
268
|
+
this.total = opts.total;
|
|
269
|
+
this.label = opts.label ?? "";
|
|
270
|
+
write(HIDE_CURSOR);
|
|
271
|
+
this.render();
|
|
272
|
+
if (this.total === void 0) this.timer = setInterval(() => {
|
|
273
|
+
this.advancePulse();
|
|
274
|
+
this.render();
|
|
275
|
+
}, PULSE_INTERVAL_MS);
|
|
276
|
+
bindMethods(this);
|
|
277
|
+
}
|
|
278
|
+
/** Advance the indeterminate pulse position with bounce logic. */
|
|
279
|
+
advancePulse() {
|
|
280
|
+
this.pulsePos += this.pulseDir;
|
|
281
|
+
if (this.pulsePos + PULSE_WIDTH > BAR_WIDTH) {
|
|
282
|
+
this.pulseDir = -1;
|
|
283
|
+
this.pulsePos = BAR_WIDTH - PULSE_WIDTH;
|
|
284
|
+
} else if (this.pulsePos < 0) {
|
|
285
|
+
this.pulseDir = 1;
|
|
286
|
+
this.pulsePos = 0;
|
|
287
|
+
}
|
|
288
|
+
}
|
|
289
|
+
/** Render the progress bar, overwriting the current line. */
|
|
290
|
+
render() {
|
|
291
|
+
const bar = this.total !== void 0 ? this.renderDeterminate(this.total) : this.renderIndeterminate();
|
|
292
|
+
const suffix = this.label.length > 0 ? ` ${this.label}` : "";
|
|
293
|
+
this.write(`\r${ERASE_LINE}${bar}${suffix}`);
|
|
294
|
+
}
|
|
295
|
+
/** Render a determinate bar: `[████░░░░░░] 40%`. */
|
|
296
|
+
renderDeterminate(total) {
|
|
297
|
+
const ratio = total > 0 ? Math.max(0, Math.min(this.current / total, 1)) : 0;
|
|
298
|
+
const filled = Math.round(ratio * BAR_WIDTH);
|
|
299
|
+
const empty = BAR_WIDTH - filled;
|
|
300
|
+
const pct = Math.round(ratio * 100);
|
|
301
|
+
return `[${BAR_FILLED.repeat(filled)}${BAR_EMPTY.repeat(empty)}] ${String(pct)}%`;
|
|
302
|
+
}
|
|
303
|
+
/** Render an indeterminate bar: pulsing highlight bouncing across empty segments. */
|
|
304
|
+
renderIndeterminate() {
|
|
305
|
+
let bar = "";
|
|
306
|
+
for (let i = 0; i < BAR_WIDTH; i++) bar += i >= this.pulsePos && i < this.pulsePos + PULSE_WIDTH ? BAR_FILLED : BAR_EMPTY;
|
|
307
|
+
return `[${bar}]`;
|
|
308
|
+
}
|
|
309
|
+
/** Clear the animation timer, erase the line, and restore the cursor. */
|
|
310
|
+
cleanup() {
|
|
311
|
+
if (this.timer !== void 0) {
|
|
312
|
+
clearInterval(this.timer);
|
|
313
|
+
this.timer = void 0;
|
|
314
|
+
}
|
|
315
|
+
this.write(`\r${ERASE_LINE}${SHOW_CURSOR}`);
|
|
316
|
+
}
|
|
317
|
+
increment(n) {
|
|
318
|
+
if (this.stopped) return;
|
|
319
|
+
this.current += n ?? 1;
|
|
320
|
+
this.render();
|
|
321
|
+
}
|
|
322
|
+
update(value) {
|
|
323
|
+
if (this.stopped) return;
|
|
324
|
+
this.current = value;
|
|
325
|
+
this.render();
|
|
326
|
+
}
|
|
327
|
+
done(text) {
|
|
328
|
+
if (this.stopped) return;
|
|
329
|
+
this.stopped = true;
|
|
330
|
+
this.cleanup();
|
|
331
|
+
if (text !== void 0) writeLine(this.write, `${CHECK} ${text}`);
|
|
332
|
+
}
|
|
333
|
+
fail(text) {
|
|
334
|
+
if (this.stopped) return;
|
|
335
|
+
this.stopped = true;
|
|
336
|
+
this.cleanup();
|
|
337
|
+
if (text !== void 0) writeLine(this.write, `${CROSS} ${text}`);
|
|
338
|
+
}
|
|
339
|
+
};
|
|
340
|
+
/**
|
|
341
|
+
* Spinner handle that records lifecycle events to a shared `ActivityEvent[]`.
|
|
342
|
+
*
|
|
343
|
+
* Used by `createCaptureOutput()` so testkit can assert on spinner behaviour
|
|
344
|
+
* without polluting stdout/stderr arrays. Terminal methods are idempotent.
|
|
345
|
+
*
|
|
346
|
+
* @internal
|
|
347
|
+
*/
|
|
348
|
+
var CaptureSpinnerHandle = class {
|
|
349
|
+
events;
|
|
350
|
+
/** Whether the handle has been stopped (terminal state reached). */
|
|
351
|
+
stopped = false;
|
|
352
|
+
constructor(text, events) {
|
|
353
|
+
this.events = events;
|
|
354
|
+
events.push({
|
|
355
|
+
type: "spinner:start",
|
|
356
|
+
text
|
|
357
|
+
});
|
|
358
|
+
bindMethods(this);
|
|
359
|
+
}
|
|
360
|
+
update(text) {
|
|
361
|
+
if (this.stopped) return;
|
|
362
|
+
this.events.push({
|
|
363
|
+
type: "spinner:update",
|
|
364
|
+
text
|
|
365
|
+
});
|
|
366
|
+
}
|
|
367
|
+
succeed(text) {
|
|
368
|
+
if (this.stopped) return;
|
|
369
|
+
this.stopped = true;
|
|
370
|
+
this.events.push({
|
|
371
|
+
type: "spinner:succeed",
|
|
372
|
+
text: text ?? ""
|
|
373
|
+
});
|
|
374
|
+
}
|
|
375
|
+
fail(text) {
|
|
376
|
+
if (this.stopped) return;
|
|
377
|
+
this.stopped = true;
|
|
378
|
+
this.events.push({
|
|
379
|
+
type: "spinner:fail",
|
|
380
|
+
text: text ?? ""
|
|
381
|
+
});
|
|
382
|
+
}
|
|
383
|
+
stop() {
|
|
384
|
+
if (this.stopped) return;
|
|
385
|
+
this.stopped = true;
|
|
386
|
+
this.events.push({ type: "spinner:stop" });
|
|
387
|
+
}
|
|
388
|
+
async wrap(promise, options) {
|
|
389
|
+
try {
|
|
390
|
+
const value = await promise;
|
|
391
|
+
this.succeed(options?.succeed);
|
|
392
|
+
return value;
|
|
393
|
+
} catch (error) {
|
|
394
|
+
this.fail(options?.fail);
|
|
395
|
+
throw error;
|
|
396
|
+
}
|
|
397
|
+
}
|
|
398
|
+
};
|
|
399
|
+
/**
|
|
400
|
+
* Progress handle that records lifecycle events to a shared `ActivityEvent[]`.
|
|
401
|
+
*
|
|
402
|
+
* Used by `createCaptureOutput()` so testkit can assert on progress behaviour
|
|
403
|
+
* without polluting stdout/stderr arrays. Terminal methods are idempotent.
|
|
404
|
+
*
|
|
405
|
+
* @internal
|
|
406
|
+
*/
|
|
407
|
+
var CaptureProgressHandle = class {
|
|
408
|
+
events;
|
|
409
|
+
/** Whether the handle has been stopped (terminal state reached). */
|
|
410
|
+
stopped = false;
|
|
411
|
+
constructor(opts, events) {
|
|
412
|
+
this.events = events;
|
|
413
|
+
events.push({
|
|
414
|
+
type: "progress:start",
|
|
415
|
+
label: opts.label ?? "",
|
|
416
|
+
total: opts.total
|
|
417
|
+
});
|
|
418
|
+
bindMethods(this);
|
|
419
|
+
}
|
|
420
|
+
increment(n) {
|
|
421
|
+
if (this.stopped) return;
|
|
422
|
+
this.events.push({
|
|
423
|
+
type: "progress:increment",
|
|
424
|
+
delta: n ?? 1
|
|
425
|
+
});
|
|
426
|
+
}
|
|
427
|
+
update(value) {
|
|
428
|
+
if (this.stopped) return;
|
|
429
|
+
this.events.push({
|
|
430
|
+
type: "progress:update",
|
|
431
|
+
value
|
|
432
|
+
});
|
|
433
|
+
}
|
|
434
|
+
done(text) {
|
|
435
|
+
if (this.stopped) return;
|
|
436
|
+
this.stopped = true;
|
|
437
|
+
this.events.push({
|
|
438
|
+
type: "progress:done",
|
|
439
|
+
text
|
|
440
|
+
});
|
|
441
|
+
}
|
|
442
|
+
fail(text) {
|
|
443
|
+
if (this.stopped) return;
|
|
444
|
+
this.stopped = true;
|
|
445
|
+
this.events.push({
|
|
446
|
+
type: "progress:fail",
|
|
447
|
+
text
|
|
448
|
+
});
|
|
449
|
+
}
|
|
450
|
+
};
|
|
451
|
+
//#endregion
|
|
452
|
+
export { CaptureProgressHandle, CaptureSpinnerHandle, StaticProgressHandle, StaticSpinnerHandle, TTYProgressHandle, TTYSpinnerHandle, noopProgressHandle, noopSpinnerHandle };
|
|
@@ -1 +1,56 @@
|
|
|
1
|
-
|
|
1
|
+
//#region src/core/output/bind.ts
|
|
2
|
+
/**
|
|
3
|
+
* Method-binding helper for value objects handed to consumers.
|
|
4
|
+
*
|
|
5
|
+
* Output value objects — the `Out` channel and the spinner/progress handles
|
|
6
|
+
* — expose methods that read instance state via `this`. Consumers naturally
|
|
7
|
+
* detach those methods, either by destructuring
|
|
8
|
+
* (`const { log } = out` / `const { succeed, fail } = spinner`) or by passing
|
|
9
|
+
* them as callbacks (`promise.finally(spinner.stop)`). Detached, an unbound
|
|
10
|
+
* prototype method loses its `this` and crashes on the first field access.
|
|
11
|
+
*
|
|
12
|
+
* {@linkcode bindMethods} eliminates that footgun by installing instance-bound
|
|
13
|
+
* copies of every method, so the ergonomic usage is also the correct one.
|
|
14
|
+
*
|
|
15
|
+
* @module dreamcli/core/output/bind
|
|
16
|
+
* @internal
|
|
17
|
+
*/
|
|
18
|
+
/**
|
|
19
|
+
* Bind every method on an instance's prototype chain to the instance.
|
|
20
|
+
*
|
|
21
|
+
* Walks the prototype chain up to (but excluding) `Object.prototype`, binding
|
|
22
|
+
* each method name exactly once — the most-derived definition wins, so subclass
|
|
23
|
+
* overrides (e.g. `CaptureOutputChannel.spinner`) are preserved rather than
|
|
24
|
+
* clobbered by a base-class version. Bound methods are installed as
|
|
25
|
+
* non-enumerable own properties, mirroring the enumerability of the prototype
|
|
26
|
+
* methods they shadow. Getters and non-function members are left untouched.
|
|
27
|
+
*
|
|
28
|
+
* Call this once, last, in a class constructor. Because it reads the live
|
|
29
|
+
* prototype rather than a hand-maintained name list, methods added later are
|
|
30
|
+
* bound automatically — the binding can't silently fall out of date.
|
|
31
|
+
*
|
|
32
|
+
* @param instance - The object whose methods should be bound to it.
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
35
|
+
function bindMethods(instance) {
|
|
36
|
+
const bound = instance;
|
|
37
|
+
const seen = /* @__PURE__ */ new Set();
|
|
38
|
+
let proto = Object.getPrototypeOf(instance);
|
|
39
|
+
while (proto !== null && proto !== Object.prototype) {
|
|
40
|
+
for (const name of Object.getOwnPropertyNames(proto)) {
|
|
41
|
+
if (name === "constructor" || seen.has(name)) continue;
|
|
42
|
+
seen.add(name);
|
|
43
|
+
const descriptor = Object.getOwnPropertyDescriptor(proto, name);
|
|
44
|
+
if (descriptor === void 0 || typeof descriptor.value !== "function") continue;
|
|
45
|
+
Object.defineProperty(bound, name, {
|
|
46
|
+
value: descriptor.value.bind(instance),
|
|
47
|
+
writable: true,
|
|
48
|
+
enumerable: false,
|
|
49
|
+
configurable: true
|
|
50
|
+
});
|
|
51
|
+
}
|
|
52
|
+
proto = Object.getPrototypeOf(proto);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
//#endregion
|
|
56
|
+
export { bindMethods };
|