@kjanat/dreamcli 3.0.0-rc.1 → 3.0.0-rc.11
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 +227 -1
- package/dist/core/cli/dispatch.d.mts +6 -5
- package/dist/core/cli/dispatch.mjs +205 -1
- package/dist/core/cli/help-links.d.mts +0 -1
- package/dist/core/cli/help-links.mjs +41 -1
- package/dist/core/cli/index.d.mts +81 -8
- package/dist/core/cli/index.mjs +945 -1
- package/dist/core/cli/planner.d.mts +5 -1
- package/dist/core/cli/planner.mjs +300 -1
- package/dist/core/cli/plugin.d.mts +1 -1
- package/dist/core/cli/plugin.mjs +41 -1
- package/dist/core/cli/propagate.d.mts +1 -1
- package/dist/core/cli/propagate.mjs +57 -1
- package/dist/core/cli/root-help.d.mts +2 -1
- package/dist/core/cli/root-help.mjs +226 -4
- package/dist/core/cli/root-surface.d.mts +12 -1
- package/dist/core/cli/root-surface.mjs +28 -1
- package/dist/core/cli/runtime-preflight.d.mts +14 -2
- package/dist/core/cli/runtime-preflight.mjs +169 -1
- package/dist/core/completion/index.d.mts +0 -1
- package/dist/core/completion/index.mjs +90 -1
- package/dist/core/completion/shells/bash.d.mts +0 -1
- package/dist/core/completion/shells/bash.mjs +308 -3
- package/dist/core/completion/shells/fish.d.mts +0 -1
- package/dist/core/completion/shells/fish.mjs +162 -2
- package/dist/core/completion/shells/powershell.d.mts +0 -1
- package/dist/core/completion/shells/powershell.mjs +358 -2
- package/dist/core/completion/shells/shared.d.mts +13 -2
- package/dist/core/completion/shells/shared.mjs +176 -1
- package/dist/core/completion/shells/zsh.d.mts +0 -1
- package/dist/core/completion/shells/zsh.mjs +251 -2
- package/dist/core/config/index.d.mts +2 -3
- package/dist/core/config/index.mjs +246 -1
- package/dist/core/config/package-json.d.mts +27 -4
- package/dist/core/config/package-json.mjs +386 -3
- package/dist/core/errors/index.d.mts +3 -3
- package/dist/core/errors/index.mjs +87 -1
- package/dist/core/execution/index.d.mts +0 -1
- package/dist/core/execution/index.mjs +201 -1
- package/dist/core/help/ansi.d.mts +11 -5
- package/dist/core/help/ansi.mjs +121 -2
- package/dist/core/help/index.d.mts +22 -3
- package/dist/core/help/index.mjs +341 -7
- package/dist/core/help/theme.d.mts +68 -0
- package/dist/core/help/theme.mjs +46 -0
- package/dist/core/json-schema/index.d.mts +15 -2
- package/dist/core/json-schema/index.mjs +536 -12
- package/dist/core/json-schema/meta-descriptions.generated.d.mts +55 -38
- package/dist/core/json-schema/meta-descriptions.generated.mjs +102 -28
- package/dist/core/output/activity.d.mts +0 -1
- package/dist/core/output/activity.mjs +452 -1
- package/dist/core/output/bind.mjs +56 -1
- package/dist/core/output/contracts.d.mts +4 -5
- 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 -1
- package/dist/core/output/index.mjs +442 -2
- package/dist/core/output/renderers.d.mts +0 -1
- package/dist/core/output/renderers.mjs +46 -1
- package/dist/core/output/writer.mjs +12 -1
- package/dist/core/parse/index.d.mts +40 -7
- package/dist/core/parse/index.mjs +727 -1
- package/dist/core/prompt/index.d.mts +1 -1
- package/dist/core/prompt/index.mjs +348 -6
- package/dist/core/resolve/args.d.mts +1 -1
- package/dist/core/resolve/args.mjs +105 -1
- package/dist/core/resolve/coerce.d.mts +1 -1
- package/dist/core/resolve/coerce.mjs +336 -1
- package/dist/core/resolve/config.mjs +19 -1
- package/dist/core/resolve/contracts.d.mts +9 -4
- package/dist/core/resolve/errors.d.mts +0 -1
- package/dist/core/resolve/errors.mjs +140 -2
- package/dist/core/resolve/flags.d.mts +7 -2
- package/dist/core/resolve/flags.mjs +251 -1
- package/dist/core/resolve/index.d.mts +2 -2
- package/dist/core/resolve/index.mjs +85 -1
- package/dist/core/resolve/property.d.mts +4 -2
- package/dist/core/resolve/property.mjs +53 -1
- package/dist/core/schema/activity.d.mts +31 -11
- package/dist/core/schema/arg.d.mts +3 -4
- package/dist/core/schema/arg.mjs +463 -1
- package/dist/core/schema/command.d.mts +26 -6
- package/dist/core/schema/command.mjs +726 -1
- package/dist/core/schema/flag.d.mts +485 -19
- package/dist/core/schema/flag.mjs +705 -1
- package/dist/core/schema/index.d.mts +4 -2
- package/dist/core/schema/middleware.d.mts +4 -3
- package/dist/core/schema/middleware.mjs +41 -1
- package/dist/core/schema/number-constraints.mjs +60 -1
- package/dist/core/schema/prompt.d.mts +6 -3
- package/dist/core/schema/run.d.mts +20 -1
- package/dist/core/schema/string-constraints.d.mts +97 -0
- package/dist/core/schema/string-constraints.mjs +69 -0
- package/dist/core/schema/value-parsers.d.mts +78 -0
- package/dist/core/schema/value-parsers.mjs +142 -0
- package/dist/core/schema-dsl/runtime.mjs +271 -2
- package/dist/core/schema-dsl/to-json-schema.d.mts +0 -1
- package/dist/core/schema-dsl/to-json-schema.mjs +74 -1
- package/dist/core/testkit/index.d.mts +0 -31
- package/dist/core/testkit/index.mjs +83 -1
- package/dist/index.d.mts +11 -6
- package/dist/index.mjs +22 -1
- package/dist/runtime/adapter.d.mts +38 -2
- package/dist/runtime/adapter.mjs +87 -1
- package/dist/runtime/auto.d.mts +2 -3
- package/dist/runtime/auto.mjs +45 -1
- package/dist/runtime/deno.d.mts +24 -5
- package/dist/runtime/deno.mjs +262 -2
- package/dist/runtime/detect.mjs +45 -1
- package/dist/runtime/index.d.mts +3 -4
- package/dist/runtime/node.d.mts +8 -2
- package/dist/runtime/node.mjs +220 -2
- package/dist/runtime/paths.mjs +48 -1
- package/dist/runtime.d.mts +4 -4
- package/dist/runtime.mjs +6 -1
- package/dist/strings.mjs +22 -1
- package/dist/testkit.d.mts +1 -0
- package/dist/testkit.mjs +5 -1
- package/dist/version.d.mts +7 -3
- package/dist/version.mjs +7 -1
- package/dreamcli.schema.json +36 -7
- package/package.json +45 -42
- package/dist/runtime/bun.d.mts +0 -28
- package/dist/runtime/bun.mjs +0 -1
- 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 +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 };
|
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
import { Fallback, TableOptions } from "../schema/activity.mjs";
|
|
2
|
-
|
|
3
2
|
//#region src/core/output/contracts.d.ts
|
|
4
3
|
/** Ordered output verbosity levels owned by the output policy layer. */
|
|
5
|
-
declare const OUTPUT_VERBOSITY_LEVELS: readonly [
|
|
4
|
+
declare const OUTPUT_VERBOSITY_LEVELS: readonly ["normal", "quiet"];
|
|
6
5
|
/** Stable output text streams. */
|
|
7
|
-
declare const OUTPUT_STREAMS: readonly [
|
|
6
|
+
declare const OUTPUT_STREAMS: readonly ["stdout", "stderr"];
|
|
8
7
|
/** Stable activity rendering modes. */
|
|
9
|
-
declare const ACTIVITY_RENDER_MODES: readonly [
|
|
8
|
+
declare const ACTIVITY_RENDER_MODES: readonly ["noop", "static", "tty", "capture"];
|
|
10
9
|
/** Stable activity cleanup actions. */
|
|
11
|
-
declare const ACTIVITY_CLEANUP_KINDS: readonly [
|
|
10
|
+
declare const ACTIVITY_CLEANUP_KINDS: readonly ["none", "stop", "done"];
|
|
12
11
|
/** Stable text verbosity labels. */
|
|
13
12
|
type Verbosity = (typeof OUTPUT_VERBOSITY_LEVELS)[number];
|
|
14
13
|
/** Stable output stream labels. */
|
|
@@ -1 +1,57 @@
|
|
|
1
|
-
|
|
1
|
+
//#region src/core/output/contracts.ts
|
|
2
|
+
/** Build the stable output-policy snapshot for one channel instance. */
|
|
3
|
+
function resolveOutputPolicy(options) {
|
|
4
|
+
return {
|
|
5
|
+
jsonMode: options.jsonMode,
|
|
6
|
+
isTTY: options.isTTY,
|
|
7
|
+
verbosity: options.verbosity
|
|
8
|
+
};
|
|
9
|
+
}
|
|
10
|
+
/** Resolve the default text stream for non-JSON structured output. */
|
|
11
|
+
function resolveTextStream(policy) {
|
|
12
|
+
return policy.jsonMode ? "stderr" : "stdout";
|
|
13
|
+
}
|
|
14
|
+
/** Whether `info()` messages should be emitted under the current policy. */
|
|
15
|
+
function shouldEmitInfo(policy) {
|
|
16
|
+
return policy.verbosity !== "quiet";
|
|
17
|
+
}
|
|
18
|
+
/** Resolve the concrete table format under the current policy. */
|
|
19
|
+
function resolveTableFormat(policy, options) {
|
|
20
|
+
switch (options?.format) {
|
|
21
|
+
case "json": return "json";
|
|
22
|
+
case "text": return "text";
|
|
23
|
+
case "auto":
|
|
24
|
+
case void 0: return policy.jsonMode ? "json" : "text";
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
/** Resolve the text-table stream after table-format selection. */
|
|
28
|
+
function resolveTableTextStream(policy, options) {
|
|
29
|
+
if (options?.format === "text" && "stream" in options && options.stream !== void 0) return options.stream;
|
|
30
|
+
return resolveTextStream(policy);
|
|
31
|
+
}
|
|
32
|
+
/** Resolve the non-capture activity mode shared by spinner and progress. */
|
|
33
|
+
function resolveActivityRenderMode(policy, fallback) {
|
|
34
|
+
if (policy.jsonMode) return "noop";
|
|
35
|
+
if (policy.isTTY) return "tty";
|
|
36
|
+
return fallback === "static" ? "static" : "noop";
|
|
37
|
+
}
|
|
38
|
+
/** Resolve spinner activity policy including cleanup ownership. */
|
|
39
|
+
function resolveSpinnerPolicy(policy, fallback) {
|
|
40
|
+
const mode = resolveActivityRenderMode(policy, fallback);
|
|
41
|
+
return {
|
|
42
|
+
mode,
|
|
43
|
+
stream: "stderr",
|
|
44
|
+
cleanup: mode === "noop" ? "none" : "stop"
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
/** Resolve progress activity policy including cleanup ownership. */
|
|
48
|
+
function resolveProgressPolicy(policy, fallback) {
|
|
49
|
+
const mode = resolveActivityRenderMode(policy, fallback);
|
|
50
|
+
return {
|
|
51
|
+
mode,
|
|
52
|
+
stream: "stderr",
|
|
53
|
+
cleanup: mode === "noop" ? "none" : "done"
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
//#endregion
|
|
57
|
+
export { resolveActivityRenderMode, resolveOutputPolicy, resolveProgressPolicy, resolveSpinnerPolicy, resolveTableFormat, resolveTableTextStream, resolveTextStream, shouldEmitInfo };
|
|
@@ -1 +1,32 @@
|
|
|
1
|
-
|
|
1
|
+
//#region src/core/output/display-value.ts
|
|
2
|
+
/**
|
|
3
|
+
* Shared runtime-value formatting for human-readable output.
|
|
4
|
+
*
|
|
5
|
+
* Used by help text and table rendering so default values and structured cells
|
|
6
|
+
* stringify consistently across the CLI surface.
|
|
7
|
+
*
|
|
8
|
+
* @module dreamcli/core/output/display-value
|
|
9
|
+
* @internal
|
|
10
|
+
*/
|
|
11
|
+
/**
|
|
12
|
+
* Format an unknown runtime value for human-readable output.
|
|
13
|
+
*
|
|
14
|
+
* @param value - The value to format (any type).
|
|
15
|
+
* @returns A string representation suitable for table cells and help text.
|
|
16
|
+
*/
|
|
17
|
+
function formatDisplayValue(value) {
|
|
18
|
+
if (value === null || value === void 0) return "";
|
|
19
|
+
if (typeof value === "string" || typeof value === "number" || typeof value === "boolean" || typeof value === "bigint" || typeof value === "symbol") return String(value);
|
|
20
|
+
if (value instanceof Date) {
|
|
21
|
+
if (Number.isNaN(value.getTime())) return "Invalid Date";
|
|
22
|
+
return value.toISOString();
|
|
23
|
+
}
|
|
24
|
+
if (typeof value === "function") return value.name.length > 0 ? `[Function: ${value.name}]` : "[Function]";
|
|
25
|
+
try {
|
|
26
|
+
return JSON.stringify(value) ?? "[unserializable]";
|
|
27
|
+
} catch {
|
|
28
|
+
return "[unserializable]";
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
//#endregion
|
|
32
|
+
export { formatDisplayValue };
|
|
@@ -3,7 +3,7 @@ import { WriteFn, writeLine } from "./writer.mjs";
|
|
|
3
3
|
import { CaptureProgressHandle, CaptureSpinnerHandle, StaticProgressHandle, StaticSpinnerHandle, TTYProgressHandle, TTYSpinnerHandle, noopProgressHandle, noopSpinnerHandle } from "./activity.mjs";
|
|
4
4
|
import { OutputPolicy, Verbosity } from "./contracts.mjs";
|
|
5
5
|
import { Out } from "../schema/command.mjs";
|
|
6
|
-
|
|
6
|
+
import { Colors } from "ansispeck";
|
|
7
7
|
//#region src/core/output/index.d.ts
|
|
8
8
|
/**
|
|
9
9
|
* Configuration for creating an output channel.
|
|
@@ -45,6 +45,18 @@ interface OutputOptions {
|
|
|
45
45
|
* @defaultValue `false`
|
|
46
46
|
*/
|
|
47
47
|
readonly jsonMode?: boolean;
|
|
48
|
+
/**
|
|
49
|
+
* Explicitly enable or disable ANSI colors on `out.color`.
|
|
50
|
+
*
|
|
51
|
+
* When set, this wins over the auto-gate — use it to force colors in
|
|
52
|
+
* captured test output or when embedding into a host that manages its
|
|
53
|
+
* own color policy.
|
|
54
|
+
*
|
|
55
|
+
* @defaultValue auto — enabled when `isTTY` is `true`, `jsonMode` is
|
|
56
|
+
* `false`, and the environment supports color (`NO_COLOR`,
|
|
57
|
+
* `FORCE_COLOR`, `--no-color`, `--color`, `CI` are respected).
|
|
58
|
+
*/
|
|
59
|
+
readonly color?: boolean;
|
|
48
60
|
}
|
|
49
61
|
/** Fully resolved output options with no optional fields. */
|
|
50
62
|
interface ResolvedOutputOptions {
|
|
@@ -53,6 +65,7 @@ interface ResolvedOutputOptions {
|
|
|
53
65
|
readonly isTTY: boolean;
|
|
54
66
|
readonly verbosity: Verbosity;
|
|
55
67
|
readonly jsonMode: boolean;
|
|
68
|
+
readonly color: boolean;
|
|
56
69
|
}
|
|
57
70
|
declare function setRequestedExitCode(out: Out, code: number): void;
|
|
58
71
|
declare function getRequestedExitCode(out: Out): number | undefined;
|
|
@@ -84,6 +97,13 @@ declare class OutputChannel implements Out {
|
|
|
84
97
|
* precedence).
|
|
85
98
|
*/
|
|
86
99
|
readonly isTTY: boolean;
|
|
100
|
+
/**
|
|
101
|
+
* Context-aware ANSI color palette.
|
|
102
|
+
*
|
|
103
|
+
* Enabled per the resolved `color` option — identity functions when
|
|
104
|
+
* colors are off, so handlers can style unconditionally.
|
|
105
|
+
*/
|
|
106
|
+
readonly color: Colors;
|
|
87
107
|
constructor(options: ResolvedOutputOptions);
|
|
88
108
|
/**
|
|
89
109
|
* Write to stdout (normal output). Always emitted.
|