@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.
Files changed (137) hide show
  1. package/CHANGELOG.md +37 -1
  2. package/dist/core/cli/dispatch.mjs +214 -1
  3. package/dist/core/cli/help-links.mjs +41 -1
  4. package/dist/core/cli/index.mjs +901 -1
  5. package/dist/core/cli/planner.mjs +300 -1
  6. package/dist/core/cli/plugin.mjs +41 -1
  7. package/dist/core/cli/propagate.mjs +57 -1
  8. package/dist/core/cli/root-help.mjs +208 -4
  9. package/dist/core/cli/root-surface.mjs +27 -1
  10. package/dist/core/cli/runtime-preflight.mjs +168 -1
  11. package/dist/core/completion/index.mjs +90 -1
  12. package/dist/core/completion/shells/bash.mjs +304 -3
  13. package/dist/core/completion/shells/fish.mjs +159 -2
  14. package/dist/core/completion/shells/powershell.mjs +353 -2
  15. package/dist/core/completion/shells/shared.mjs +154 -1
  16. package/dist/core/completion/shells/zsh.mjs +244 -2
  17. package/dist/core/config/index.mjs +246 -1
  18. package/dist/core/config/package-json.mjs +385 -3
  19. package/dist/core/errors/index.mjs +87 -1
  20. package/dist/core/execution/index.mjs +189 -1
  21. package/dist/core/help/ansi.mjs +122 -2
  22. package/dist/core/help/index.mjs +329 -7
  23. package/dist/core/json-schema/index.mjs +487 -9
  24. package/dist/core/json-schema/meta-descriptions.generated.mjs +93 -28
  25. package/dist/core/output/activity.mjs +452 -1
  26. package/dist/core/output/bind.mjs +56 -1
  27. package/dist/core/output/contracts.mjs +57 -1
  28. package/dist/core/output/display-value.mjs +32 -1
  29. package/dist/core/output/index.d.mts +21 -0
  30. package/dist/core/output/index.mjs +442 -2
  31. package/dist/core/output/renderers.mjs +46 -1
  32. package/dist/core/output/writer.mjs +12 -1
  33. package/dist/core/parse/index.mjs +555 -1
  34. package/dist/core/prompt/index.d.mts +0 -1
  35. package/dist/core/prompt/index.mjs +348 -6
  36. package/dist/core/resolve/args.mjs +105 -1
  37. package/dist/core/resolve/coerce.mjs +279 -1
  38. package/dist/core/resolve/config.mjs +19 -1
  39. package/dist/core/resolve/errors.mjs +140 -2
  40. package/dist/core/resolve/flags.mjs +196 -1
  41. package/dist/core/resolve/index.mjs +85 -1
  42. package/dist/core/resolve/property.d.mts +0 -1
  43. package/dist/core/resolve/property.mjs +45 -1
  44. package/dist/core/schema/arg.mjs +463 -1
  45. package/dist/core/schema/command.d.mts +18 -0
  46. package/dist/core/schema/command.mjs +712 -1
  47. package/dist/core/schema/flag.mjs +453 -1
  48. package/dist/core/schema/middleware.mjs +41 -1
  49. package/dist/core/schema/number-constraints.mjs +60 -1
  50. package/dist/core/schema-dsl/runtime.mjs +271 -2
  51. package/dist/core/schema-dsl/to-json-schema.mjs +74 -1
  52. package/dist/core/testkit/index.mjs +83 -1
  53. package/dist/index.d.mts +2 -1
  54. package/dist/index.mjs +22 -1
  55. package/dist/runtime/adapter.mjs +82 -1
  56. package/dist/runtime/auto.mjs +46 -1
  57. package/dist/runtime/bun.mjs +28 -1
  58. package/dist/runtime/deno.mjs +217 -2
  59. package/dist/runtime/detect.mjs +45 -1
  60. package/dist/runtime/node.mjs +169 -2
  61. package/dist/runtime/paths.mjs +48 -1
  62. package/dist/runtime.mjs +7 -1
  63. package/dist/strings.mjs +22 -1
  64. package/dist/testkit.mjs +5 -1
  65. package/dist/version.d.mts +7 -3
  66. package/dist/version.mjs +7 -1
  67. package/package.json +21 -26
  68. package/src/core/cli/dispatch.ts +0 -355
  69. package/src/core/cli/help-links.ts +0 -82
  70. package/src/core/cli/index.ts +0 -1614
  71. package/src/core/cli/planner.ts +0 -656
  72. package/src/core/cli/plugin.ts +0 -117
  73. package/src/core/cli/propagate.ts +0 -97
  74. package/src/core/cli/root-help.ts +0 -342
  75. package/src/core/cli/root-surface.ts +0 -87
  76. package/src/core/cli/runtime-preflight.ts +0 -456
  77. package/src/core/completion/index.ts +0 -138
  78. package/src/core/completion/shells/bash.ts +0 -459
  79. package/src/core/completion/shells/fish.ts +0 -259
  80. package/src/core/completion/shells/powershell.ts +0 -439
  81. package/src/core/completion/shells/shared.ts +0 -310
  82. package/src/core/completion/shells/zsh.ts +0 -381
  83. package/src/core/config/index.ts +0 -417
  84. package/src/core/config/package-json.ts +0 -560
  85. package/src/core/errors/index.ts +0 -193
  86. package/src/core/execution/index.ts +0 -265
  87. package/src/core/help/ansi.ts +0 -144
  88. package/src/core/help/index.ts +0 -563
  89. package/src/core/json-schema/index.ts +0 -910
  90. package/src/core/json-schema/meta-descriptions.generated.ts +0 -202
  91. package/src/core/output/activity.ts +0 -575
  92. package/src/core/output/bind.ts +0 -59
  93. package/src/core/output/contracts.ts +0 -194
  94. package/src/core/output/display-value.ts +0 -48
  95. package/src/core/output/index.ts +0 -704
  96. package/src/core/output/renderers.ts +0 -125
  97. package/src/core/output/writer.ts +0 -46
  98. package/src/core/parse/index.ts +0 -742
  99. package/src/core/prompt/index.ts +0 -623
  100. package/src/core/resolve/args.ts +0 -144
  101. package/src/core/resolve/coerce.ts +0 -500
  102. package/src/core/resolve/config.ts +0 -26
  103. package/src/core/resolve/contracts.ts +0 -135
  104. package/src/core/resolve/errors.ts +0 -227
  105. package/src/core/resolve/flags.ts +0 -269
  106. package/src/core/resolve/index.ts +0 -108
  107. package/src/core/resolve/property.ts +0 -99
  108. package/src/core/schema/activity.ts +0 -240
  109. package/src/core/schema/arg.ts +0 -841
  110. package/src/core/schema/command.ts +0 -1500
  111. package/src/core/schema/flag.ts +0 -917
  112. package/src/core/schema/index.ts +0 -96
  113. package/src/core/schema/middleware.ts +0 -171
  114. package/src/core/schema/number-constraints.ts +0 -153
  115. package/src/core/schema/prompt.ts +0 -171
  116. package/src/core/schema/run.ts +0 -198
  117. package/src/core/schema-dsl/index.ts +0 -109
  118. package/src/core/schema-dsl/parse.ts +0 -262
  119. package/src/core/schema-dsl/runtime.ts +0 -609
  120. package/src/core/schema-dsl/to-json-schema.ts +0 -102
  121. package/src/core/testkit/index.ts +0 -147
  122. package/src/index.ts +0 -181
  123. package/src/runtime/adapter.ts +0 -303
  124. package/src/runtime/auto.ts +0 -86
  125. package/src/runtime/bun.ts +0 -48
  126. package/src/runtime/deno.ts +0 -367
  127. package/src/runtime/detect.ts +0 -105
  128. package/src/runtime/index.ts +0 -21
  129. package/src/runtime/node-builtins.d.ts +0 -27
  130. package/src/runtime/node.ts +0 -289
  131. package/src/runtime/paths.ts +0 -64
  132. package/src/runtime/support.ts +0 -77
  133. package/src/runtime.ts +0 -31
  134. package/src/schema.ts +0 -16
  135. package/src/strings.ts +0 -34
  136. package/src/testkit.ts +0 -25
  137. package/src/version.ts +0 -20
