@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,360 +0,0 @@
1
- import { getFlagAliasNames, getFlagNegatedName } from "../../schema/flag.mjs";
2
- import { flagExpectsValue } from "../../parse/index.mjs";
3
- import { getVisibleNegatedName, resolveRootCompletionSurface, sanitizeShellIdentifier, versionTag, walkCommandTree } from "./shared.mjs";
4
- import { resolvePlainHelpDescription } from "../../help/theme.mjs";
5
- //#region src/core/completion/shells/powershell.ts
6
- /**
7
- * Generate a PowerShell completion script for the CLI.
8
- *
9
- * @param schema - The CLI schema.
10
- * @param options - Optional generator configuration.
11
- * @returns A complete PowerShell completion script.
12
- */
13
- function generatePowerShellCompletion(schema, options) {
14
- const prefix = options?.functionPrefix ?? schema.name;
15
- const helperPrefix = `__${sanitizeShellIdentifier(prefix)}_completions`;
16
- const dataVarName = `${helperPrefix}_paths`;
17
- const rootSurface = resolveRootCompletionSurface(schema, options?.rootMode);
18
- const visibleCommands = rootSurface.visibleCommands;
19
- const nodes = walkCommandTree(visibleCommands);
20
- const lines = [];
21
- lines.push(`# PowerShell completion for ${schema.name}`);
22
- lines.push(`# Generated by ${versionTag()}`);
23
- lines.push("#");
24
- lines.push("# Install for the current session:");
25
- lines.push(`# ${schema.name} completions powershell | Out-String | Invoke-Expression`);
26
- lines.push("#");
27
- lines.push("# Install permanently:");
28
- lines.push(`# ${schema.name} completions powershell > $PROFILE.CurrentUserCurrentHost`);
29
- lines.push("");
30
- lines.push("using namespace System.Management.Automation");
31
- lines.push("using namespace System.Management.Automation.Language");
32
- lines.push("");
33
- emitPowerShellPathTable(lines, dataVarName, rootSurface, nodes);
34
- lines.push("");
35
- emitPowerShellHelpers(lines, helperPrefix, dataVarName);
36
- lines.push("");
37
- lines.push(`Register-ArgumentCompleter -Native -CommandName ${quotePowerShellString(schema.name)} -ScriptBlock {`);
38
- lines.push(" param($wordToComplete, $commandAst, $cursorPosition)");
39
- lines.push(`\t$state = ${helperPrefix}_GetState -CommandAst $commandAst -CursorPosition $cursorPosition`);
40
- lines.push(" if ($null -eq $state.PathData) {");
41
- lines.push(" return");
42
- lines.push(" }");
43
- lines.push("");
44
- lines.push(" $results = [System.Collections.Generic.List[CompletionResult]]::new()");
45
- lines.push(" if ($state.AfterSeparator) {");
46
- lines.push(" return $results");
47
- lines.push(" }");
48
- lines.push("");
49
- lines.push(`\t$wordPrefix = if ([string]::IsNullOrEmpty($wordToComplete)) { '' } else { $wordToComplete }`);
50
- lines.push("");
51
- lines.push(" if ($state.ExpectingValue) {");
52
- lines.push(`\t\t${helperPrefix}_AddEnumResults -Results $results -Flag $state.ValueFlag -WordToComplete $wordPrefix`);
53
- lines.push(" return $results");
54
- lines.push(" }");
55
- lines.push("");
56
- lines.push(`\t$inlineValue = ${helperPrefix}_ResolveInlineValueCompletion -PathData $state.PathData -WordToComplete $wordPrefix`);
57
- lines.push(" if ($null -ne $inlineValue) {");
58
- lines.push(`\t\t${helperPrefix}_AddInlineEnumResults -Results $results -InlineValue $inlineValue -WordToComplete $wordPrefix`);
59
- lines.push(" return $results");
60
- lines.push(" }");
61
- lines.push("");
62
- lines.push(" if ($wordPrefix.StartsWith('-')) {");
63
- lines.push(`\t\t${helperPrefix}_AddFlagResults -Results $results -PathData $state.PathData -WordToComplete $wordPrefix`);
64
- lines.push(" return $results");
65
- lines.push(" }");
66
- lines.push("");
67
- lines.push(`\t${helperPrefix}_AddCommandResults -Results $results -PathData $state.PathData -WordToComplete $wordPrefix`);
68
- lines.push(`\t${helperPrefix}_AddFlagResults -Results $results -PathData $state.PathData -WordToComplete $wordPrefix`);
69
- lines.push(" return $results");
70
- lines.push("}");
71
- return lines.join("\n");
72
- }
73
- function emitPowerShellPathTable(lines, dataVarName, rootSurface, nodes) {
74
- lines.push(`$script:${dataVarName} = @{`);
75
- appendPowerShellPathEntry(lines, "", rootSurface.visibleCommands, {
76
- ...rootSurface.rootFlags,
77
- ...rootSurface.includeDefaultFlags ? rootSurface.defaultFlags : {}
78
- });
79
- for (const node of nodes) appendPowerShellPathEntry(lines, node.path.join(" "), node.children, node.mergedFlags);
80
- lines.push("}");
81
- }
82
- function appendPowerShellPathEntry(lines, path, commands, flags) {
83
- lines.push(`\t${quotePowerShellString(path)} = @{`);
84
- lines.push(" Commands = @(");
85
- for (const command of commands) {
86
- lines.push(" @{");
87
- lines.push(`\t\t\t\tCanonicalName = ${quotePowerShellString(command.name)}`);
88
- lines.push(`\t\t\t\tNames = ${formatPowerShellArray([command.name, ...command.aliases])}`);
89
- lines.push(`\t\t\t\tDescription = ${quotePowerShellString(command.description ?? command.name)}`);
90
- lines.push(" }");
91
- }
92
- lines.push(" )");
93
- lines.push(" Flags = @(");
94
- for (const [name, schema] of Object.entries(flags)) {
95
- const visibleNegated = getVisibleNegatedName(name, schema);
96
- const parseNegated = getFlagNegatedName(name, schema);
97
- const forms = dedupeValues([
98
- `--${name}`,
99
- ...getFlagAliasNames(schema, { kind: "short" }).map((alias) => `-${alias}`),
100
- ...getFlagAliasNames(schema, { kind: "long" }).map((alias) => `--${alias}`),
101
- ...visibleNegated !== void 0 ? [`--${visibleNegated}`] : []
102
- ]);
103
- const parseForms = dedupeValues([
104
- `--${name}`,
105
- ...getFlagAliasNames(schema, {
106
- kind: "short",
107
- includeHidden: true
108
- }).map((alias) => `-${alias}`),
109
- ...getFlagAliasNames(schema, {
110
- kind: "long",
111
- includeHidden: true
112
- }).map((alias) => `--${alias}`),
113
- ...parseNegated !== void 0 ? [`--${parseNegated}`] : []
114
- ]);
115
- lines.push(" @{");
116
- lines.push(`\t\t\t\tCanonicalName = ${quotePowerShellString(name)}`);
117
- lines.push(`\t\t\t\tForms = ${formatPowerShellArray(forms)}`);
118
- lines.push(`\t\t\t\tParseForms = ${formatPowerShellArray(parseForms)}`);
119
- lines.push(`\t\t\t\tRequiresValue = ${flagExpectsValue(schema) ? "$true" : "$false"}`);
120
- lines.push(`\t\t\t\tDescription = ${quotePowerShellString(schema.description === void 0 ? name : resolvePlainHelpDescription(schema.description))}`);
121
- lines.push(`\t\t\t\tEnumValues = ${formatPowerShellArray(schema.enumValues ?? [])}`);
122
- lines.push(" }");
123
- }
124
- lines.push(" )");
125
- lines.push(" }");
126
- }
127
- function emitPowerShellHelpers(lines, helperPrefix, dataVarName) {
128
- lines.push(`function ${helperPrefix}_UnquoteToken {`);
129
- lines.push(" param([string]$TokenText)");
130
- lines.push(" if ($TokenText.Length -lt 2) {");
131
- lines.push(" return $TokenText");
132
- lines.push(" }");
133
- lines.push("");
134
- lines.push(" if (($TokenText.StartsWith(\"'\") -and $TokenText.EndsWith(\"'\")) -or");
135
- lines.push(" ($TokenText.StartsWith('\"') -and $TokenText.EndsWith('\"'))) {");
136
- lines.push(" return $TokenText.Substring(1, $TokenText.Length - 2)");
137
- lines.push(" }");
138
- lines.push("");
139
- lines.push(" return $TokenText");
140
- lines.push("}");
141
- lines.push("");
142
- lines.push(`function ${helperPrefix}_FindCommand {`);
143
- lines.push(" param($PathData, [string]$Token)");
144
- lines.push(" foreach ($command in $PathData.Commands) {");
145
- lines.push(" foreach ($name in $command.Names) {");
146
- lines.push(" if ($name -eq $Token) {");
147
- lines.push(" return $command");
148
- lines.push(" }");
149
- lines.push(" }");
150
- lines.push(" }");
151
- lines.push(" return $null");
152
- lines.push("}");
153
- lines.push("");
154
- lines.push(`function ${helperPrefix}_ResolveFlagToken {`);
155
- lines.push(" param($PathData, [string]$Token)");
156
- lines.push(" foreach ($flag in $PathData.Flags) {");
157
- lines.push(" foreach ($form in $flag.ParseForms) {");
158
- lines.push(" if ($Token -eq $form) {");
159
- lines.push(" return @{ Flag = $flag; InlinePrefix = $null }");
160
- lines.push(" }");
161
- lines.push("");
162
- lines.push(" if (-not $flag.RequiresValue) {");
163
- lines.push(" continue");
164
- lines.push(" }");
165
- lines.push("");
166
- lines.push(" if ($form.StartsWith('--') -and $Token.StartsWith(\"$form=\")) {");
167
- lines.push(" return @{ Flag = $flag; InlinePrefix = \"$form=\" }");
168
- lines.push(" }");
169
- lines.push("");
170
- lines.push(" if ($form.StartsWith('-') -and -not $form.StartsWith('--') -and $Token.StartsWith($form) -and $Token.Length -gt $form.Length) {");
171
- lines.push(" return @{ Flag = $flag; InlinePrefix = $form }");
172
- lines.push(" }");
173
- lines.push(" }");
174
- lines.push(" }");
175
- lines.push(" return $null");
176
- lines.push("}");
177
- lines.push("");
178
- lines.push(`function ${helperPrefix}_GetState {`);
179
- lines.push(" param([CommandAst]$CommandAst, [int]$CursorPosition)");
180
- lines.push(`\t$pathData = $script:${dataVarName}[${quotePowerShellString("")}]`);
181
- lines.push(" $path = \"\"");
182
- lines.push(" $afterSeparator = $false");
183
- lines.push(" $expectingValue = $false");
184
- lines.push(" $valueFlag = $null");
185
- lines.push(" $tokens = [System.Collections.Generic.List[string]]::new()");
186
- lines.push("");
187
- lines.push(" foreach ($element in $CommandAst.CommandElements | Select-Object -Skip 1) {");
188
- lines.push(" if ($element.Extent.EndOffset -ge $CursorPosition) {");
189
- lines.push(" break");
190
- lines.push(" }");
191
- lines.push(`\t\t$tokenText = ${helperPrefix}_UnquoteToken $element.Extent.Text`);
192
- lines.push(" [void]$tokens.Add($tokenText)");
193
- lines.push(" }");
194
- lines.push("");
195
- lines.push(" foreach ($token in $tokens) {");
196
- lines.push(" if ($expectingValue) {");
197
- lines.push(" $expectingValue = $false");
198
- lines.push(" $valueFlag = $null");
199
- lines.push(" continue");
200
- lines.push(" }");
201
- lines.push("");
202
- lines.push(" if ($token -eq '--') {");
203
- lines.push(" $afterSeparator = $true");
204
- lines.push(" break");
205
- lines.push(" }");
206
- lines.push("");
207
- lines.push(`\t\t$flagMatch = ${helperPrefix}_ResolveFlagToken -PathData $pathData -Token $token`);
208
- lines.push(" if ($null -ne $flagMatch) {");
209
- lines.push(" if ($flagMatch.InlinePrefix -eq $null -and $flagMatch.Flag.RequiresValue) {");
210
- lines.push(" $expectingValue = $true");
211
- lines.push(" $valueFlag = $flagMatch.Flag");
212
- lines.push(" }");
213
- lines.push(" continue");
214
- lines.push(" }");
215
- lines.push("");
216
- lines.push(" if ($token.StartsWith('-')) {");
217
- lines.push(" continue");
218
- lines.push(" }");
219
- lines.push("");
220
- lines.push(`\t\t$command = ${helperPrefix}_FindCommand -PathData $pathData -Token $token`);
221
- lines.push(" if ($null -eq $command) {");
222
- lines.push(" break");
223
- lines.push(" }");
224
- lines.push("");
225
- lines.push(" $path = if ([string]::IsNullOrEmpty($path)) {");
226
- lines.push(" $command.CanonicalName");
227
- lines.push(" } else {");
228
- lines.push(" \"$path $($command.CanonicalName)\"");
229
- lines.push(" }");
230
- lines.push(`\t\t$nextPathData = $script:${dataVarName}[$path]`);
231
- lines.push(" if ($null -eq $nextPathData) {");
232
- lines.push(" break");
233
- lines.push(" }");
234
- lines.push(" $pathData = $nextPathData");
235
- lines.push(" }");
236
- lines.push("");
237
- lines.push(" return @{");
238
- lines.push(" Path = $path");
239
- lines.push(" PathData = $pathData");
240
- lines.push(" AfterSeparator = $afterSeparator");
241
- lines.push(" ExpectingValue = $expectingValue");
242
- lines.push(" ValueFlag = $valueFlag");
243
- lines.push(" }");
244
- lines.push("}");
245
- lines.push("");
246
- lines.push(`function ${helperPrefix}_ResolveInlineValueCompletion {`);
247
- lines.push(" param($PathData, [string]$WordToComplete)");
248
- lines.push(`\t$flagMatch = ${helperPrefix}_ResolveFlagToken -PathData $PathData -Token $WordToComplete`);
249
- lines.push(" if ($null -eq $flagMatch -or $flagMatch.InlinePrefix -eq $null) {");
250
- lines.push(" return $null");
251
- lines.push(" }");
252
- lines.push(" return $flagMatch");
253
- lines.push("}");
254
- lines.push("");
255
- lines.push(`function ${helperPrefix}_FormatCompletionValue {`);
256
- lines.push(" param([string]$Value)");
257
- lines.push(" if ($Value.Length -eq 0) {");
258
- lines.push(" return \"''\"");
259
- lines.push(" }");
260
- lines.push("");
261
- lines.push(" if ($Value -match '^[a-zA-Z0-9_./:\\\\-]+$') {");
262
- lines.push(" return $Value");
263
- lines.push(" }");
264
- lines.push("");
265
- lines.push(" return \"'$([CodeGeneration]::EscapeSingleQuotedStringContent($Value))'\"");
266
- lines.push("}");
267
- lines.push("");
268
- lines.push(`function ${helperPrefix}_MatchesCompletionPrefix {`);
269
- lines.push(" param([string]$WordToComplete, [string]$RawText, [string]$CompletionText)");
270
- lines.push(" if ([string]::IsNullOrEmpty($WordToComplete)) {");
271
- lines.push(" return $true");
272
- lines.push(" }");
273
- lines.push("");
274
- lines.push(" return $RawText.StartsWith($WordToComplete, [System.StringComparison]::OrdinalIgnoreCase) -or $CompletionText.StartsWith($WordToComplete, [System.StringComparison]::OrdinalIgnoreCase)");
275
- lines.push("}");
276
- lines.push("");
277
- lines.push(`function ${helperPrefix}_AddCommandResults {`);
278
- lines.push(" param($Results, $PathData, [string]$WordToComplete)");
279
- lines.push(" foreach ($command in $PathData.Commands) {");
280
- lines.push(" foreach ($name in $command.Names) {");
281
- lines.push(" if (-not [string]::IsNullOrEmpty($WordToComplete) -and -not $name.StartsWith($WordToComplete, [System.StringComparison]::OrdinalIgnoreCase)) {");
282
- lines.push(" continue");
283
- lines.push(" }");
284
- lines.push("");
285
- lines.push(" $Results.Add([CompletionResult]::new(");
286
- lines.push(" $name,");
287
- lines.push(" $name,");
288
- lines.push(" [CompletionResultType]::Command,");
289
- lines.push(" $command.Description");
290
- lines.push(" ))");
291
- lines.push(" }");
292
- lines.push(" }");
293
- lines.push("}");
294
- lines.push("");
295
- lines.push(`function ${helperPrefix}_AddFlagResults {`);
296
- lines.push(" param($Results, $PathData, [string]$WordToComplete)");
297
- lines.push(" foreach ($flag in $PathData.Flags) {");
298
- lines.push(" foreach ($form in $flag.Forms) {");
299
- lines.push(" if (-not [string]::IsNullOrEmpty($WordToComplete) -and -not $form.StartsWith($WordToComplete, [System.StringComparison]::OrdinalIgnoreCase)) {");
300
- lines.push(" continue");
301
- lines.push(" }");
302
- lines.push("");
303
- lines.push(" $Results.Add([CompletionResult]::new(");
304
- lines.push(" $form,");
305
- lines.push(" $form,");
306
- lines.push(" [CompletionResultType]::ParameterName,");
307
- lines.push(" $flag.Description");
308
- lines.push(" ))");
309
- lines.push(" }");
310
- lines.push(" }");
311
- lines.push("}");
312
- lines.push("");
313
- lines.push(`function ${helperPrefix}_AddEnumResults {`);
314
- lines.push(" param($Results, $Flag, [string]$WordToComplete)");
315
- lines.push(" foreach ($value in $Flag.EnumValues) {");
316
- lines.push(`\t\t$completionText = ${helperPrefix}_FormatCompletionValue -Value $value`);
317
- lines.push(`\t\tif (-not (${helperPrefix}_MatchesCompletionPrefix -WordToComplete $WordToComplete -RawText $value -CompletionText $completionText)) {`);
318
- lines.push(" continue");
319
- lines.push(" }");
320
- lines.push("");
321
- lines.push(" $Results.Add([CompletionResult]::new(");
322
- lines.push(" $completionText,");
323
- lines.push(" $value,");
324
- lines.push(" [CompletionResultType]::ParameterValue,");
325
- lines.push(" $Flag.Description");
326
- lines.push(" ))");
327
- lines.push(" }");
328
- lines.push("}");
329
- lines.push("");
330
- lines.push(`function ${helperPrefix}_AddInlineEnumResults {`);
331
- lines.push(" param($Results, $InlineValue, [string]$WordToComplete)");
332
- lines.push(" foreach ($value in $InlineValue.Flag.EnumValues) {");
333
- lines.push(" $rawCompletion = \"$($InlineValue.InlinePrefix)$value\"");
334
- lines.push(`\t\t$formattedValue = ${helperPrefix}_FormatCompletionValue -Value $value`);
335
- lines.push(" $completionText = \"$($InlineValue.InlinePrefix)$formattedValue\"");
336
- lines.push(`\t\tif (-not (${helperPrefix}_MatchesCompletionPrefix -WordToComplete $WordToComplete -RawText $rawCompletion -CompletionText $completionText)) {`);
337
- lines.push(" continue");
338
- lines.push(" }");
339
- lines.push("");
340
- lines.push(" $Results.Add([CompletionResult]::new(");
341
- lines.push(" $completionText,");
342
- lines.push(" $value,");
343
- lines.push(" [CompletionResultType]::ParameterValue,");
344
- lines.push(" $InlineValue.Flag.Description");
345
- lines.push(" ))");
346
- lines.push(" }");
347
- lines.push("}");
348
- }
349
- function quotePowerShellString(value) {
350
- return `'${value.replace(/'/g, "''")}'`;
351
- }
352
- function formatPowerShellArray(values) {
353
- if (values.length === 0) return "@()";
354
- return `@(${values.map(quotePowerShellString).join(", ")})`;
355
- }
356
- function dedupeValues(values) {
357
- return [...new Set(values)];
358
- }
359
- //#endregion
360
- export { generatePowerShellCompletion };
@@ -1,164 +0,0 @@
1
- import { BuiltinsConfig } from "../../cli/builtins.mjs";
2
- import { FlagSchema } from "../../schema/flag.mjs";
3
- import { CommandSchema } from "../../schema/command.mjs";
4
- import "../../schema/index.mjs";
5
- //#region src/core/completion/shells/shared.d.ts
6
- /**
7
- * Format a version tag for generated completion script headers.
8
- *
9
- * Produces e.g. `"@kjanat/dreamcli v0.9.1 (f9b5f1a)"` when built, or
10
- * `"@kjanat/dreamcli"` when running unbundled in development.
11
- *
12
- * @internal
13
- */
14
- declare function versionTag(): string;
15
- /**
16
- * Options for completion script generation.
17
- *
18
- * Passed to individual shell generators alongside the CLI schema.
19
- *
20
- * These options affect the generated script text, not runtime completion
21
- * behavior after installation.
22
- */
23
- interface CompletionOptions {
24
- /**
25
- * Override the generated shell function name prefix.
26
- *
27
- * Defaults to the CLI name from the schema. This is mainly useful when
28
- * embedding multiple generated scripts in the same environment and you want
29
- * deterministic, collision-free helper names.
30
- *
31
- * @example
32
- * ```ts
33
- * generateCompletion(schema, 'bash', { functionPrefix: 'acme' });
34
- * ```
35
- */
36
- readonly functionPrefix?: string;
37
- /**
38
- * Where the built-in shell completion is exposed.
39
- *
40
- * - `'command'` registers a `completions` subcommand (the default).
41
- * - `'flag'` exposes an eager `--completions <shell>` flag on the CLI root
42
- * instead, keeping the root free of a `completions` subcommand.
43
- *
44
- * @defaultValue `'command'`
45
- */
46
- readonly as?: 'command' | 'flag';
47
- /**
48
- * Controls which root-level surface shell completion exposes when a
49
- * default command exists.
50
- *
51
- * - `'subcommands'` keeps hybrid CLIs command-centric at the root while
52
- * still exposing default-command flags for a single visible default
53
- * command.
54
- * - `'surface'` exposes the default command's root-usable flags at the
55
- * root whenever a visible default command exists.
56
- *
57
- * @defaultValue `'subcommands'`
58
- */
59
- readonly rootMode?: 'subcommands' | 'surface';
60
- }
61
- /**
62
- * Normalized root completion surface consumed by shell generators.
63
- *
64
- * @internal
65
- */
66
- interface RootCompletionSurface {
67
- readonly visibleCommands: readonly CommandSchema[];
68
- readonly visibleDefaultCommand: CommandSchema | undefined;
69
- readonly rootFlags: Readonly<Record<string, FlagSchema>>;
70
- readonly defaultFlags: Readonly<Record<string, FlagSchema>>;
71
- readonly includeDefaultFlags: boolean;
72
- }
73
- /**
74
- * Schema shape needed to compute the root completion surface.
75
- *
76
- * @internal
77
- */
78
- interface RootCompletionSchemaLike {
79
- readonly commands: readonly CommandSchema[];
80
- readonly defaultCommand: CommandSchema | undefined;
81
- readonly defaultCommandRouted?: boolean | undefined;
82
- readonly version: string | undefined;
83
- /**
84
- * Built-in flag state. `help: 'off'` drops the synthetic root `--help` so a
85
- * command's own `help` flag is the only one completed. Optional so
86
- * hand-built schema-like objects keep every built-in.
87
- */
88
- readonly builtins?: BuiltinsConfig | undefined;
89
- }
90
- /**
91
- * Resolve the root-level completion surface from the CLI schema and policy.
92
- *
93
- * @internal
94
- */
95
- declare function resolveRootCompletionSurface(schema: RootCompletionSchemaLike, rootMode?: CompletionOptions['rootMode']): RootCompletionSurface;
96
- /**
97
- * A flattened node from the command tree, carrying its ancestry context.
98
- *
99
- * Used by both bash and zsh generators to produce completions at every
100
- * nesting level with correct propagated flag inheritance.
101
- *
102
- * @internal
103
- */
104
- interface CommandNode {
105
- /** Name path from root: `['db', 'migrate']` */
106
- readonly path: readonly string[];
107
- /** The command schema at this node */
108
- readonly schema: CommandSchema;
109
- /** Propagated flags inherited from ancestors (excludes own flags) */
110
- readonly propagatedFlags: Readonly<Record<string, FlagSchema>>;
111
- /** Merged flags: propagated + own (own shadows propagated) */
112
- readonly mergedFlags: Readonly<Record<string, FlagSchema>>;
113
- /** Visible child command schemas (for subcommand completion) */
114
- readonly children: readonly CommandSchema[];
115
- }
116
- /**
117
- * Walk the command tree depth-first, producing a flat list of
118
- * {@link CommandNode}s with propagated flag context.
119
- *
120
- * @param topLevel - Top-level visible command schemas.
121
- * @param ancestorSchemas - Schema path from root (for propagation calculation).
122
- * @returns Flat list of all visible nodes in the tree.
123
- *
124
- * @internal
125
- */
126
- declare function walkCommandTree(topLevel: readonly CommandSchema[], ancestorSchemas?: readonly CommandSchema[]): readonly CommandNode[];
127
- /**
128
- * Effective negated long-form spelling for user-facing suggestion lists.
129
- *
130
- * Returns the negated spelling without the `--` prefix (e.g. `no-verbose`)
131
- * when the flag is negatable and the negation is not hidden; `undefined`
132
- * otherwise. Negated spellings are long-only and take no value, so they only
133
- * belong in suggestion lists — never in value-flag (operand-skip) patterns.
134
- *
135
- * @internal
136
- */
137
- declare function getVisibleNegatedName(name: string, schema: FlagSchema): string | undefined;
138
- /**
139
- * Sanitize a string for use as a shell function identifier.
140
- * Replaces non-alphanumeric/underscore characters with underscores.
141
- * When sanitization changes the name, appends a short stable hash suffix so
142
- * distinct originals cannot collide on the same helper identifier.
143
- * Used by both bash and zsh generators.
144
- *
145
- * @internal
146
- */
147
- declare function sanitizeShellIdentifier(name: string): string;
148
- /**
149
- * Quote a string for safe interpolation into a shell script.
150
- *
151
- * Uses single-quote wrapping with the standard `'\''` idiom for
152
- * embedded single quotes. This prevents shell injection from CLI
153
- * names containing spaces, semicolons, backticks, or other
154
- * special characters.
155
- *
156
- * Returns the input unquoted if it consists only of shell-safe
157
- * characters (`[a-zA-Z0-9_\-.]`), avoiding unnecessary noise
158
- * in generated scripts for common CLI names like `my-cli` or `app.v2`.
159
- *
160
- * @internal
161
- */
162
- declare function quoteShellArg(value: string): string;
163
- //#endregion
164
- export { type CommandNode, type CompletionOptions, type RootCompletionSurface, getVisibleNegatedName, quoteShellArg, resolveRootCompletionSurface, sanitizeShellIdentifier, versionTag, walkCommandTree };
@@ -1,147 +0,0 @@
1
- import { createFlagSchema, getFlagNegatedName } from "../../schema/flag.mjs";
2
- import { builtinEnabled } from "../../cli/builtins.mjs";
3
- import { collectPropagatedFlags } from "../../cli/propagate.mjs";
4
- import { resolveRootSurface } from "../../cli/root-surface.mjs";
5
- import { DREAMCLI_REVISION, DREAMCLI_VERSION } from "../../../version.mjs";
6
- //#region src/core/completion/shells/shared.ts
7
- /**
8
- * Format a version tag for generated completion script headers.
9
- *
10
- * Produces e.g. `"@kjanat/dreamcli v0.9.1 (f9b5f1a)"` when built, or
11
- * `"@kjanat/dreamcli"` when running unbundled in development.
12
- *
13
- * @internal
14
- */
15
- function versionTag() {
16
- const rev = ` (${DREAMCLI_REVISION})`;
17
- return `@kjanat/dreamcli v${DREAMCLI_VERSION}${rev}`;
18
- }
19
- /**
20
- * Resolve the root-level completion surface from the CLI schema and policy.
21
- *
22
- * @internal
23
- */
24
- function resolveRootCompletionSurface(schema, rootMode = "subcommands") {
25
- const rootSurface = resolveRootSurface(schema);
26
- const rootFlags = createRootFlags(builtinEnabled(schema.builtins, "help"), schema.version !== void 0);
27
- const defaultFlags = rootSurface.visibleDefaultCommand?.flags ?? {};
28
- const includeDefaultFlags = rootMode === "surface" ? rootSurface.hasVisibleDefault : rootSurface.hasVisibleDefault && !rootSurface.hasVisibleSubcommands;
29
- const defaultCommand = rootSurface.visibleDefaultCommand;
30
- const alreadyListed = defaultCommand !== void 0 && rootSurface.visibleCommands.some((c) => c.name === defaultCommand.name);
31
- return {
32
- visibleCommands: rootSurface.defaultRouted && defaultCommand !== void 0 && !alreadyListed ? [defaultCommand, ...rootSurface.visibleCommands] : rootSurface.defaultRouted ? rootSurface.visibleCommands : rootSurface.visibleSubcommands,
33
- visibleDefaultCommand: rootSurface.visibleDefaultCommand,
34
- rootFlags,
35
- defaultFlags,
36
- includeDefaultFlags
37
- };
38
- }
39
- /**
40
- * Build the synthetic root-level flags (`--help`, optionally `--version`).
41
- *
42
- * @param hasHelp - Whether the root still owns `--help`.
43
- * @param hasVersion - Whether to include a `--version` flag.
44
- * @returns A record of root flag schemas.
45
- * @internal
46
- */
47
- function createRootFlags(hasHelp, hasVersion) {
48
- return {
49
- ...hasHelp ? { help: createSyntheticRootFlag("Show help text") } : {},
50
- ...hasVersion ? { version: createSyntheticRootFlag("Show version") } : {}
51
- };
52
- }
53
- /**
54
- * Create a minimal boolean {@link FlagSchema} for a synthetic root flag.
55
- *
56
- * @param description - Help text for the flag.
57
- * @returns A complete flag schema with all optional fields defaulted.
58
- * @internal
59
- */
60
- function createSyntheticRootFlag(description) {
61
- return createFlagSchema("boolean", { description });
62
- }
63
- /**
64
- * Walk the command tree depth-first, producing a flat list of
65
- * {@link CommandNode}s with propagated flag context.
66
- *
67
- * @param topLevel - Top-level visible command schemas.
68
- * @param ancestorSchemas - Schema path from root (for propagation calculation).
69
- * @returns Flat list of all visible nodes in the tree.
70
- *
71
- * @internal
72
- */
73
- function walkCommandTree(topLevel, ancestorSchemas = []) {
74
- const nodes = [];
75
- for (const schema of topLevel) {
76
- if (schema.hidden) continue;
77
- const fullPath = [...ancestorSchemas, schema];
78
- const propagatedFlags = collectPropagatedFlags(fullPath);
79
- const mergedFlags = {
80
- ...propagatedFlags,
81
- ...schema.flags
82
- };
83
- const children = schema.commands.filter((c) => !c.hidden);
84
- nodes.push({
85
- path: fullPath.map((s) => s.name),
86
- schema,
87
- propagatedFlags,
88
- mergedFlags,
89
- children
90
- });
91
- if (children.length > 0) nodes.push(...walkCommandTree(children, fullPath));
92
- }
93
- return nodes;
94
- }
95
- /**
96
- * Effective negated long-form spelling for user-facing suggestion lists.
97
- *
98
- * Returns the negated spelling without the `--` prefix (e.g. `no-verbose`)
99
- * when the flag is negatable and the negation is not hidden; `undefined`
100
- * otherwise. Negated spellings are long-only and take no value, so they only
101
- * belong in suggestion lists — never in value-flag (operand-skip) patterns.
102
- *
103
- * @internal
104
- */
105
- function getVisibleNegatedName(name, schema) {
106
- if (schema.negation === void 0 || schema.negation.hidden) return void 0;
107
- return getFlagNegatedName(name, schema);
108
- }
109
- /**
110
- * Sanitize a string for use as a shell function identifier.
111
- * Replaces non-alphanumeric/underscore characters with underscores.
112
- * When sanitization changes the name, appends a short stable hash suffix so
113
- * distinct originals cannot collide on the same helper identifier.
114
- * Used by both bash and zsh generators.
115
- *
116
- * @internal
117
- */
118
- function sanitizeShellIdentifier(name) {
119
- const sanitized = name.replace(/[^a-zA-Z0-9_]/g, "_");
120
- if (sanitized === name) return sanitized;
121
- let hash = 2166136261;
122
- for (let i = 0; i < name.length; i += 1) {
123
- hash ^= name.charCodeAt(i);
124
- hash = Math.imul(hash, 16777619);
125
- }
126
- return `${sanitized}_${(hash >>> 0).toString(16).padStart(8, "0")}`;
127
- }
128
- /**
129
- * Quote a string for safe interpolation into a shell script.
130
- *
131
- * Uses single-quote wrapping with the standard `'\''` idiom for
132
- * embedded single quotes. This prevents shell injection from CLI
133
- * names containing spaces, semicolons, backticks, or other
134
- * special characters.
135
- *
136
- * Returns the input unquoted if it consists only of shell-safe
137
- * characters (`[a-zA-Z0-9_\-.]`), avoiding unnecessary noise
138
- * in generated scripts for common CLI names like `my-cli` or `app.v2`.
139
- *
140
- * @internal
141
- */
142
- function quoteShellArg(value) {
143
- if (/^[a-zA-Z0-9_\-.]+$/.test(value)) return value;
144
- return `'${value.replace(/'/g, "'\\''")}'`;
145
- }
146
- //#endregion
147
- export { getVisibleNegatedName, quoteShellArg, resolveRootCompletionSurface, sanitizeShellIdentifier, versionTag, walkCommandTree };