@kjanat/dreamcli 4.0.0-rc.3 → 4.0.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-D0hbBNVB.d.mts} +2 -4
  3. package/dist/completion-D4mz6axB.mjs +6 -0
  4. package/dist/completion.d.mts +90 -0
  5. package/dist/completion.mjs +1 -0
  6. package/dist/config-B9ddC-Kb.mjs +1 -0
  7. package/dist/config.d.mts +2 -0
  8. package/dist/config.mjs +1 -0
  9. package/dist/core-Cp2w8vRq.mjs +17 -0
  10. package/dist/index-BziI2aKc.d.mts +5440 -0
  11. package/dist/index-DOfClfYR.d.mts +370 -0
  12. package/dist/index-DWsnGZlx.d.mts +831 -0
  13. package/dist/{core/cli/index.d.mts → index-DXROeDPC.d.mts} +116 -57
  14. package/dist/index-DndPmT8J.d.mts +275 -0
  15. package/dist/{core/json-schema/index.d.mts → index-DyoaS234.d.mts} +43 -34
  16. package/dist/index.d.mts +190 -41
  17. package/dist/index.mjs +1 -26
  18. package/dist/json-schema-C9SzZ7jY.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,221 +0,0 @@
1
- import { CLIError, ParseError } from "../errors/index.mjs";
2
- import { invocationSelectsStdin } from "../schema/source.mjs";
3
- import { parse } from "../parse/index.mjs";
4
- import { builtinEnabled } from "./builtins.mjs";
5
- import { createTerminalPrompter } from "../prompt/index.mjs";
6
- import { discoverManifest, inferCliName } from "../config/package-json.mjs";
7
- import { deriveHelpLinks } from "./help-links.mjs";
8
- import { readRootOutputFlags, resolveRootJsonMode, resolveRootVerbosity } from "./root-output-flags.mjs";
9
- import { planInvocation } from "./planner.mjs";
10
- import { assertNoReservedFlagCollisions } from "./reserved-flags.mjs";
11
- import { discoverConfig } from "../config/index.mjs";
12
- //#region src/core/cli/runtime-preflight.ts
13
- const PRECHECK_OUTPUT = {
14
- jsonMode: false,
15
- isTTY: false,
16
- verbosity: "normal"
17
- };
18
- /** Extract and strip valid runtime `--config` forms from argv, returning path + filtered tokens. @internal */
19
- function extractConfigFlag(argv) {
20
- const filteredArgv = [];
21
- let configPath;
22
- for (let i = 0; i < argv.length; i += 1) {
23
- const arg = argv[i];
24
- if (arg === void 0) continue;
25
- if (arg === "--") {
26
- filteredArgv.push(...argv.slice(i));
27
- break;
28
- }
29
- if (configPath === void 0 && arg.startsWith("--config=")) {
30
- const value = arg.slice(9);
31
- if (value.length > 0) {
32
- configPath = value;
33
- continue;
34
- }
35
- filteredArgv.push(arg);
36
- continue;
37
- }
38
- if (configPath === void 0 && arg === "--config") {
39
- const nextArg = argv[i + 1];
40
- if (nextArg !== void 0 && !nextArg.startsWith("-") && nextArg !== "--") {
41
- configPath = nextArg;
42
- i += 1;
43
- continue;
44
- }
45
- filteredArgv.push(arg);
46
- continue;
47
- }
48
- filteredArgv.push(arg);
49
- }
50
- return {
51
- configPath,
52
- filteredArgv
53
- };
54
- }
55
- /**
56
- * Check whether this invocation will actually select a stdin source.
57
- *
58
- * A `'dash'` binding is eligible when its token is `-`. A `'missing'` binding is
59
- * eligible when argv left the input absent; env, config, prompt, and default do
60
- * not suppress the read, because the stdin fallback outranks all four.
61
- *
62
- * @param schema - The matched command's merged schema.
63
- * @param argv - The command's own argv slice.
64
- * @param flagSettings - Parser behavior settings.
65
- * @param builtins - Which built-in flags the root still owns.
66
- * @returns `true` when at least one input would read stdin.
67
- * @internal
68
- */
69
- function commandInvocationNeedsStdin(schema, argv, flagSettings, builtins) {
70
- if (builtinEnabled(builtins, "help") && (argv.includes("--help") || argv.includes("-h"))) return false;
71
- try {
72
- const parsed = parse(schema, argv, flagSettings);
73
- return invocationSelectsStdin(schema.flags, schema.args, parsed);
74
- } catch (error) {
75
- if (error instanceof ParseError) return false;
76
- throw error;
77
- }
78
- }
79
- /** Plan the invocation and check whether the matched command needs stdin data. @internal */
80
- function invocationNeedsStdin(schema, compiled, argv) {
81
- const plan = planInvocation({
82
- schema,
83
- compiled,
84
- argv,
85
- help: { binName: schema.name },
86
- output: PRECHECK_OUTPUT
87
- });
88
- switch (plan.kind) {
89
- case "match": return commandInvocationNeedsStdin(plan.plan.mergedSchema, plan.plan.argv, schema.flagSettings, schema.builtins);
90
- case "dispatch-error":
91
- case "needs-subcommand":
92
- case "root-help":
93
- case "root-version":
94
- case "root-completions": return false;
95
- }
96
- }
97
- function isCompletionsInvocation(schema, compiled, argv) {
98
- if (!schema.hasBuiltInCompletions) return false;
99
- const plan = planInvocation({
100
- schema,
101
- compiled,
102
- argv,
103
- help: { binName: schema.name },
104
- output: PRECHECK_OUTPUT
105
- });
106
- return plan.kind === "match" && plan.plan.command.schema.name === "completions";
107
- }
108
- async function applyPackageJsonDiscovery(schema, adapter, inheritedName, isCompletions) {
109
- const packageJsonSettings = schema.packageJsonSettings;
110
- const packageSchema = packageJsonSettings !== void 0 && !isCompletions ? await (async () => {
111
- const pkg = packageJsonSettings.data ?? await discoverManifest(adapter, {
112
- ...packageJsonSettings.from !== void 0 ? { startDir: packageJsonSettings.from } : {},
113
- files: packageJsonSettings.files
114
- });
115
- if (pkg === null) return schema;
116
- const inferredName = packageJsonSettings.inferName ? inferCliName(pkg, { stripScope: packageJsonSettings.stripScope }) : void 0;
117
- return {
118
- ...schema,
119
- ...schema.version === void 0 && pkg.version !== void 0 ? { version: pkg.version } : {},
120
- ...schema.description === void 0 && pkg.description !== void 0 ? { description: pkg.description } : {},
121
- ...inferredName !== void 0 ? { name: inferredName } : {},
122
- helpLinks: deriveHelpLinks(schema.helpLinks, pkg, schema.version ?? pkg.version)
123
- };
124
- })() : schema;
125
- return inheritedName !== void 0 ? {
126
- ...packageSchema,
127
- name: inheritedName
128
- } : packageSchema;
129
- }
130
- /**
131
- * Re-run the `RESERVED_FLAG` guard when discovery supplied the version.
132
- *
133
- * `.manifest()` reads a version off the filesystem at `.run()` time, past every
134
- * build-time check, so a command flag spelling `--version` or `-V` as a name, an
135
- * alias, or a negated spelling would become unreachable without ever being
136
- * rejected. Running the same guard here fails the startup with the identical
137
- * error the build paths raise (#86), rendered like every other startup failure
138
- * rather than thrown at the caller.
139
- *
140
- * @param discovered - Schema after manifest discovery merged its metadata in.
141
- * @param declared - Schema as the builder had it before discovery.
142
- * @param compiled - Compiled graph carrying every registered command schema.
143
- * @returns The `RESERVED_FLAG` error for the first collision, or `undefined`.
144
- *
145
- * @internal
146
- */
147
- function discoveredVersionCollision(discovered, declared, compiled) {
148
- if (discovered.version === declared.version) return void 0;
149
- try {
150
- assertNoReservedFlagCollisions(discovered.version, [compiled.defaultCommand?.schema, ...compiled.commands.map((command) => command.schema)], discovered.builtins);
151
- return;
152
- } catch (error) {
153
- if (error instanceof CLIError) return error;
154
- throw error;
155
- }
156
- }
157
- async function loadRuntimeConfig(schema, adapter, configPath, isCompletions, existingConfig) {
158
- if (schema.configSettings === void 0 || isCompletions || existingConfig !== void 0) return existingConfig;
159
- try {
160
- const result = await discoverConfig(schema.configSettings.appName, adapter, {
161
- ...configPath !== void 0 ? { configPath } : {},
162
- ...schema.configSettings.loaders !== void 0 ? { loaders: schema.configSettings.loaders } : {}
163
- });
164
- return result.found ? result.data : void 0;
165
- } catch (error) {
166
- if (error instanceof CLIError) return error;
167
- throw error;
168
- }
169
- }
170
- /**
171
- * Run all adapter-driven sourcing work before command execution.
172
- *
173
- * Discovers config files, reads package.json metadata, detects stdin needs,
174
- * wires up the prompt engine, and resolves output policy overrides into a
175
- * single {@linkcode RuntimePreflightResult}.
176
- * @internal
177
- */
178
- async function prepareRuntimePreflight(options) {
179
- const rawArgv = options.adapter.argv.slice(2);
180
- const { configPath, filteredArgv } = options.schema.configSettings !== void 0 ? extractConfigFlag(rawArgv) : {
181
- configPath: void 0,
182
- filteredArgv: rawArgv
183
- };
184
- const rootOutputFlags = readRootOutputFlags(filteredArgv, options.schema.builtins);
185
- const jsonMode = resolveRootJsonMode(rootOutputFlags, options.options?.jsonMode);
186
- const verbosity = resolveRootVerbosity(rootOutputFlags, options.options?.verbosity) ?? "normal";
187
- const isCompletions = isCompletionsInvocation(options.schema, options.compiled, filteredArgv);
188
- const schema = await applyPackageJsonDiscovery(options.schema, options.adapter, options.inheritedName, isCompletions);
189
- const versionCollision = discoveredVersionCollision(schema, options.schema, options.compiled);
190
- if (versionCollision !== void 0) return {
191
- kind: "startup-error",
192
- error: versionCollision,
193
- jsonMode
194
- };
195
- const loadedConfig = await loadRuntimeConfig(schema, options.adapter, configPath, isCompletions, options.options?.config);
196
- if (loadedConfig instanceof CLIError) return {
197
- kind: "startup-error",
198
- error: loadedConfig,
199
- jsonMode
200
- };
201
- const autoPrompter = options.options?.prompter === void 0 && options.adapter.stdinIsTTY ? createTerminalPrompter(options.adapter.stdin, options.adapter.stderr) : void 0;
202
- const stdinData = options.options?.stdinData === void 0 && invocationNeedsStdin(schema, options.compiled, filteredArgv) ? await options.adapter.readStdin() : options.options?.stdinData;
203
- return {
204
- kind: "ready",
205
- schema,
206
- filteredArgv,
207
- inputs: {
208
- env: options.options?.env ?? options.adapter.env,
209
- isTTY: options.options?.isTTY ?? options.adapter.isTTY,
210
- jsonMode,
211
- verbosity,
212
- stat: options.options?.stat ?? options.adapter.stat,
213
- mkdir: options.options?.mkdir ?? options.adapter.mkdir,
214
- ...stdinData !== void 0 ? { stdinData } : {},
215
- ...options.options?.prompter !== void 0 ? { prompter: options.options.prompter } : autoPrompter !== void 0 ? { prompter: autoPrompter } : {},
216
- ...loadedConfig !== void 0 ? { config: loadedConfig } : {}
217
- }
218
- };
219
- }
220
- //#endregion
221
- export { commandInvocationNeedsStdin, extractConfigFlag, invocationNeedsStdin, prepareRuntimePreflight };
@@ -1,76 +0,0 @@
1
- import { CompletionOptions } from "./shells/shared.mjs";
2
- import { generateBashCompletion } from "./shells/bash.mjs";
3
- import { generateFishCompletion } from "./shells/fish.mjs";
4
- import { generatePowerShellCompletion } from "./shells/powershell.mjs";
5
- import { generateZshCompletion } from "./shells/zsh.mjs";
6
- import { CLISchema } from "../cli/index.mjs";
7
- //#region src/core/completion/index.d.ts
8
- /**
9
- * Supported shell targets for completion script generation.
10
- *
11
- * `bash`, `zsh`, `fish`, and `powershell` are implemented today.
12
- */
13
- type Shell = 'bash' | 'zsh' | 'fish' | 'powershell';
14
- /**
15
- * Implemented shell values as a frozen readonly non-empty tuple.
16
- *
17
- * Use this tuple for user-facing validation and shell selection UIs.
18
- * It intentionally matches the shipped {@link Shell} union exactly so docs,
19
- * help output, and completion generation advertise the same support surface.
20
- *
21
- * @see {@link Shell} for the union type matching these entries.
22
- */
23
- declare const SHELLS: Readonly<readonly ['bash', 'zsh', 'fish', 'powershell']>;
24
- /**
25
- * Normalize a raw shell token — a bare name (`zsh`), a `$SHELL` path
26
- * (`/bin/zsh`), or a Windows executable (`…\pwsh.exe`) — to a supported
27
- * {@link Shell}, or `undefined` when it does not map to one.
28
- *
29
- * Mirrors the matching used by the `completions` subcommand so the subcommand
30
- * and the eager `--completions <shell>` flag accept exactly the same inputs.
31
- *
32
- * @param raw - User-supplied shell token or interpreter path.
33
- * @returns The resolved {@link Shell}, or `undefined` if unrecognized.
34
- */
35
- declare function normalizeShell(raw: string): Shell | undefined;
36
- /**
37
- * Auto-detect the current shell from environment variables.
38
- *
39
- * Resolution order:
40
- * 1. `$SHELL` parsed as an interpreter path (`/bin/zsh` → `zsh`). It wins when
41
- * it names a shell we support — a pwsh session launched from bash inherits
42
- * `SHELL=/bin/bash`, and the login shell the user opted into should be
43
- * honored over the fallback.
44
- * 2. Otherwise, the presence of `$PSModulePath` signals PowerShell. PowerShell
45
- * never sets `$SHELL` on any platform but always exports `PSModulePath` for
46
- * module discovery, so it is the reliable pwsh signal.
47
- *
48
- * Returns `undefined` when no signal resolves, leaving the caller to ask the
49
- * user for an explicit shell.
50
- *
51
- * @param env - Environment record (e.g. `process.env` or an adapter's env).
52
- * @returns The detected {@link Shell}, or `undefined`.
53
- */
54
- declare function detectShell(env: Readonly<Record<string, string | undefined>>): Shell | undefined;
55
- /**
56
- * Generate a completion script for the given shell.
57
- *
58
- * This is the primary completion entrypoint for most consumers. Pass a CLI
59
- * schema and target shell, then write the returned script to a file or source
60
- * it directly from the command line.
61
- *
62
- * @param schema - The CLI schema describing commands, flags, and args.
63
- * @param shell - Target shell.
64
- * @param options - Optional generator configuration such as function naming
65
- * and root default-command completion behavior.
66
- * @returns A complete shell completion script as a string.
67
- *
68
- * @example
69
- * ```ts
70
- * const script = generateCompletion(app.schema, 'bash');
71
- * // e.g. source <(mycli completions bash)
72
- * ```
73
- */
74
- declare function generateCompletion(schema: CLISchema, shell: Shell, options?: CompletionOptions): string;
75
- //#endregion
76
- export { type CompletionOptions, SHELLS, type Shell, detectShell, generateBashCompletion, generateCompletion, generateFishCompletion, generatePowerShellCompletion, generateZshCompletion, normalizeShell };
@@ -1,90 +0,0 @@
1
- import { generateBashCompletion } from "./shells/bash.mjs";
2
- import { generateFishCompletion } from "./shells/fish.mjs";
3
- import { generatePowerShellCompletion } from "./shells/powershell.mjs";
4
- import { generateZshCompletion } from "./shells/zsh.mjs";
5
- //#region src/core/completion/index.ts
6
- /**
7
- * Implemented shell values as a frozen readonly non-empty tuple.
8
- *
9
- * Use this tuple for user-facing validation and shell selection UIs.
10
- * It intentionally matches the shipped {@link Shell} union exactly so docs,
11
- * help output, and completion generation advertise the same support surface.
12
- *
13
- * @see {@link Shell} for the union type matching these entries.
14
- */
15
- const SHELLS = Object.freeze([
16
- "bash",
17
- "zsh",
18
- "fish",
19
- "powershell"
20
- ]);
21
- /**
22
- * Normalize a raw shell token — a bare name (`zsh`), a `$SHELL` path
23
- * (`/bin/zsh`), or a Windows executable (`…\pwsh.exe`) — to a supported
24
- * {@link Shell}, or `undefined` when it does not map to one.
25
- *
26
- * Mirrors the matching used by the `completions` subcommand so the subcommand
27
- * and the eager `--completions <shell>` flag accept exactly the same inputs.
28
- *
29
- * @param raw - User-supplied shell token or interpreter path.
30
- * @returns The resolved {@link Shell}, or `undefined` if unrecognized.
31
- */
32
- function normalizeShell(raw) {
33
- const segments = raw.split(/[\\/]/);
34
- const name = (segments[segments.length - 1] ?? raw).replace(/\.(?:exe|cmd|bat)$/i, "");
35
- if (name === "pwsh") return "powershell";
36
- return SHELLS.includes(name) ? name : void 0;
37
- }
38
- /**
39
- * Auto-detect the current shell from environment variables.
40
- *
41
- * Resolution order:
42
- * 1. `$SHELL` parsed as an interpreter path (`/bin/zsh` → `zsh`). It wins when
43
- * it names a shell we support — a pwsh session launched from bash inherits
44
- * `SHELL=/bin/bash`, and the login shell the user opted into should be
45
- * honored over the fallback.
46
- * 2. Otherwise, the presence of `$PSModulePath` signals PowerShell. PowerShell
47
- * never sets `$SHELL` on any platform but always exports `PSModulePath` for
48
- * module discovery, so it is the reliable pwsh signal.
49
- *
50
- * Returns `undefined` when no signal resolves, leaving the caller to ask the
51
- * user for an explicit shell.
52
- *
53
- * @param env - Environment record (e.g. `process.env` or an adapter's env).
54
- * @returns The detected {@link Shell}, or `undefined`.
55
- */
56
- function detectShell(env) {
57
- const shellVar = env.SHELL;
58
- const fromShell = shellVar !== void 0 && shellVar !== "" ? normalizeShell(shellVar) : void 0;
59
- if (fromShell !== void 0) return fromShell;
60
- if (env.PSModulePath !== void 0) return "powershell";
61
- }
62
- /**
63
- * Generate a completion script for the given shell.
64
- *
65
- * This is the primary completion entrypoint for most consumers. Pass a CLI
66
- * schema and target shell, then write the returned script to a file or source
67
- * it directly from the command line.
68
- *
69
- * @param schema - The CLI schema describing commands, flags, and args.
70
- * @param shell - Target shell.
71
- * @param options - Optional generator configuration such as function naming
72
- * and root default-command completion behavior.
73
- * @returns A complete shell completion script as a string.
74
- *
75
- * @example
76
- * ```ts
77
- * const script = generateCompletion(app.schema, 'bash');
78
- * // e.g. source <(mycli completions bash)
79
- * ```
80
- */
81
- function generateCompletion(schema, shell, options) {
82
- switch (shell) {
83
- case "bash": return generateBashCompletion(schema, options);
84
- case "zsh": return generateZshCompletion(schema, options);
85
- case "fish": return generateFishCompletion(schema, options);
86
- case "powershell": return generatePowerShellCompletion(schema, options);
87
- }
88
- }
89
- //#endregion
90
- export { SHELLS, detectShell, generateBashCompletion, generateCompletion, generateFishCompletion, generatePowerShellCompletion, generateZshCompletion, normalizeShell };
@@ -1,23 +0,0 @@
1
- import { CompletionOptions } from "./shared.mjs";
2
- import { CLISchema } from "../../cli/index.mjs";
3
- //#region src/core/completion/shells/bash.d.ts
4
- /**
5
- * Generate a bash completion script for the CLI.
6
- *
7
- * Use this when you want a bash-specific script directly rather than routing
8
- * through {@link generateCompletion}. The generated script expects the
9
- * `bash-completion` package because it relies on `_init_completion`.
10
- *
11
- * @param schema - The CLI schema.
12
- * @param options - Optional generator configuration.
13
- * @returns A complete bash completion script.
14
- *
15
- * @example
16
- * ```ts
17
- * const script = generateBashCompletion(app.schema);
18
- * // install with: mycli completions bash > /etc/bash_completion.d/mycli
19
- * ```
20
- */
21
- declare function generateBashCompletion(schema: CLISchema, options?: CompletionOptions): string;
22
- //#endregion
23
- export { generateBashCompletion };