@@ -1,417 +0,0 @@
1
- /**
2
- * Config file discovery and loading.
3
- *
4
- * Probes a prioritised list of candidate paths, reads the first match via
5
- * {@link RuntimeAdapter.readFile}, and parses the content using an
6
- * extension-based loader (JSON built-in, others additive via {@link FormatLoader}).
7
- *
8
- * The module is pure — all I/O flows through the adapter, making it fully
9
- * testable with {@link createTestAdapter}'s virtual filesystem.
10
- *
11
- * @module dreamcli/core/config
12
- */
13
-
14
- import { CLIError } from '#internals/core/errors/index.ts';
15
- import type { RuntimeAdapter } from '#internals/runtime/adapter.ts';
16
-
17
- /** @internal */
18
- function isPlainObject(value: unknown): value is Record<string, unknown> {
19
- if (typeof value !== 'object' || value === null || Array.isArray(value)) {
20
- return false;
21
- }
22
- const proto = Object.getPrototypeOf(value);
23
- return proto === Object.prototype || proto === null;
24
- }
25
-
26
- // --- Types — format loaders
27
-
28
- /**
29
- * Format loader — parses file content into a config object.
30
- *
31
- * Register custom config formats by providing file extensions and a parser.
32
- * Parsers may return any parsed value; {@link discoverConfig} validates that
33
- * the result is a plain object before feeding it into the resolution chain.
34
- *
35
- * Implementations should throw on syntax or shape errors; the caller wraps
36
- * those failures as {@link CLIError} with code `CONFIG_PARSE_ERROR`.
37
- */
38
- interface FormatLoader {
39
- /** File extensions this loader handles (without leading dot, e.g. `'toml'`). */
40
- readonly extensions: readonly string[];
41
-
42
- /**
43
- * Parse file content into a config value.
44
- *
45
- * Arrays, primitives, and `null` are allowed at this boundary so generic
46
- * parsers like `Bun.YAML.parse` can be passed directly. Those values are
47
- * still rejected by {@link discoverConfig}, which requires a plain object.
48
- */
49
- readonly parse: (content: string) => unknown;
50
- }
51
-
52
- // --- Types — discovery options + result
53
-
54
- /** Options for {@link discoverConfig}. */
55
- interface ConfigDiscoveryOptions {
56
- /**
57
- * Explicit config file path (`--config` override).
58
- * When provided, skips search — loads only this path.
59
- */
60
- readonly configPath?: string;
61
-
62
- /**
63
- * Additional format loaders (JSON is built-in).
64
- * Later loaders for the same extension win (allows override).
65
- */
66
- readonly loaders?: readonly FormatLoader[];
67
-
68
- /**
69
- * Custom search paths (absolute).
70
- * Replaces the default search paths when provided.
71
- * Probed in order; first found wins.
72
- */
73
- readonly searchPaths?: readonly string[];
74
- }
75
-
76
- /** Successful config discovery — file found and parsed. */
77
- interface ConfigFound {
78
- /** Discriminant — `true` indicates a config file was found and parsed successfully. */
79
- readonly found: true;
80
- /** Absolute path to the config file that was loaded. */
81
- readonly path: string;
82
- /** Parsed config data. */
83
- readonly data: Readonly<Record<string, unknown>>;
84
- /** File extension that determined the loader (e.g. `'json'`). */
85
- readonly format: string;
86
- }
87
-
88
- /** No config file found at any candidate path (not an error). */
89
- interface ConfigNotFound {
90
- /** Discriminant — `false` indicates no config file exists at any candidate path. */
91
- readonly found: false;
92
- }
93
-
94
- /** Discriminated result of config discovery. */
95
- type ConfigDiscoveryResult = ConfigFound | ConfigNotFound;
96
-
97
- // --- Built-in JSON loader
98
-
99
- /** @internal */
100
- const jsonLoader: FormatLoader = {
101
- extensions: ['json'],
102
- parse: (content: string): Record<string, unknown> => {
103
- const parsed: unknown = JSON.parse(content);
104
- if (typeof parsed !== 'object' || parsed === null || Array.isArray(parsed)) {
105
- throw new Error('Config must be a JSON object');
106
- }
107
- return parsed as Record<string, unknown>;
108
- },
109
- };
110
-
111
- // --- Path utilities
112
-
113
- /**
114
- * Join path segments using the separator detected from the base path.
115
- *
116
- * Avoids importing `node:path` — the base path is already platform-native
117
- * (comes from `adapter.cwd` / `adapter.configDir`), so we infer the
118
- * separator from its content.
119
- *
120
- * @internal
121
- */
122
- function joinPath(base: string, ...segments: readonly string[]): string {
123
- const sep = base.includes('\\') ? '\\' : '/';
124
- return [base, ...segments].join(sep);
125
- }
126
-
127
- /**
128
- * Extract the file extension (without leading dot, lowercased).
129
- * Returns empty string when no extension is present.
130
- *
131
- * @internal
132
- */
133
- function getExtension(path: string): string {
134
- const lastDot = path.lastIndexOf('.');
135
- const lastSep = Math.max(path.lastIndexOf('/'), path.lastIndexOf('\\'));
136
- if (lastDot <= lastSep) return '';
137
- return path.slice(lastDot + 1).toLowerCase();
138
- }
139
-
140
- // --- buildConfigSearchPaths
141
-
142
- /**
143
- * Build the default config search paths for an app.
144
- *
145
- * Advanced helper used by DreamCLI's config discovery. Most apps should call
146
- * `.config()` or {@link discoverConfig} instead of constructing search paths
147
- * manually. Exported for debugging, custom discovery flows, and help text.
148
- *
149
- * Search order (first match wins):
150
- * 1. `$CWD/.{appName}.json` — dotfile in project root
151
- * 2. `$CWD/{appName}.config.json` — explicit config in project root
152
- * 3. `$CONFIG_DIR/{appName}/config.json` — XDG / AppData standard
153
- * (`$XDG_CONFIG_HOME` / `~/.config` on Unix,
154
- * `%APPDATA%` / `%USERPROFILE%\\AppData\\Roaming` on Windows)
155
- *
156
- * When custom {@link ConfigDiscoveryOptions.loaders | loaders} are registered,
157
- * each path pattern is repeated per supported extension (JSON always first).
158
- *
159
- * @param appName - CLI application name used to derive config filenames.
160
- * @param cwd - Current working directory (project-root search location).
161
- * @param configDir - Platform config directory (XDG / AppData).
162
- * @param loaders - Optional custom {@link FormatLoader}s whose extensions expand the search set.
163
- * @returns Ordered list of candidate config file paths (first match wins).
164
- *
165
- * @example
166
- * ```ts
167
- * const paths = buildConfigSearchPaths('mycli', '/repo', '/home/me/.config');
168
- * ```
169
- */
170
- function buildConfigSearchPaths(
171
- appName: string,
172
- cwd: string,
173
- configDir: string,
174
- loaders?: readonly FormatLoader[],
175
- ): readonly string[] {
176
- const extensions = buildExtensionList(loaders);
177
-
178
- const paths: string[] = [];
179
- for (const ext of extensions) {
180
- paths.push(joinPath(cwd, `.${appName}.${ext}`));
181
- }
182
- for (const ext of extensions) {
183
- paths.push(joinPath(cwd, `${appName}.config.${ext}`));
184
- }
185
- for (const ext of extensions) {
186
- paths.push(joinPath(configDir, appName, `config.${ext}`));
187
- }
188
- return paths;
189
- }
190
-
191
- /**
192
- * Collect unique extensions from the built-in JSON loader + any custom loaders.
193
- * JSON always comes first. Order otherwise matches loader registration order.
194
- *
195
- * @param loaders - Optional custom {@link FormatLoader}s to append after JSON.
196
- * @returns Deduplicated, lowercased extension list (JSON first).
197
- *
198
- * @internal
199
- */
200
- function buildExtensionList(loaders?: readonly FormatLoader[]): readonly string[] {
201
- const seen = new Set<string>();
202
- const result: string[] = [];
203
-
204
- // JSON first — always built-in
205
- for (const ext of jsonLoader.extensions) {
206
- const lower = ext.toLowerCase();
207
- if (!seen.has(lower)) {
208
- seen.add(lower);
209
- result.push(lower);
210
- }
211
- }
212
-
213
- // Additional loaders
214
- if (loaders !== undefined) {
215
- for (const loader of loaders) {
216
- for (const ext of loader.extensions) {
217
- const lower = ext.toLowerCase();
218
- if (!seen.has(lower)) {
219
- seen.add(lower);
220
- result.push(lower);
221
- }
222
- }
223
- }
224
- }
225
-
226
- return result;
227
- }
228
-
229
- // --- buildLoaderMap
230
-
231
- /**
232
- * Build extension → loader lookup. Later loaders for the same extension
233
- * override earlier ones (allows user to replace the built-in JSON loader).
234
- *
235
- * @param loaders - Optional custom {@link FormatLoader}s (later entries override earlier for same extension).
236
- * @returns Map from lowercased extension to its {@link FormatLoader}.
237
- *
238
- * @internal
239
- */
240
- function buildLoaderMap(loaders?: readonly FormatLoader[]): ReadonlyMap<string, FormatLoader> {
241
- const map = new Map<string, FormatLoader>();
242
- for (const ext of jsonLoader.extensions) {
243
- map.set(ext.toLowerCase(), jsonLoader);
244
- }
245
- if (loaders !== undefined) {
246
- for (const loader of loaders) {
247
- for (const ext of loader.extensions) {
248
- map.set(ext.toLowerCase(), loader);
249
- }
250
- }
251
- }
252
- return map;
253
- }
254
-
255
- // --- discoverConfig
256
-
257
- /**
258
- * The subset of {@link RuntimeAdapter} needed for config discovery.
259
- *
260
- * Exported so custom hosts and tests can type the minimal adapter required by
261
- * {@link discoverConfig} without depending on the full runtime adapter shape.
262
- */
263
- type ConfigAdapter = Pick<RuntimeAdapter, 'readFile' | 'cwd' | 'configDir'>;
264
-
265
- /**
266
- * Discover and load a config file.
267
- *
268
- * Low-level discovery helper behind `CLIBuilder.config()`. Most apps should
269
- * let the CLI runtime call this automatically; call it directly when testing
270
- * config behavior or building custom bootstrapping around {@linkcode RuntimeAdapter}.
271
- *
272
- * Pure function — all filesystem I/O flows through `adapter.readFile`.
273
- * Returns a discriminated union: `{ found: true, ... }` when a config
274
- * file was found and parsed, `{ found: false }` when no file exists.
275
- *
276
- * @throws {CLIError} code `CONFIG_NOT_FOUND` — explicit `configPath` doesn't exist
277
- * @throws {CLIError} code `CONFIG_PARSE_ERROR` — file exists but fails to parse
278
- * @throws {CLIError} code `CONFIG_UNKNOWN_FORMAT` — no loader for the file extension
279
- *
280
- * @example
281
- * ```ts
282
- * const result = await discoverConfig('mycli', adapter, {
283
- * loaders: [
284
- * configFormat(['yaml', 'yml'], Bun.YAML.parse),
285
- * configFormat(['toml'], Bun.TOML.parse),
286
- * ],
287
- * });
288
- * ```
289
- */
290
- async function discoverConfig(
291
- appName: string,
292
- adapter: ConfigAdapter,
293
- options?: ConfigDiscoveryOptions,
294
- ): Promise<ConfigDiscoveryResult> {
295
- const loaderMap = buildLoaderMap(options?.loaders);
296
-
297
- const searchPaths =
298
- options?.configPath !== undefined
299
- ? [options.configPath]
300
- : (options?.searchPaths ??
301
- buildConfigSearchPaths(appName, adapter.cwd, adapter.configDir, options?.loaders));
302
-
303
- for (const candidatePath of searchPaths) {
304
- const content = await adapter.readFile(candidatePath);
305
-
306
- if (content === null) {
307
- // Explicit --config path must exist
308
- if (options?.configPath !== undefined) {
309
- throw new CLIError(`Config file not found: ${candidatePath}`, {
310
- code: 'CONFIG_NOT_FOUND',
311
- details: { path: candidatePath },
312
- suggest: 'Create the config file or remove the --config flag',
313
- });
314
- }
315
- continue;
316
- }
317
-
318
- // File found — resolve loader by extension
319
- const ext = getExtension(candidatePath);
320
- const loader = loaderMap.get(ext);
321
-
322
- if (loader === undefined) {
323
- throw new CLIError(`No loader registered for config format: .${ext}`, {
324
- code: 'CONFIG_UNKNOWN_FORMAT',
325
- details: { path: candidatePath, extension: ext },
326
- suggest: `Supported formats: ${[...loaderMap.keys()].join(', ')}`,
327
- });
328
- }
329
-
330
- try {
331
- const data = loader.parse(content);
332
- if (!isPlainObject(data)) {
333
- throw new Error('Config loader must return a plain object');
334
- }
335
- return { found: true, path: candidatePath, data, format: ext };
336
- } catch (cause: unknown) {
337
- throw new CLIError(`Failed to parse config file: ${candidatePath}`, {
338
- code: 'CONFIG_PARSE_ERROR',
339
- cause,
340
- details: {
341
- path: candidatePath,
342
- format: ext,
343
- message: cause instanceof Error ? cause.message : String(cause),
344
- },
345
- suggest: 'Check the config file for syntax errors',
346
- });
347
- }
348
- }
349
-
350
- return { found: false };
351
- }
352
-
353
- // --- configFormat — convenience factory for FormatLoader
354
-
355
- /**
356
- * Create a {@link FormatLoader} from extensions and a parse function.
357
- *
358
- * Convenience factory for config loading. It avoids manually constructing the
359
- * `{ extensions, parse }` object and makes intent clearer at call sites.
360
- *
361
- * Later loaders registered for the same extension override earlier ones. Any
362
- * error thrown by `parse` is wrapped by {@link discoverConfig} as
363
- * `CONFIG_PARSE_ERROR`.
364
- *
365
- * @param extensions - File extensions this loader handles (without dot, e.g. `'yaml'`).
366
- * @param parse - Parse function: takes file content string and returns a parsed config value.
367
- * @returns A {@link FormatLoader} ready to pass to {@link ConfigDiscoveryOptions.loaders}.
368
- *
369
- * @example
370
- * ```ts
371
- * import { cli, configFormat } from '@kjanat/dreamcli';
372
- * import { parse as parseYaml } from 'yaml';
373
- * import { parse as parseTOML } from '@iarna/toml';
374
- *
375
- * const yamlPackageLoader = configFormat(['yaml', 'yml'], parseYaml);
376
- * const tomlPackageLoader = configFormat(['toml'], parseTOML);
377
- * // Or with Bun's built-in parsers:
378
- * // const yamlLoader = configFormat(['yaml', 'yml'], Bun.YAML.parse);
379
- * // const tomlLoader = configFormat(['toml'], Bun.TOML.parse);
380
- *
381
- * cli('myapp')
382
- * .config('myapp')
383
- * .configLoader(yamlLoader)
384
- * .configLoader(tomlLoader)
385
- * .run();
386
- * ```
387
- */
388
- function configFormat(
389
- extensions: readonly string[],
390
- parse: (content: string) => unknown,
391
- ): FormatLoader {
392
- return { extensions, parse };
393
- }
394
-
395
- // --- Exports
396
-
397
- export type {
398
- ManifestDiscoveryOptions,
399
- PackageJsonAdapter,
400
- PackageJsonData,
401
- PackageRepository,
402
- } from './package-json.ts';
403
- export {
404
- discoverManifest,
405
- discoverPackageJson,
406
- inferCliName,
407
- packageRepositoryUrl,
408
- } from './package-json.ts';
409
- export type {
410
- ConfigAdapter,
411
- ConfigDiscoveryOptions,
412
- ConfigDiscoveryResult,
413
- ConfigFound,
414
- ConfigNotFound,
415
- FormatLoader,
416
- };
417
- export { buildConfigSearchPaths, configFormat, discoverConfig };