@kjanat/dreamcli 4.0.0-rc.3 → 4.1.0

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.
Files changed (212) hide show
  1. package/README.md +5 -7
  2. package/dist/{runtime/adapter.d.mts → adapter-YM5QGi3M.d.mts} +4 -4
  3. package/dist/completion-CUMeOnAz.mjs +6 -0
  4. package/dist/completion.d.mts +90 -0
  5. package/dist/completion.mjs +1 -0
  6. package/dist/config-CrlScpYX.mjs +1 -0
  7. package/dist/config.d.mts +2 -0
  8. package/dist/config.mjs +1 -0
  9. package/dist/core-DvXUolc_.mjs +17 -0
  10. package/dist/{core/json-schema/index.d.mts → index-3l8uj16E.d.mts} +43 -34
  11. package/dist/{core/cli/index.d.mts → index-BAj2y70U.d.mts} +116 -57
  12. package/dist/index-BziI2aKc.d.mts +5440 -0
  13. package/dist/index-Cap0MA2V.d.mts +277 -0
  14. package/dist/index-Cp9kt2t-.d.mts +370 -0
  15. package/dist/index-DWsnGZlx.d.mts +831 -0
  16. package/dist/index.d.mts +190 -41
  17. package/dist/index.mjs +1 -26
  18. package/dist/json-schema-DRlrz_IV.mjs +52 -0
  19. package/dist/json-schema.d.mts +2 -0
  20. package/dist/json-schema.mjs +1 -0
  21. package/dist/package-json-BgE9YjjQ.mjs +3 -0
  22. package/dist/prompt.d.mts +48 -0
  23. package/dist/prompt.mjs +1 -0
  24. package/dist/rolldown-runtime-G4Kt5YOX.mjs +1 -0
  25. package/dist/runtime.d.mts +2 -6
  26. package/dist/runtime.mjs +1 -6
  27. package/dist/terminal-C8KTXjv5.mjs +6 -0
  28. package/dist/test-prompter-v__jT2yG.mjs +1 -0
  29. package/dist/testkit.d.mts +54 -6
  30. package/dist/testkit.mjs +1 -5
  31. package/dist/version.mjs +1 -7
  32. package/dreamcli.schema.json +697 -538
  33. package/package.json +29 -7
  34. package/skills/cli-creation/SKILL.md +16 -11
  35. package/CHANGELOG.md +0 -1116
  36. package/dist/core/cli/builtins.d.mts +0 -117
  37. package/dist/core/cli/builtins.mjs +0 -135
  38. package/dist/core/cli/compiled.d.mts +0 -66
  39. package/dist/core/cli/compiled.mjs +0 -76
  40. package/dist/core/cli/dispatch.d.mts +0 -115
  41. package/dist/core/cli/dispatch.mjs +0 -205
  42. package/dist/core/cli/help-links.d.mts +0 -27
  43. package/dist/core/cli/help-links.mjs +0 -41
  44. package/dist/core/cli/index.mjs +0 -1271
  45. package/dist/core/cli/planner.d.mts +0 -174
  46. package/dist/core/cli/planner.mjs +0 -323
  47. package/dist/core/cli/plugin.d.mts +0 -94
  48. package/dist/core/cli/plugin.mjs +0 -41
  49. package/dist/core/cli/propagate.d.mts +0 -39
  50. package/dist/core/cli/propagate.mjs +0 -57
  51. package/dist/core/cli/reserved-flags.d.mts +0 -19
  52. package/dist/core/cli/reserved-flags.mjs +0 -158
  53. package/dist/core/cli/root-help.d.mts +0 -53
  54. package/dist/core/cli/root-help.mjs +0 -221
  55. package/dist/core/cli/root-output-flags.d.mts +0 -74
  56. package/dist/core/cli/root-output-flags.mjs +0 -169
  57. package/dist/core/cli/root-surface.d.mts +0 -64
  58. package/dist/core/cli/root-surface.mjs +0 -28
  59. package/dist/core/cli/runtime-preflight.d.mts +0 -213
  60. package/dist/core/cli/runtime-preflight.mjs +0 -221
  61. package/dist/core/completion/index.d.mts +0 -76
  62. package/dist/core/completion/index.mjs +0 -90
  63. package/dist/core/completion/shells/bash.d.mts +0 -23
  64. package/dist/core/completion/shells/bash.mjs +0 -312
  65. package/dist/core/completion/shells/fish.d.mts +0 -19
  66. package/dist/core/completion/shells/fish.mjs +0 -164
  67. package/dist/core/completion/shells/powershell.d.mts +0 -13
  68. package/dist/core/completion/shells/powershell.mjs +0 -360
  69. package/dist/core/completion/shells/shared.d.mts +0 -164
  70. package/dist/core/completion/shells/shared.mjs +0 -147
  71. package/dist/core/completion/shells/zsh.d.mts +0 -23
  72. package/dist/core/completion/shells/zsh.mjs +0 -256
  73. package/dist/core/config/index.d.mts +0 -191
  74. package/dist/core/config/index.mjs +0 -285
  75. package/dist/core/config/package-json.d.mts +0 -179
  76. package/dist/core/config/package-json.mjs +0 -353
  77. package/dist/core/errors/index.d.mts +0 -125
  78. package/dist/core/errors/index.mjs +0 -87
  79. package/dist/core/execution/index.d.mts +0 -61
  80. package/dist/core/execution/index.mjs +0 -220
  81. package/dist/core/help/ansi.d.mts +0 -84
  82. package/dist/core/help/ansi.mjs +0 -121
  83. package/dist/core/help/index.d.mts +0 -149
  84. package/dist/core/help/index.mjs +0 -418
  85. package/dist/core/help/theme.d.mts +0 -86
  86. package/dist/core/help/theme.mjs +0 -69
  87. package/dist/core/json-schema/index.mjs +0 -1008
  88. package/dist/core/json-schema/meta-descriptions.generated.d.mts +0 -274
  89. package/dist/core/json-schema/meta-descriptions.generated.mjs +0 -136
  90. package/dist/core/output/activity.d.mts +0 -193
  91. package/dist/core/output/activity.mjs +0 -452
  92. package/dist/core/output/bind.d.mts +0 -37
  93. package/dist/core/output/bind.mjs +0 -56
  94. package/dist/core/output/contracts.d.mts +0 -82
  95. package/dist/core/output/contracts.mjs +0 -57
  96. package/dist/core/output/display-value.d.mts +0 -19
  97. package/dist/core/output/display-value.mjs +0 -32
  98. package/dist/core/output/index.d.mts +0 -344
  99. package/dist/core/output/index.mjs +0 -514
  100. package/dist/core/output/renderers.d.mts +0 -45
  101. package/dist/core/output/renderers.mjs +0 -46
  102. package/dist/core/output/writer.d.mts +0 -39
  103. package/dist/core/output/writer.mjs +0 -12
  104. package/dist/core/parse/index.d.mts +0 -178
  105. package/dist/core/parse/index.mjs +0 -850
  106. package/dist/core/parse/occurrences.d.mts +0 -90
  107. package/dist/core/parse/occurrences.mjs +0 -114
  108. package/dist/core/prompt/index.d.mts +0 -213
  109. package/dist/core/prompt/index.mjs +0 -348
  110. package/dist/core/read-flags/index.d.mts +0 -150
  111. package/dist/core/read-flags/index.mjs +0 -217
  112. package/dist/core/resolve/args.d.mts +0 -39
  113. package/dist/core/resolve/args.mjs +0 -182
  114. package/dist/core/resolve/coerce.d.mts +0 -79
  115. package/dist/core/resolve/coerce.mjs +0 -900
  116. package/dist/core/resolve/config.d.mts +0 -10
  117. package/dist/core/resolve/config.mjs +0 -19
  118. package/dist/core/resolve/contracts.d.mts +0 -146
  119. package/dist/core/resolve/errors.d.mts +0 -10
  120. package/dist/core/resolve/errors.mjs +0 -148
  121. package/dist/core/resolve/flags.d.mts +0 -74
  122. package/dist/core/resolve/flags.mjs +0 -246
  123. package/dist/core/resolve/index.d.mts +0 -44
  124. package/dist/core/resolve/index.mjs +0 -123
  125. package/dist/core/resolve/path-checks.d.mts +0 -48
  126. package/dist/core/resolve/path-checks.mjs +0 -102
  127. package/dist/core/resolve/redaction.d.mts +0 -13
  128. package/dist/core/resolve/redaction.mjs +0 -14
  129. package/dist/core/resolve/stages.d.mts +0 -86
  130. package/dist/core/resolve/stages.mjs +0 -170
  131. package/dist/core/resolve/standard.d.mts +0 -26
  132. package/dist/core/resolve/standard.mjs +0 -212
  133. package/dist/core/schema/activity.d.mts +0 -189
  134. package/dist/core/schema/arg.d.mts +0 -1461
  135. package/dist/core/schema/arg.mjs +0 -1139
  136. package/dist/core/schema/brand.d.mts +0 -17
  137. package/dist/core/schema/cardinality.d.mts +0 -302
  138. package/dist/core/schema/cardinality.mjs +0 -514
  139. package/dist/core/schema/command.d.mts +0 -1132
  140. package/dist/core/schema/command.mjs +0 -999
  141. package/dist/core/schema/flag.d.mts +0 -1495
  142. package/dist/core/schema/flag.mjs +0 -1207
  143. package/dist/core/schema/index.d.mts +0 -15
  144. package/dist/core/schema/index.mjs +0 -10
  145. package/dist/core/schema/middleware.d.mts +0 -129
  146. package/dist/core/schema/middleware.mjs +0 -41
  147. package/dist/core/schema/number-constraints.d.mts +0 -96
  148. package/dist/core/schema/number-constraints.mjs +0 -60
  149. package/dist/core/schema/prompt.d.mts +0 -135
  150. package/dist/core/schema/provenance.d.mts +0 -99
  151. package/dist/core/schema/provenance.mjs +0 -28
  152. package/dist/core/schema/run.d.mts +0 -211
  153. package/dist/core/schema/source.d.mts +0 -180
  154. package/dist/core/schema/source.mjs +0 -206
  155. package/dist/core/schema/standard.d.mts +0 -100
  156. package/dist/core/schema/standard.mjs +0 -15
  157. package/dist/core/schema/stdin.d.mts +0 -97
  158. package/dist/core/schema/stdin.mjs +0 -91
  159. package/dist/core/schema/string-constraints.d.mts +0 -108
  160. package/dist/core/schema/string-constraints.mjs +0 -86
  161. package/dist/core/schema/value-parsers.d.mts +0 -150
  162. package/dist/core/schema/value-parsers.mjs +0 -160
  163. package/dist/core/schema/value.d.mts +0 -243
  164. package/dist/core/schema/value.mjs +0 -573
  165. package/dist/core/testkit/index.d.mts +0 -63
  166. package/dist/core/testkit/index.mjs +0 -102
  167. package/dist/runtime/adapter.mjs +0 -92
  168. package/dist/runtime/auto.d.mts +0 -25
  169. package/dist/runtime/auto.mjs +0 -45
  170. package/dist/runtime/deno.d.mts +0 -99
  171. package/dist/runtime/deno.mjs +0 -265
  172. package/dist/runtime/detect.d.mts +0 -86
  173. package/dist/runtime/detect.mjs +0 -45
  174. package/dist/runtime/index.d.mts +0 -6
  175. package/dist/runtime/node.d.mts +0 -71
  176. package/dist/runtime/node.mjs +0 -228
  177. package/dist/runtime/paths.d.mts +0 -31
  178. package/dist/runtime/paths.mjs +0 -48
  179. package/dist/strings.d.mts +0 -27
  180. package/dist/strings.mjs +0 -22
  181. package/examples/basic.ts +0 -37
  182. package/examples/flag-types.ts +0 -79
  183. package/examples/gh/package.json +0 -45
  184. package/examples/gh/src/commands/auth.ts +0 -66
  185. package/examples/gh/src/commands/issue.ts +0 -120
  186. package/examples/gh/src/commands/pr.ts +0 -125
  187. package/examples/gh/src/data/issues.yaml +0 -5
  188. package/examples/gh/src/data/issues.yaml.d.ts +0 -17
  189. package/examples/gh/src/data/pull-requests.yaml +0 -7
  190. package/examples/gh/src/data/pull-requests.yaml.d.ts +0 -18
  191. package/examples/gh/src/docs.ts +0 -11
  192. package/examples/gh/src/lib/auth.ts +0 -37
  193. package/examples/gh/src/lib/utils.ts +0 -17
  194. package/examples/gh/src/main.test.ts +0 -307
  195. package/examples/gh/src/main.ts +0 -46
  196. package/examples/help-config.ts +0 -43
  197. package/examples/interactive.ts +0 -67
  198. package/examples/json-mode.ts +0 -95
  199. package/examples/middleware.ts +0 -71
  200. package/examples/multi-command.ts +0 -66
  201. package/examples/output-extras.ts +0 -46
  202. package/examples/parser-control.ts +0 -40
  203. package/examples/pwsh-demo/README.md +0 -40
  204. package/examples/pwsh-demo/package.json +0 -41
  205. package/examples/pwsh-demo/pwsh-demo.cmd +0 -3
  206. package/examples/pwsh-demo/smoke-powershell.ps1 +0 -218
  207. package/examples/pwsh-demo/src/main.test.ts +0 -45
  208. package/examples/pwsh-demo/src/main.ts +0 -140
  209. package/examples/spinner-progress.ts +0 -49
  210. package/examples/standard-schema.ts +0 -45
  211. package/examples/testing.ts +0 -147
  212. package/examples/transport-launcher.ts +0 -85
