@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,46 +0,0 @@
1
- #!/usr/bin/env bun
2
- /**
3
- * Output channel extras: colors, hyperlinks, and exit codes without throwing.
4
- *
5
- * Demonstrates: the gated `out.color` palette, OSC 8 hyperlinks behind
6
- * `out.isHyperlinkSupported`, and `out.setExitCode()` for "report and
7
- * continue" failures.
8
- *
9
- * Usage:
10
- * npx tsx examples/output-extras.ts
11
- * npx tsx examples/output-extras.ts | cat # colors and links gate off
12
- * NO_COLOR=1 npx tsx examples/output-extras.ts
13
- * npx tsx examples/output-extras.ts; echo "exit: $?"
14
- */
15
-
16
- import { cli, command, osc8 } from '@kjanat/dreamcli';
17
-
18
- const targets = [
19
- { name: 'web-api', ok: true, docs: 'https://example.com/web-api' },
20
- { name: 'worker', ok: false, docs: 'https://example.com/worker' },
21
- { name: 'cache', ok: true, docs: 'https://example.com/cache' },
22
- ];
23
-
24
- const check = command('check')
25
- .description('Health-check all targets')
26
- .action(({ out }) => {
27
- for (const target of targets) {
28
- // Every formatter is an identity function when color is off
29
- // (piped, NO_COLOR, --json), so this is safe unconditionally.
30
- const mark = target.ok ? out.color.green('✔') : out.color.red('✖');
31
- // OSC 8 links garble piped output — gate on the resolved support
32
- // flag (honors NO_HYPERLINKS/FORCE_HYPERLINKS and --no-hyperlinks).
33
- const label = out.isHyperlinkSupported ? osc8(target.docs, target.name) : target.name;
34
- out.log(`${mark} ${label}`);
35
- }
36
-
37
- const failed = targets.filter((t) => !t.ok);
38
- if (failed.length > 0) {
39
- // Report everything, exit non-zero — without throwing away the
40
- // successful output the way a thrown CLIError would.
41
- out.setExitCode(1);
42
- out.status(`${failed.length} of ${targets.length} targets unhealthy`);
43
- }
44
- });
45
-
46
- void cli('healthcheck').version('1.0.0').default(check).run();
@@ -1,40 +0,0 @@
1
- #!/usr/bin/env bun
2
- /**
3
- * Parser-level controls: negation, duplicate policy, and spelling parity.
4
- *
5
- * Demonstrates: `flag.boolean().negatable()` for `--no-<name>`,
6
- * `.duplicates('error' | 'first' | 'last')` on singleton flags, and the
7
- * built-in kebab ↔ camel spelling parity.
8
- *
9
- * Usage:
10
- * npx tsx examples/parser-control.ts --sandbox # true
11
- * npx tsx examples/parser-control.ts --no-sandbox # false, same logical flag
12
- * npx tsx examples/parser-control.ts --sandbox --no-sandbox # last occurrence wins
13
- * npx tsx examples/parser-control.ts --mode fast --mode safe # error: duplicate
14
- * npx tsx examples/parser-control.ts --dryRun # camel spelling of --dry-run
15
- * npx tsx examples/parser-control.ts --help # shows --[no-]sandbox
16
- */
17
-
18
- import { cli, command, flag } from '@kjanat/dreamcli';
19
-
20
- const run = command('run')
21
- .description('Run a task with strict parser semantics')
22
- // Negatable — `--sandbox` and `--no-sandbox` are two spellings of ONE
23
- // logical flag; help renders `--[no-]sandbox`.
24
- .flag('sandbox', flag.boolean().default(true).negatable().describe('Isolate the task'))
25
- // Duplicates — config knobs should reject repeats instead of silently
26
- // keeping the last value.
27
- .flag(
28
- 'mode',
29
- flag.enum(['fast', 'safe']).default('safe').duplicates('error').describe('Execution mode'),
30
- )
31
- // Spelling parity is on by default: `--dryRun` matches this kebab name
32
- // (and a camel-named flag would match its kebab spelling). Handler keys,
33
- // help, and completions stay canonical.
34
- .flag('dry-run', flag.boolean().describe('Print the plan without executing'))
35
- .action(({ flags, out }) => {
36
- out.log(`mode=${flags.mode} sandbox=${flags.sandbox} dryRun=${flags['dry-run']}`);
37
- });
38
-
39
- // Opt out of parity per CLI with: cli('tasks', { flags: { caseParity: false } })
40
- void cli('tasks').version('1.0.0').default(run).run();
@@ -1,40 +0,0 @@
1
- # pwsh-demo
2
-
3
- PowerShell completion playground for `@kjanat/dreamcli`.
4
-
5
- This example is intentionally shaped to exercise a broad slice of the completion surface:
6
-
7
- - Native PowerShell registration via `Register-ArgumentCompleter`
8
- - Root-surface completion from a default command
9
- - Top-level command aliases like `ship` and `st`
10
- - Nested subcommands under `config`
11
- - Enum flag value completion like `--region`, `--strategy`, `--view`, and `--profile`
12
- - Hidden command and hidden flag-alias omission from completions
13
-
14
- ## Try It
15
-
16
- From this directory:
17
-
18
- ```powershell
19
- $env:PATH = "$(Get-Location);$env:PATH"
20
- bun src/main.ts completions powershell | Out-String | Invoke-Expression
21
- ```
22
-
23
- Then try these interactively:
24
-
25
- ```powershell
26
- pwsh-demo de<Tab>
27
- pwsh-demo ship --str<Tab>
28
- pwsh-demo deploy --region <Tab>
29
- pwsh-demo st --view <Tab>
30
- pwsh-demo --pro<Tab>
31
- pwsh-demo --profile q<Tab>
32
- pwsh-demo --profile=q<Tab>
33
- pwsh-demo config se<Tab>
34
- ```
35
-
36
- Or run the automated smoke check:
37
-
38
- ```powershell
39
- bun run smoke:powershell
40
- ```
@@ -1,41 +0,0 @@
1
- {
2
- "name": "pwsh-demo",
3
- "version": "0.0.0-example",
4
- "private": true,
5
- "description": "PowerShell completion playground for dreamcli",
6
- "repository": {
7
- "type": "git",
8
- "url": "git+https://github.com/kjanat/dreamcli.git",
9
- "directory": "examples/pwsh-demo"
10
- },
11
- "type": "module",
12
- "module": "src/main.ts",
13
- "bin": {
14
- "pwsh-demo": "src/main.ts"
15
- },
16
- "files": ["src", "README.md", "smoke-powershell.ps1", "pwsh-demo.cmd", "!src/**/*.test.ts"],
17
- "scripts": {
18
- "build": "bun build src/main.ts --install --outdir=dist --format=esm --target=node --external @kjanat/dreamcli",
19
- "smoke:powershell": "pwsh -NoLogo -NoProfile -ExecutionPolicy Bypass -File ./smoke-powershell.ps1",
20
- "test": "bun test",
21
- "typecheck": "tsc --noEmit"
22
- },
23
- "dependencies": {
24
- "@kjanat/dreamcli": "file:../.."
25
- },
26
- "devDependencies": {
27
- "@types/bun": "catalog:",
28
- "typescript": "catalog:"
29
- },
30
- "packageManager": "bun@1.3.12",
31
- "engines": {
32
- "bun": "^1.3"
33
- },
34
- "devEngines": {
35
- "runtime": {
36
- "name": "bun",
37
- "version": "^1.3",
38
- "onFail": "error"
39
- }
40
- }
41
- }
@@ -1,3 +0,0 @@
1
- @echo off
2
- bun --cwd "%~dp0." src\main.ts %*
3
- exit /b %errorlevel%
@@ -1,218 +0,0 @@
1
- #!/usr/bin/env pwsh
2
-
3
- <#
4
- .SYNOPSIS
5
- Runs an end-to-end smoke test for DreamCLI PowerShell completions.
6
-
7
- .DESCRIPTION
8
- Generates the `pwsh-demo` PowerShell completion script, registers it in the
9
- current session, executes a set of completion scenarios with `TabExpansion2`,
10
- and fails if expected completion values are missing or hidden values leak into
11
- the result set.
12
- #>
13
-
14
- $ErrorActionPreference = 'Stop'
15
- Set-StrictMode -Version Latest
16
-
17
- $root = Split-Path -Parent $MyInvocation.MyCommand.Path
18
- $env:PATH = "$root;$env:PATH"
19
-
20
- $completionScript = & bun "$root/src/main.ts" completions powershell | Out-String
21
- $completionExitCode = $LASTEXITCODE
22
- if ($completionExitCode -ne 0) {
23
- throw "Direct Bun completion generation failed with exit code $completionExitCode."
24
- }
25
- $completionScript = $completionScript.TrimEnd()
26
- if ([string]::IsNullOrWhiteSpace($completionScript)) {
27
- throw 'No completion script was generated.'
28
- }
29
-
30
- $nativeCompletionScript = & pwsh-demo completions powershell | Out-String
31
- $nativeCompletionExitCode = $LASTEXITCODE
32
- if ($nativeCompletionExitCode -ne 0) {
33
- throw "Native pwsh-demo completion generation failed with exit code $nativeCompletionExitCode."
34
- }
35
- $nativeCompletionScript = $nativeCompletionScript.TrimEnd()
36
- if ([string]::IsNullOrWhiteSpace($nativeCompletionScript)) {
37
- throw 'The native pwsh-demo launcher did not generate a completion script.'
38
- }
39
-
40
- if ($nativeCompletionScript -ne $completionScript) {
41
- throw 'The native pwsh-demo launcher generated a different completion script than the direct Bun invocation.'
42
- }
43
-
44
- $nativeCompletionScript | Out-String | Invoke-Expression
45
-
46
- <#
47
- .SYNOPSIS
48
- Returns completion texts for a PowerShell input string.
49
-
50
- .DESCRIPTION
51
- Invokes `TabExpansion2` for the provided input and returns only the
52
- `CompletionText` values so smoke assertions can compare the visible completion
53
- surface.
54
-
55
- .PARAMETER InputScript
56
- The exact PowerShell command line to expand.
57
-
58
- .OUTPUTS
59
- System.String[]
60
- #>
61
- function Get-CompletionTexts {
62
- param([string]$InputScript)
63
-
64
- $expanded = TabExpansion2 -inputScript $InputScript -cursorColumn $InputScript.Length
65
- return @($expanded.CompletionMatches | ForEach-Object CompletionText)
66
- }
67
-
68
- <#
69
- .SYNOPSIS
70
- Fails when expected completion values are missing.
71
-
72
- .DESCRIPTION
73
- Compares the expected completion values to the actual completion results and
74
- throws when any expected value is absent.
75
-
76
- .PARAMETER Label
77
- The scenario label used in the failure message.
78
-
79
- .PARAMETER Actual
80
- The completion texts returned by the expansion.
81
-
82
- .PARAMETER Expected
83
- The completion texts that must be present.
84
- #>
85
- function Assert-Contains {
86
- param(
87
- [string]$Label,
88
- [string[]]$Actual,
89
- [string[]]$Expected
90
- )
91
-
92
- $missing = @($Expected | Where-Object { $_ -notin $Actual })
93
- if ($missing.Count -gt 0) {
94
- throw "$Label is missing expected completions: $($missing -join ', ')"
95
- }
96
- }
97
-
98
- <#
99
- .SYNOPSIS
100
- Fails when excluded completion values appear in the results.
101
-
102
- .DESCRIPTION
103
- Compares the actual completion results to a list of values that must remain
104
- hidden and throws when any excluded value is present.
105
-
106
- .PARAMETER Label
107
- The scenario label used in the failure message.
108
-
109
- .PARAMETER Actual
110
- The completion texts returned by the expansion.
111
-
112
- .PARAMETER Excluded
113
- The completion texts that must not appear.
114
- #>
115
- function Assert-Excludes {
116
- param(
117
- [string]$Label,
118
- [string[]]$Actual,
119
- [string[]]$Excluded
120
- )
121
-
122
- $unexpected = @($Excluded | Where-Object { $_ -in $Actual })
123
- if ($unexpected.Count -gt 0) {
124
- throw "$Label included completions that should stay hidden: $($unexpected -join ', ')"
125
- }
126
- }
127
-
128
- $cases = @(
129
- @{
130
- Label = 'Command name completion'
131
- Input = 'pwsh-demo de'
132
- Expected = @('deploy')
133
- Excluded = @('debug-dump')
134
- },
135
- @{
136
- Label = 'Command alias completion'
137
- Input = 'pwsh-demo sh'
138
- Expected = @('ship')
139
- Excluded = @()
140
- },
141
- @{
142
- Label = 'Root-surface flag completion'
143
- Input = 'pwsh-demo --pro'
144
- Expected = @('--profile')
145
- Excluded = @('--account')
146
- },
147
- @{
148
- Label = 'Deploy flag value completion'
149
- Input = 'pwsh-demo deploy --region '
150
- Expected = @('us', 'eu', 'ap')
151
- Excluded = @()
152
- },
153
- @{
154
- Label = 'Deploy flag value prefix completion'
155
- Input = 'pwsh-demo deploy --region e'
156
- Expected = @('eu')
157
- Excluded = @('us', 'ap')
158
- },
159
- @{
160
- Label = 'Deploy inline flag value completion'
161
- Input = 'pwsh-demo deploy --region=e'
162
- Expected = @('--region=eu')
163
- Excluded = @('--region=us', '--region=ap')
164
- },
165
- @{
166
- Label = 'Deploy strategy value completion'
167
- Input = 'pwsh-demo ship --strategy '
168
- Expected = @('rolling', 'blue-green', 'canary')
169
- Excluded = @()
170
- },
171
- @{
172
- Label = 'Status view value completion'
173
- Input = 'pwsh-demo st --view '
174
- Expected = @('summary', 'full', 'json')
175
- Excluded = @()
176
- },
177
- @{
178
- Label = 'Root default-command value completion'
179
- Input = 'pwsh-demo --profile o'
180
- Expected = @('ops')
181
- Excluded = @('o', 'open')
182
- },
183
- @{
184
- Label = 'Quoted root default-command value completion'
185
- Input = 'pwsh-demo --profile q'
186
- Expected = @("'qa ops'", "'qa''s'")
187
- Excluded = @('qa ops', "qa's")
188
- },
189
- @{
190
- Label = 'Quoted inline root default-command value completion'
191
- Input = 'pwsh-demo --profile=q'
192
- Expected = @("--profile='qa ops'", "--profile='qa''s'")
193
- Excluded = @('--profile=qa ops', "--profile=qa's")
194
- },
195
- @{
196
- Label = 'Nested subcommand completion'
197
- Input = 'pwsh-demo config se'
198
- Expected = @('set')
199
- Excluded = @()
200
- },
201
- @{
202
- Label = 'Option separator stops flag completion'
203
- Input = 'pwsh-demo deploy -- --re'
204
- Expected = @()
205
- Excluded = @('--region', '--approval', '-r')
206
- }
207
- )
208
-
209
- foreach ($case in $cases) {
210
- $actual = Get-CompletionTexts -InputScript $case.Input
211
- Assert-Contains -Label $case.Label -Actual $actual -Expected $case.Expected
212
- Assert-Excludes -Label $case.Label -Actual $actual -Excluded $case.Excluded
213
-
214
- Write-Host "`n$($case.Label):"
215
- $actual | Sort-Object | ForEach-Object { Write-Host " $_" }
216
- }
217
-
218
- Write-Host "`nPowerShell completion smoke test passed."
@@ -1,45 +0,0 @@
1
- /**
2
- * Smoke tests for the PowerShell completion playground.
3
- *
4
- * @module
5
- */
6
- /// <reference types="bun" />
7
-
8
- import { describe, expect, it } from 'bun:test';
9
-
10
- import { pwshDemo } from './main.ts';
11
-
12
- describe('pwsh-demo example', () => {
13
- it('generates a PowerShell script with native registration', async () => {
14
- const result = await pwshDemo.execute(['completions', 'powershell']);
15
-
16
- expect(result.exitCode).toBe(0);
17
-
18
- const script = result.stdout.join('');
19
- expect(script).toContain('# PowerShell completion for pwsh-demo');
20
- expect(script).toContain('Register-ArgumentCompleter -Native -CommandName');
21
- expect(script).toContain('ship');
22
- expect(script).toContain('blue-green');
23
- expect(script).not.toContain('debug-dump');
24
- expect(script).toContain("Forms = @('--profile', '-p')");
25
- });
26
-
27
- it('keeps hidden commands executable', async () => {
28
- const result = await pwshDemo.execute(['debug-dump', '--section', 'completions']);
29
-
30
- expect(result.exitCode).toBe(0);
31
- expect(result.stdout.join('')).toContain('"section": "completions"');
32
- });
33
-
34
- it('surfaces default-command flags at the root', async () => {
35
- const help = await pwshDemo.execute(['--help']);
36
-
37
- expect(help.exitCode).toBe(0);
38
- expect(help.stdout.join('')).toContain('open');
39
-
40
- const result = await pwshDemo.execute(['bravo', '--profile', 'ops', '--shell', 'cmd']);
41
-
42
- expect(result.exitCode).toBe(0);
43
- expect(result.stdout).toEqual(['Opening bravo with ops profile in cmd\n', 'Format: table\n']);
44
- });
45
- });
@@ -1,140 +0,0 @@
1
- #!/usr/bin/env bun
2
- /**
3
- * PowerShell completion playground for DreamCLI.
4
- *
5
- * Usage:
6
- * bun --cwd=examples/pwsh-demo src/main.ts --help
7
- * bun --cwd=examples/pwsh-demo src/main.ts completions powershell
8
- * bun --cwd=examples/pwsh-demo src/main.ts deploy --region eu --strategy canary
9
- * bun --cwd=examples/pwsh-demo src/main.ts config set theme midnight --scope workspace
10
- *
11
- * @module
12
- */
13
-
14
- import { arg, cli, command, flag, group } from '@kjanat/dreamcli';
15
-
16
- const open = command('open')
17
- .description('Open a workspace session')
18
- .alias('o')
19
- .arg(
20
- 'workspace',
21
- arg.enum(['alpha', 'bravo', 'charlie']).default('alpha').describe('Workspace to open'),
22
- )
23
- .flag(
24
- 'profile',
25
- flag
26
- .enum(['default', 'ops', 'readonly', 'qa ops', "qa's"])
27
- .alias('p')
28
- .alias('account', { hidden: true })
29
- .describe('Credential profile'),
30
- )
31
- .flag(
32
- 'shell',
33
- flag.enum(['powershell', 'cmd', 'bash']).default('powershell').describe('Interactive shell'),
34
- )
35
- .flag('format', flag.enum(['table', 'json', 'yaml']).alias('f').describe('Output format'))
36
- .flag('verbose', flag.boolean().alias('v').describe('Verbose logging'))
37
- .action(({ args, flags, out }) => {
38
- out.log(
39
- `Opening ${args.workspace} with ${flags.profile ?? 'default'} profile in ${flags.shell}`,
40
- );
41
- out.log(`Format: ${flags.format ?? 'table'}`);
42
- if (flags.verbose) out.log('Verbose output enabled');
43
- });
44
-
45
- const deploy = command('deploy')
46
- .description('Deploy the selected workspace')
47
- .alias('ship')
48
- .arg(
49
- 'target',
50
- arg.enum(['dev', 'staging', 'prod']).default('staging').describe('Deployment target'),
51
- )
52
- .flag('region', flag.enum(['us', 'eu', 'ap']).alias('r').describe('Target region'))
53
- .flag(
54
- 'strategy',
55
- flag.enum(['rolling', 'blue-green', 'canary']).alias('s').describe('Deployment strategy'),
56
- )
57
- .flag('approval', flag.enum(['manual', 'auto']).describe('Approval mode'))
58
- .flag('dryRun', flag.boolean().alias('d').describe('Preview the rollout without applying it'))
59
- .action(({ args, flags, out }) => {
60
- out.log(
61
- `Deploying ${args.target} to ${flags.region ?? 'us'} with ${flags.strategy ?? 'rolling'}`,
62
- );
63
- out.log(`Approval: ${flags.approval ?? 'manual'}`);
64
- if (flags.dryRun) out.log('Dry run only');
65
- });
66
-
67
- const status = command('status')
68
- .description('Show workspace status')
69
- .alias('st')
70
- .flag('view', flag.enum(['summary', 'full', 'json']).default('summary').describe('Status view'))
71
- .flag('watch', flag.boolean().alias('w').describe('Refresh continuously'))
72
- .action(({ flags, out }) => {
73
- out.log(`Status view: ${flags.view}`);
74
- if (flags.watch) out.log('Watching for changes');
75
- });
76
-
77
- const configGet = command('get')
78
- .description('Read a saved setting')
79
- .alias('show')
80
- .arg('key', arg.enum(['theme', 'region', 'profile']).describe('Setting to read'))
81
- .action(({ args, out }) => {
82
- out.log(`${args.key}=demo-value`);
83
- });
84
-
85
- const configSet = command('set')
86
- .description('Write a saved setting')
87
- .arg('key', arg.enum(['theme', 'region', 'profile']).describe('Setting to write'))
88
- .arg('value', arg.string().describe('New value'))
89
- .flag(
90
- 'scope',
91
- flag.enum(['user', 'workspace']).alias('s').default('user').describe('Config scope'),
92
- )
93
- .action(({ args, flags, out }) => {
94
- out.log(`Saved ${args.key}=${args.value} to ${flags.scope} scope`);
95
- });
96
-
97
- const configReset = command('reset')
98
- .description('Reset a saved setting')
99
- .alias('rm')
100
- .arg('key', arg.enum(['theme', 'region', 'profile']).describe('Setting to reset'))
101
- .flag('scope', flag.enum(['user', 'workspace']).default('user').describe('Config scope'))
102
- .action(({ args, flags, out }) => {
103
- out.log(`Reset ${args.key} in ${flags.scope} scope`);
104
- });
105
-
106
- const config = group('config')
107
- .description('Manage saved settings')
108
- .command(configGet)
109
- .command(configSet)
110
- .command(configReset);
111
-
112
- const debugDump = command('debug-dump')
113
- .description('Dump internal playground state')
114
- .hidden()
115
- .flag(
116
- 'section',
117
- flag
118
- .enum(['schema', 'completions', 'runtime'])
119
- .default('schema')
120
- .describe('Section to inspect'),
121
- )
122
- .action(({ flags, out }) => {
123
- out.log(JSON.stringify({ section: flags.section, hidden: true }, null, 2));
124
- });
125
-
126
- /**
127
- * PowerShell completion playground CLI used by docs, smoke checks, and manual shell testing.
128
- */
129
- export const pwshDemo = cli('pwsh-demo')
130
- .manifest({ from: import.meta.url })
131
- .default(open)
132
- .command(deploy)
133
- .command(status)
134
- .command(config)
135
- .command(debugDump)
136
- .completions({ rootMode: 'surface' });
137
-
138
- if (import.meta.main) {
139
- pwshDemo.run();
140
- }
@@ -1,49 +0,0 @@
1
- #!/usr/bin/env bun
2
- /**
3
- * Spinner and progress bar usage.
4
- *
5
- * Demonstrates: `out.spinner()`, `out.progress()`, `spinner.wrap()`, and
6
- * automatic suppression in non-TTY or `--json` mode.
7
- *
8
- * Usage:
9
- * npx tsx examples/spinner-progress.ts
10
- * npx tsx examples/spinner-progress.ts --json # spinners suppressed, JSON output
11
- * echo | npx tsx examples/spinner-progress.ts # non-TTY: spinners silent
12
- */
13
-
14
- import { cli, command, flag } from '@kjanat/dreamcli';
15
-
16
- function sleep(ms: number): Promise<void> {
17
- return new Promise((resolve) => setTimeout(resolve, ms));
18
- }
19
-
20
- const build = command('build')
21
- .description('Build the project (demonstrates spinners and progress)')
22
- .flag('steps', flag.number().default(5).describe('Number of build steps'))
23
- .action(async ({ flags, out }) => {
24
- // --- Spinner: indeterminate work ---
25
- const spinner = out.spinner('Preparing build environment...');
26
- await sleep(1000);
27
- spinner.update('Installing dependencies...');
28
- await sleep(800);
29
- spinner.succeed('Environment ready');
30
-
31
- // --- Spinner with wrap(): auto-succeed/fail ---
32
- const lint = out.spinner('Linting...');
33
- await lint.wrap(sleep(600), {
34
- succeed: 'Lint passed',
35
- fail: 'Lint failed',
36
- });
37
-
38
- // --- Progress bar: determinate work ---
39
- const progress = out.progress({ total: flags.steps, label: 'Compiling' });
40
- for (let i = 0; i < flags.steps; i++) {
41
- await sleep(300);
42
- progress.increment();
43
- }
44
- progress.done('Build complete');
45
-
46
- out.log(`Built ${flags.steps} modules`);
47
- });
48
-
49
- void cli('build').default(build).run();
@@ -1,45 +0,0 @@
1
- #!/usr/bin/env bun
2
- /**
3
- * Standard Schema validation for custom flags and args.
4
- *
5
- * Demonstrates: `flag.custom(schema)` accepting any Standard Schema v1
6
- * validator with inferred output types. Zod 4, Valibot, and ArkType all
7
- * conform; the inline schema below shows the contract itself with zero
8
- * dependencies.
9
- *
10
- * Usage:
11
- * npx tsx examples/standard-schema.ts --port 8080
12
- * npx tsx examples/standard-schema.ts --port 99999 # validation error
13
- * npx tsx examples/standard-schema.ts --port abc # validation error
14
- */
15
-
16
- import type { StandardSchemaV1 } from '@kjanat/dreamcli';
17
- import { cli, command, flag } from '@kjanat/dreamcli';
18
-
19
- // Any object with `~standard` conforms — this is what zod.dev/valibot.dev
20
- // schemas look like under the hood. With a library: flag.custom(z.coerce.number().int().max(65535)).
21
- const port: StandardSchemaV1<unknown, number> = {
22
- '~standard': {
23
- version: 1,
24
- vendor: 'example',
25
- validate: (value) => {
26
- const parsed = Number(value);
27
- if (!Number.isInteger(parsed) || parsed < 1 || parsed > 65535) {
28
- return { issues: [{ message: `expected a port (1-65535), got ${String(value)}` }] };
29
- }
30
- return { value: parsed };
31
- },
32
- },
33
- };
34
-
35
- const serve = command('serve')
36
- .description('Serve on a schema-validated port')
37
- // Validation runs after source resolution — argv, env, config, prompt,
38
- // and default values all pass through the same schema.
39
- .flag('port', flag.custom(port).default(3000).env('PORT').describe('Port to bind'))
40
- .action(({ flags, out }) => {
41
- // flags.port: number — inferred from the schema's output type.
42
- out.log(`listening on :${flags.port}`);
43
- });
44
-
45
- void cli('serve').version('1.0.0').default(serve).run();