@@ -1,86 +0,0 @@
1
- //#region src/runtime/detect.d.ts
2
- /**
3
- * Auto-detects the current JavaScript runtime environment.
4
- *
5
- * Uses `globalThis` feature detection (version globals) to identify
6
- * the runtime without importing platform-specific modules. This is
7
- * the recommended approach because each runtime defines a unique
8
- * global marker:
9
- *
10
- * - **Bun:** `globalThis.Bun.version` (string)
11
- * - **Deno:** `globalThis.Deno.version` (object with `deno` key)
12
- * - **Node:** `globalThis.process.versions.node` (string)
13
- *
14
- * Detection order matters: Bun provides a Node-compatible `process`
15
- * global, so it must be checked *before* Node to avoid misidentification.
16
- *
17
- * @module @kjanat/dreamcli/runtime/detect
18
- */
19
- /**
20
- * Known JavaScript runtime environments.
21
- *
22
- * - `'node'` — Node.js
23
- * - `'bun'` — Bun
24
- * - `'deno'` — Deno
25
- * - `'unknown'` — Unrecognized environment
26
- */
27
- type Runtime = 'node' | 'bun' | 'deno' | 'unknown';
28
- /**
29
- * All known runtime values as a readonly tuple.
30
- *
31
- * Useful for validation, iteration, and exhaustiveness checks.
32
- *
33
- * @example
34
- * ```ts
35
- * if (RUNTIMES.includes(value)) {
36
- * // value is a valid Runtime
37
- * }
38
- * ```
39
- */
40
- declare const RUNTIMES: readonly ['node', 'bun', 'deno', 'unknown'];
41
- /**
42
- * Minimal `globalThis` shape used for runtime detection.
43
- *
44
- * Each field is optional — only the present one identifies the runtime.
45
- * Typed as `unknown` where we only need truthiness; version fields are
46
- * typed just enough to distinguish runtimes safely.
47
- */
48
- interface GlobalForDetect {
49
- /** Present when running on Bun. */
50
- readonly Bun?: {
51
- readonly version?: string;
52
- };
53
- /** Present when running on Deno. */
54
- readonly Deno?: {
55
- readonly version?: {
56
- readonly deno?: string;
57
- };
58
- };
59
- /** Present on Node.js (and Bun, which mimics it). */
60
- readonly process?: {
61
- readonly versions?: {
62
- readonly node?: string;
63
- readonly bun?: string;
64
- };
65
- };
66
- }
67
- /**
68
- * Detect the current JavaScript runtime.
69
- *
70
- * Uses `globalThis` feature detection to identify the host runtime.
71
- * Detection order is significant: Bun is checked before Node because
72
- * Bun exposes a Node-compatible `process` global.
73
- *
74
- * @param globals - Override `globalThis` for testing. Production callers
75
- * should omit this parameter.
76
- * @returns The detected {@link Runtime} identifier.
77
- *
78
- * @example
79
- * ```ts
80
- * const rt = detectRuntime();
81
- * // rt === 'node' | 'bun' | 'deno' | 'unknown'
82
- * ```
83
- */
84
- declare function detectRuntime(globals?: GlobalForDetect): Runtime;
85
- //#endregion
86
- export { type GlobalForDetect, RUNTIMES, type Runtime, detectRuntime };
@@ -1,45 +0,0 @@
1
- //#region src/runtime/detect.ts
2
- /**
3
- * All known runtime values as a readonly tuple.
4
- *
5
- * Useful for validation, iteration, and exhaustiveness checks.
6
- *
7
- * @example
8
- * ```ts
9
- * if (RUNTIMES.includes(value)) {
10
- * // value is a valid Runtime
11
- * }
12
- * ```
13
- */
14
- const RUNTIMES = [
15
- "node",
16
- "bun",
17
- "deno",
18
- "unknown"
19
- ];
20
- /**
21
- * Detect the current JavaScript runtime.
22
- *
23
- * Uses `globalThis` feature detection to identify the host runtime.
24
- * Detection order is significant: Bun is checked before Node because
25
- * Bun exposes a Node-compatible `process` global.
26
- *
27
- * @param globals - Override `globalThis` for testing. Production callers
28
- * should omit this parameter.
29
- * @returns The detected {@link Runtime} identifier.
30
- *
31
- * @example
32
- * ```ts
33
- * const rt = detectRuntime();
34
- * // rt === 'node' | 'bun' | 'deno' | 'unknown'
35
- * ```
36
- */
37
- function detectRuntime(globals) {
38
- const g = globals ?? globalThis;
39
- if (typeof g.Bun?.version === "string") return "bun";
40
- if (typeof g.Deno?.version?.deno === "string") return "deno";
41
- if (typeof g.process?.versions?.node === "string") return "node";
42
- return "unknown";
43
- }
44
- //#endregion
45
- export { RUNTIMES, detectRuntime };
@@ -1,6 +0,0 @@
1
- import { ExitError, RuntimeAdapter, TerminalSize, TestAdapterOptions, createTestAdapter } from "./adapter.mjs";
2
- import { GlobalForDetect, RUNTIMES, Runtime, detectRuntime } from "./detect.mjs";
3
- import { createAdapter } from "./auto.mjs";
4
- import { DenoNamespace, createDenoAdapter } from "./deno.mjs";
5
- import { NodeProcess, createNodeAdapter } from "./node.mjs";
6
- export { type DenoNamespace, ExitError, type GlobalForDetect, type NodeProcess, RUNTIMES, type Runtime, type RuntimeAdapter, type TerminalSize, type TestAdapterOptions, createAdapter, createDenoAdapter, createNodeAdapter, createTestAdapter, detectRuntime };
@@ -1,71 +0,0 @@
1
- import { RuntimeAdapter } from "./adapter.mjs";
2
- //#region src/runtime/node.d.ts
3
- /**
4
- * Minimal subset of the Node.js `process` object needed by the adapter.
5
- *
6
- * We avoid importing `@types/node` to keep the core runtime-agnostic
7
- * at the type level. This interface declares only what `createNodeAdapter`
8
- * actually reads from the global.
9
- */
10
- interface NodeProcess {
11
- /** Raw process arguments (`[binary, script, ...userArgs]`). */
12
- readonly argv: readonly string[];
13
- /** Environment variables (values are `undefined` for unset keys). */
14
- readonly env: Readonly<Record<string, string | undefined>>;
15
- /** Runtime version strings — used for version-guard checks. */
16
- readonly versions?: {
17
- readonly node?: string;
18
- readonly bun?: string;
19
- };
20
- /** Return the current working directory. */
21
- cwd(): string;
22
- /** Platform identifier (e.g. `'linux'`, `'darwin'`, `'win32'`). */
23
- readonly platform: string;
24
- /** Standard input stream with TTY detection and async iteration. */
25
- readonly stdin: {
26
- readonly isTTY?: boolean;
27
- /** Async iterable for reading all of stdin (used by readStdin). */
28
- [Symbol.asyncIterator](): AsyncIterator<Uint8Array>;
29
- };
30
- /** Standard output stream with TTY detection and write. */
31
- readonly stdout: {
32
- readonly isTTY?: boolean;
33
- readonly columns?: number;
34
- readonly rows?: number;
35
- getWindowSize?(): readonly [number, number];
36
- on?(event: 'resize', listener: () => void): unknown;
37
- off?(event: 'resize', listener: () => void): unknown;
38
- removeListener?(event: 'resize', listener: () => void): unknown;
39
- write(data: string): unknown;
40
- };
41
- /** Standard error stream with write. */
42
- readonly stderr: {
43
- write(data: string): unknown;
44
- };
45
- /** Terminate the process with the given exit code. */
46
- exit(code: number): never;
47
- }
48
- /**
49
- * Create a runtime adapter backed by Node.js `process` globals.
50
- *
51
- * Reads `process.argv`, `process.env`, `process.cwd()`, and wraps
52
- * `process.stdout.write`/`process.stderr.write` as {@linkcode WriteFn} functions.
53
- *
54
- * Also works on Bun, which provides a Node-compatible `process` global.
55
- *
56
- * @param proc - Override the process object (useful for testing the adapter itself).
57
- * @returns A {@linkcode RuntimeAdapter} backed by Node.js process state.
58
- *
59
- * @example
60
- * ```ts
61
- * import { cli } from '@kjanat/dreamcli';
62
- * import { createNodeAdapter } from '@kjanat/dreamcli/runtime/node';
63
- *
64
- * cli('mycli')
65
- * .command(deploy)
66
- * .run({ adapter: createNodeAdapter() });
67
- * ```
68
- */
69
- declare function createNodeAdapter(proc?: NodeProcess): RuntimeAdapter;
70
- //#endregion
71
- export { type NodeProcess, createNodeAdapter };
@@ -1,228 +0,0 @@
1
- import { resolveConfigDirectory, resolveHomeDirectory } from "./paths.mjs";
2
- //#region src/runtime/node.ts
3
- /**
4
- * Access the global `process` object without importing `@types/node`.
5
- *
6
- * Cast through `unknown` to avoid TypeScript errors when `@types/node`
7
- * isn't installed. Safe because this adapter is only used on Node/Bun
8
- * where `globalThis.process` is always defined.
9
- *
10
- * @internal
11
- */
12
- function getNodeProcess() {
13
- return globalThis.process;
14
- }
15
- /**
16
- * Detect whether an unknown thrown value is a Node.js system error
17
- * with a string `code` property (e.g. `'ENOENT'`, `'EACCES'`).
18
- *
19
- * @internal
20
- */
21
- function isNodeSystemError(err) {
22
- if (typeof err !== "object" || err === null || !("code" in err)) return false;
23
- return typeof err.code === "string";
24
- }
25
- /**
26
- * Resolve the user's home directory from environment variables.
27
- *
28
- * **Windows** (`win32`): `USERPROFILE` → `HOMEDRIVE`+`HOMEPATH` (both required) → `HOME` → `C:\`
29
- * **Unix**: `HOME` → `/`
30
- *
31
- * `HOMEPATH` alone is never used — it is a relative fragment (e.g. `\Users\alice`) that only
32
- * makes sense when combined with `HOMEDRIVE` (e.g. `C:`). Using `HOMEPATH` without `HOMEDRIVE`
33
- * could resolve against the working drive, producing an incorrect path.
34
- *
35
- * We avoid importing `node:os` to keep the factory synchronous and
36
- * to maintain the pattern of deriving everything from the process object.
37
- *
38
- * @internal
39
- */
40
- function resolveHomedir(env, platform) {
41
- return resolveHomeDirectory(env, platform === "win32");
42
- }
43
- /**
44
- * Resolve the platform-specific user configuration directory.
45
- *
46
- * - Unix: `$XDG_CONFIG_HOME` (if set), otherwise `~/.config`
47
- * - Windows: `%APPDATA%` (if set), otherwise `~\AppData\Roaming`
48
- *
49
- * @internal
50
- */
51
- function resolveConfigDir(env, platform, homedir) {
52
- return resolveConfigDirectory(env, platform === "win32", homedir);
53
- }
54
- /**
55
- * Create a runtime adapter backed by Node.js `process` globals.
56
- *
57
- * Reads `process.argv`, `process.env`, `process.cwd()`, and wraps
58
- * `process.stdout.write`/`process.stderr.write` as {@linkcode WriteFn} functions.
59
- *
60
- * Also works on Bun, which provides a Node-compatible `process` global.
61
- *
62
- * @param proc - Override the process object (useful for testing the adapter itself).
63
- * @returns A {@linkcode RuntimeAdapter} backed by Node.js process state.
64
- *
65
- * @example
66
- * ```ts
67
- * import { cli } from '@kjanat/dreamcli';
68
- * import { createNodeAdapter } from '@kjanat/dreamcli/runtime/node';
69
- *
70
- * cli('mycli')
71
- * .command(deploy)
72
- * .run({ adapter: createNodeAdapter() });
73
- * ```
74
- */
75
- function createNodeAdapter(proc) {
76
- const p = proc ?? getNodeProcess();
77
- const stdoutWrite = (data) => {
78
- p.stdout.write(data);
79
- };
80
- const stderrWrite = (data) => {
81
- p.stderr.write(data);
82
- };
83
- const stdinRead = createNodeReadLine(p);
84
- const readFile = async (path) => {
85
- const fs = await import("node:fs/promises");
86
- try {
87
- return await fs.readFile(path, "utf8");
88
- } catch (err) {
89
- if (isNodeSystemError(err) && err.code === "ENOENT") return null;
90
- throw err;
91
- }
92
- };
93
- const stat = async (path) => {
94
- const fs = await import("node:fs/promises");
95
- try {
96
- return (await fs.stat(path)).isDirectory() ? "directory" : "file";
97
- } catch (err) {
98
- if (isNodeSystemError(err) && (err.code === "ENOENT" || err.code === "ENOTDIR")) return null;
99
- throw err;
100
- }
101
- };
102
- const mkdir = async (path) => {
103
- await (await import("node:fs/promises")).mkdir(path, { recursive: true });
104
- };
105
- const homedir = resolveHomedir(p.env, p.platform);
106
- const configDir = resolveConfigDir(p.env, p.platform, homedir);
107
- const userConfigDirs = p.platform === "darwin" ? [configDir, `${homedir}/Library/Application Support`] : [configDir];
108
- const systemConfigDirs = p.platform === "win32" ? [] : ["/etc"];
109
- const stdinIsTTY = p.stdin.isTTY === true;
110
- return {
111
- argv: p.argv,
112
- env: p.env,
113
- cwd: p.cwd(),
114
- stdout: stdoutWrite,
115
- stderr: stderrWrite,
116
- stdin: stdinRead,
117
- readStdin: () => readNodeStdinAll(p, stdinIsTTY),
118
- isTTY: p.stdout.isTTY === true,
119
- stdinIsTTY,
120
- getTerminalSize: () => readNodeTerminalSize(p),
121
- onTerminalResize: (listener) => onNodeTerminalResize(p, listener),
122
- exit: (code) => p.exit(code),
123
- readFile,
124
- stat,
125
- mkdir,
126
- homedir,
127
- configDir,
128
- userConfigDirs,
129
- systemConfigDirs
130
- };
131
- }
132
- /** Normalize terminal dimensions and discard unusable values. @internal */
133
- function normalizeTerminalSize(columns, rows) {
134
- if (columns === void 0 || rows === void 0) return void 0;
135
- if (!Number.isFinite(columns) || !Number.isFinite(rows)) return void 0;
136
- if (columns <= 0 || rows <= 0) return void 0;
137
- return {
138
- columns,
139
- rows
140
- };
141
- }
142
- /** Read Node/Bun terminal dimensions from stdout. @internal */
143
- function readNodeTerminalSize(proc) {
144
- if (proc.stdout.isTTY !== true) return void 0;
145
- try {
146
- const size = proc.stdout.getWindowSize?.();
147
- if (size !== void 0) {
148
- const [columns, rows] = size;
149
- const normalized = normalizeTerminalSize(columns, rows);
150
- if (normalized !== void 0) return normalized;
151
- }
152
- } catch {}
153
- return normalizeTerminalSize(proc.stdout.columns, proc.stdout.rows);
154
- }
155
- /** Subscribe to Node/Bun stdout resize events when available. @internal */
156
- function onNodeTerminalResize(proc, listener) {
157
- if (proc.stdout.isTTY !== true || proc.stdout.on === void 0) return void 0;
158
- if (proc.stdout.off !== void 0) {
159
- proc.stdout.on("resize", listener);
160
- return () => {
161
- proc.stdout.off?.("resize", listener);
162
- };
163
- }
164
- if (proc.stdout.removeListener !== void 0) {
165
- proc.stdout.on("resize", listener);
166
- return () => {
167
- proc.stdout.removeListener?.("resize", listener);
168
- };
169
- }
170
- }
171
- /**
172
- * Read all of stdin as a single string (for piped data).
173
- *
174
- * Returns `null` immediately if stdin is a TTY — the user is typing
175
- * interactively, so there's no piped data to consume. When stdin is
176
- * piped, collects all chunks via the async iterator until EOF and
177
- * returns the decoded string, which may be empty for an empty pipe.
178
- *
179
- * @internal
180
- */
181
- async function readNodeStdinAll(proc, stdinIsTTY) {
182
- if (stdinIsTTY) return null;
183
- const chunks = [];
184
- const decoder = new TextDecoder();
185
- for await (const chunk of proc.stdin) chunks.push(decoder.decode(chunk, { stream: true }));
186
- chunks.push(decoder.decode());
187
- return chunks.join("");
188
- }
189
- /**
190
- * Read a single line from Node's stdin via its async iterator.
191
- *
192
- * Iterates stdin chunks manually (without `for-await` to avoid calling
193
- * `iterator.return()` which would close the stream). Returns `null`
194
- * on EOF.
195
- *
196
- * @internal
197
- */
198
- function createNodeReadLine(proc) {
199
- const iter = proc.stdin[Symbol.asyncIterator]();
200
- const decoder = new TextDecoder();
201
- let buffer = "";
202
- let done = false;
203
- return async () => {
204
- for (;;) {
205
- const nlIndex = buffer.indexOf("\n");
206
- if (nlIndex !== -1) {
207
- const line = buffer.slice(0, nlIndex).replace(/\r$/, "");
208
- buffer = buffer.slice(nlIndex + 1);
209
- return line;
210
- }
211
- if (done) {
212
- if (buffer.length === 0) return null;
213
- const line = buffer;
214
- buffer = "";
215
- return line;
216
- }
217
- const result = await iter.next();
218
- if (result.done) {
219
- buffer += decoder.decode();
220
- done = true;
221
- continue;
222
- }
223
- buffer += decoder.decode(result.value, { stream: true });
224
- }
225
- };
226
- }
227
- //#endregion
228
- export { createNodeAdapter };
@@ -1,31 +0,0 @@
1
- //#region src/runtime/paths.d.ts
2
- /**
3
- * Shared env-based path resolution for runtime adapters.
4
- *
5
- * Node, Bun, and Deno all need the same user home/config directory behavior.
6
- * These helpers keep the fallback chain identical across runtimes while
7
- * letting each adapter supply its own platform detection.
8
- *
9
- * @module @kjanat/dreamcli/runtime/paths
10
- */
11
- /**
12
- * Resolve the user's home directory from environment variables.
13
- *
14
- * @param env - Environment variable map.
15
- * @param isWindows - Whether the platform is Windows.
16
- * @returns Absolute path to the home directory.
17
- * @internal
18
- */
19
- declare function resolveHomeDirectory(env: Readonly<Record<string, string | undefined>>, isWindows: boolean): string;
20
- /**
21
- * Resolve the user's config directory (`XDG_CONFIG_HOME` / `APPDATA`).
22
- *
23
- * @param env - Environment variable map.
24
- * @param isWindows - Whether the platform is Windows.
25
- * @param homedir - Pre-resolved home directory (from {@link resolveHomeDirectory}).
26
- * @returns Absolute path to the config directory.
27
- * @internal
28
- */
29
- declare function resolveConfigDirectory(env: Readonly<Record<string, string | undefined>>, isWindows: boolean, homedir: string): string;
30
- //#endregion
31
- export { resolveConfigDirectory, resolveHomeDirectory };
@@ -1,48 +0,0 @@
1
- import { stripTrailing } from "../strings.mjs";
2
- //#region src/runtime/paths.ts
3
- /**
4
- * Shared env-based path resolution for runtime adapters.
5
- *
6
- * Node, Bun, and Deno all need the same user home/config directory behavior.
7
- * These helpers keep the fallback chain identical across runtimes while
8
- * letting each adapter supply its own platform detection.
9
- *
10
- * @module @kjanat/dreamcli/runtime/paths
11
- */
12
- /**
13
- * Resolve the user's home directory from environment variables.
14
- *
15
- * @param env - Environment variable map.
16
- * @param isWindows - Whether the platform is Windows.
17
- * @returns Absolute path to the home directory.
18
- * @internal
19
- */
20
- function resolveHomeDirectory(env, isWindows) {
21
- if (isWindows) {
22
- if (env.USERPROFILE) return env.USERPROFILE;
23
- if (env.HOMEDRIVE && env.HOMEPATH) return env.HOMEDRIVE + env.HOMEPATH;
24
- return env.HOME || "C:\\";
25
- }
26
- return env.HOME || "/";
27
- }
28
- /**
29
- * Resolve the user's config directory (`XDG_CONFIG_HOME` / `APPDATA`).
30
- *
31
- * @param env - Environment variable map.
32
- * @param isWindows - Whether the platform is Windows.
33
- * @param homedir - Pre-resolved home directory (from {@link resolveHomeDirectory}).
34
- * @returns Absolute path to the config directory.
35
- * @internal
36
- */
37
- function resolveConfigDirectory(env, isWindows, homedir) {
38
- if (isWindows) {
39
- if (env.APPDATA !== void 0 && env.APPDATA !== "") return env.APPDATA;
40
- return `${stripTrailing(homedir, [47, 92]) || homedir}\\AppData\\Roaming`;
41
- }
42
- const normalizedHome = stripTrailing(homedir, [47]);
43
- if (env.XDG_CONFIG_HOME !== void 0 && env.XDG_CONFIG_HOME !== "") return env.XDG_CONFIG_HOME;
44
- if (normalizedHome.length === 0) return "/.config";
45
- return `${normalizedHome}/.config`;
46
- }
47
- //#endregion
48
- export { resolveConfigDirectory, resolveHomeDirectory };
@@ -1,27 +0,0 @@
1
- //#region src/strings.d.ts
2
- /**
3
- * Internal string utilities shared across runtime and core modules.
4
- *
5
- * @module dreamcli/strings
6
- */
7
- /** Character code for `/` (forward slash). */
8
- declare const SLASH = 47;
9
- /** Character code for `\` (backslash). */
10
- declare const BACKSLASH = 92;
11
- /**
12
- * Remove trailing characters whose code points appear in `codes`.
13
- *
14
- * Linear-time replacement for trailing-character regexes such as
15
- * `/[\\/]+$/`. Those patterns are polynomial-ReDoS prone: the engine
16
- * greedily consumes the run, fails the end anchor, backtracks one
17
- * character at a time, and repeats that work from every start position —
18
- * O(n²) on adversarial input. This scan is O(n) with no backtracking.
19
- *
20
- * @param input - Source string.
21
- * @param codes - Character codes to strip from the end of `input`.
22
- * @returns `input` with all trailing matching characters removed.
23
- * @internal
24
- */
25
- declare function stripTrailing(input: string, codes: readonly number[]): string;
26
- //#endregion
27
- export { BACKSLASH, SLASH, stripTrailing };
package/dist/strings.mjs DELETED
@@ -1,22 +0,0 @@
1
- //#region src/strings.ts
2
- /**
3
- * Remove trailing characters whose code points appear in `codes`.
4
- *
5
- * Linear-time replacement for trailing-character regexes such as
6
- * `/[\\/]+$/`. Those patterns are polynomial-ReDoS prone: the engine
7
- * greedily consumes the run, fails the end anchor, backtracks one
8
- * character at a time, and repeats that work from every start position —
9
- * O(n²) on adversarial input. This scan is O(n) with no backtracking.
10
- *
11
- * @param input - Source string.
12
- * @param codes - Character codes to strip from the end of `input`.
13
- * @returns `input` with all trailing matching characters removed.
14
- * @internal
15
- */
16
- function stripTrailing(input, codes) {
17
- let end = input.length;
18
- while (end > 0 && codes.includes(input.charCodeAt(end - 1))) end -= 1;
19
- return end === input.length ? input : input.slice(0, end);
20
- }
21
- //#endregion
22
- export { stripTrailing };
package/examples/basic.ts DELETED
@@ -1,37 +0,0 @@
1
- #!/usr/bin/env bun
2
- /**
3
- * Basic single-command CLI.
4
- *
5
- * Demonstrates: typed positional args, typed flags, aliases, and default values.
6
- *
7
- * Usage:
8
- * npx tsx examples/basic.ts Alice
9
- * npx tsx examples/basic.ts Alice --loud --times 3
10
- * npx tsx examples/basic.ts Alice -l -t 3
11
- * npx tsx examples/basic.ts --help
12
- */
13
-
14
- import { arg, cli, command, flag } from '@kjanat/dreamcli';
15
-
16
- const greet = command('greet')
17
- .description('Greet someone')
18
- .example(({ name }) => `${name} greet Alice`, 'Greet Alice once')
19
- .example(({ name }) => `${name} greet Alice --loud --times 3`, 'Shout the greeting three times')
20
- .arg('name', arg.string().describe('Who to greet'))
21
- .flag('loud', flag.boolean().alias('l').describe('Shout the greeting'))
22
- .flag('times', flag.number().default(1).alias('t').describe('Repeat count'))
23
- .action(({ args, flags, out }) => {
24
- // args.name: string — required positional
25
- // flags.loud: boolean — defaults to false (all booleans do)
26
- // flags.times: number — defaults to 1 (never undefined)
27
- const repeatCount = Number.isFinite(flags.times)
28
- ? Math.max(0, Math.min(100, Math.floor(flags.times)))
29
- : 1;
30
-
31
- for (let i = 0; i < repeatCount; i++) {
32
- const msg = `Hello, ${args.name}!`;
33
- out.log(flags.loud ? msg.toUpperCase() : msg);
34
- }
35
- });
36
-
37
- void cli('greet').default(greet).run();
@@ -1,79 +0,0 @@
1
- #!/usr/bin/env bun
2
- /**
3
- * The v3 flag-type family in one command.
4
- *
5
- * Demonstrates: `flag.url()`, `flag.path()` with directory creation,
6
- * `flag.date()`, `flag.duration()`, `flag.bytes()`, `flag.count()`,
7
- * `flag.keyValue()`, string constraints, and array `.separator()`/`.unique()`.
8
- *
9
- * Usage:
10
- * npx tsx examples/flag-types.ts --endpoint https://api.example.com --name backup
11
- * npx tsx examples/flag-types.ts --name backup --out ./artifacts --timeout 1h30m --max-size 512mb
12
- * npx tsx examples/flag-types.ts --name backup --since 2026-01-01 --region us,eu --region us
13
- * npx tsx examples/flag-types.ts --name backup --label env=prod --label team=core -vvv
14
- * npx tsx examples/flag-types.ts --help
15
- */
16
-
17
- import { cli, command, flag } from '@kjanat/dreamcli';
18
-
19
- const snapshot = command('snapshot')
20
- .description('Create a snapshot with richly typed inputs')
21
- // URL — parses into a `URL`, protocol allowlist optional.
22
- .flag('endpoint', flag.url({ protocols: ['https'] }).describe('Upload endpoint'))
23
- // String constraints — checked at parse AND env/config/prompt resolution.
24
- .flag(
25
- 'name',
26
- flag
27
- .string({ nonEmpty: true, pattern: /^[a-z][a-z0-9-]*$/ })
28
- .required()
29
- .describe('Snapshot name (lowercase, kebab)'),
30
- )
31
- // Path — missing directory is created (mkdir -p) at resolution time.
32
- .flag(
33
- 'out',
34
- flag
35
- .path({ type: 'directory', create: true })
36
- .default('./snapshots')
37
- .describe('Output directory, created when missing'),
38
- )
39
- // Date — strict ISO-8601 into a `Date`; lenient Date.parse inputs rejected.
40
- .flag('since', flag.date().describe('Only include changes since this date'))
41
- // Duration — '90s', '1h30m', '250ms', or bare milliseconds → milliseconds.
42
- .flag('timeout', flag.duration().default(30_000).describe('Upload timeout'))
43
- // Bytes — '512mb', '1.5gb' (binary units) or bare bytes → bytes.
44
- .flag(
45
- 'max-size',
46
- flag
47
- .bytes()
48
- .default(256 * 1024 ** 2)
49
- .describe('Maximum snapshot size'),
50
- )
51
- // Count — occurrence counter: -v -vv -vvv → 1, 2, 3.
52
- .flag('verbose', flag.count().alias('v').describe('Increase verbosity'))
53
- // KeyValue — repeated KEY=VALUE merges into Record<string, string>.
54
- .flag('label', flag.keyValue().describe('Attach metadata labels'))
55
- // Array — separator splits each occurrence, unique dedupes the result.
56
- .flag(
57
- 'region',
58
- flag
59
- .array(flag.enum(['us', 'eu', 'ap']))
60
- .separator(',')
61
- .unique()
62
- .describe('Target regions'),
63
- )
64
- .action(({ flags, out }) => {
65
- out.status(`snapshot '${flags.name}' -> ${flags.out}`);
66
- out.json({
67
- name: flags.name,
68
- endpoint: flags.endpoint?.href,
69
- out: flags.out,
70
- since: flags.since?.toISOString(),
71
- timeoutMs: flags.timeout,
72
- maxSizeBytes: flags['max-size'],
73
- verbosity: flags.verbose,
74
- labels: flags.label,
75
- regions: flags.region,
76
- });
77
- });
78
-
79
- void cli('snapshot').version('1.0.0').default(snapshot).run();