@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.
- package/README.md +5 -7
- package/dist/{runtime/adapter.d.mts → adapter-D0hbBNVB.d.mts} +2 -4
- package/dist/completion-D4mz6axB.mjs +6 -0
- package/dist/completion.d.mts +90 -0
- package/dist/completion.mjs +1 -0
- package/dist/config-B9ddC-Kb.mjs +1 -0
- package/dist/config.d.mts +2 -0
- package/dist/config.mjs +1 -0
- package/dist/core-Cp2w8vRq.mjs +17 -0
- package/dist/index-BziI2aKc.d.mts +5440 -0
- package/dist/index-DOfClfYR.d.mts +370 -0
- package/dist/index-DWsnGZlx.d.mts +831 -0
- package/dist/{core/cli/index.d.mts → index-DXROeDPC.d.mts} +116 -57
- package/dist/index-DndPmT8J.d.mts +275 -0
- package/dist/{core/json-schema/index.d.mts → index-DyoaS234.d.mts} +43 -34
- package/dist/index.d.mts +190 -41
- package/dist/index.mjs +1 -26
- package/dist/json-schema-C9SzZ7jY.mjs +52 -0
- package/dist/json-schema.d.mts +2 -0
- package/dist/json-schema.mjs +1 -0
- package/dist/package-json-BgE9YjjQ.mjs +3 -0
- package/dist/prompt.d.mts +48 -0
- package/dist/prompt.mjs +1 -0
- package/dist/rolldown-runtime-G4Kt5YOX.mjs +1 -0
- package/dist/runtime.d.mts +2 -6
- package/dist/runtime.mjs +1 -6
- package/dist/terminal-C8KTXjv5.mjs +6 -0
- package/dist/test-prompter-v__jT2yG.mjs +1 -0
- package/dist/testkit.d.mts +54 -6
- package/dist/testkit.mjs +1 -5
- package/dist/version.mjs +1 -7
- package/dreamcli.schema.json +697 -538
- package/package.json +29 -7
- package/skills/cli-creation/SKILL.md +16 -11
- package/CHANGELOG.md +0 -1116
- package/dist/core/cli/builtins.d.mts +0 -117
- package/dist/core/cli/builtins.mjs +0 -135
- package/dist/core/cli/compiled.d.mts +0 -66
- package/dist/core/cli/compiled.mjs +0 -76
- package/dist/core/cli/dispatch.d.mts +0 -115
- package/dist/core/cli/dispatch.mjs +0 -205
- package/dist/core/cli/help-links.d.mts +0 -27
- package/dist/core/cli/help-links.mjs +0 -41
- package/dist/core/cli/index.mjs +0 -1271
- package/dist/core/cli/planner.d.mts +0 -174
- package/dist/core/cli/planner.mjs +0 -323
- package/dist/core/cli/plugin.d.mts +0 -94
- package/dist/core/cli/plugin.mjs +0 -41
- package/dist/core/cli/propagate.d.mts +0 -39
- package/dist/core/cli/propagate.mjs +0 -57
- package/dist/core/cli/reserved-flags.d.mts +0 -19
- package/dist/core/cli/reserved-flags.mjs +0 -158
- package/dist/core/cli/root-help.d.mts +0 -53
- package/dist/core/cli/root-help.mjs +0 -221
- package/dist/core/cli/root-output-flags.d.mts +0 -74
- package/dist/core/cli/root-output-flags.mjs +0 -169
- package/dist/core/cli/root-surface.d.mts +0 -64
- package/dist/core/cli/root-surface.mjs +0 -28
- package/dist/core/cli/runtime-preflight.d.mts +0 -213
- package/dist/core/cli/runtime-preflight.mjs +0 -221
- package/dist/core/completion/index.d.mts +0 -76
- package/dist/core/completion/index.mjs +0 -90
- package/dist/core/completion/shells/bash.d.mts +0 -23
- package/dist/core/completion/shells/bash.mjs +0 -312
- package/dist/core/completion/shells/fish.d.mts +0 -19
- package/dist/core/completion/shells/fish.mjs +0 -164
- package/dist/core/completion/shells/powershell.d.mts +0 -13
- package/dist/core/completion/shells/powershell.mjs +0 -360
- package/dist/core/completion/shells/shared.d.mts +0 -164
- package/dist/core/completion/shells/shared.mjs +0 -147
- package/dist/core/completion/shells/zsh.d.mts +0 -23
- package/dist/core/completion/shells/zsh.mjs +0 -256
- package/dist/core/config/index.d.mts +0 -191
- package/dist/core/config/index.mjs +0 -285
- package/dist/core/config/package-json.d.mts +0 -179
- package/dist/core/config/package-json.mjs +0 -353
- package/dist/core/errors/index.d.mts +0 -125
- package/dist/core/errors/index.mjs +0 -87
- package/dist/core/execution/index.d.mts +0 -61
- package/dist/core/execution/index.mjs +0 -220
- package/dist/core/help/ansi.d.mts +0 -84
- package/dist/core/help/ansi.mjs +0 -121
- package/dist/core/help/index.d.mts +0 -149
- package/dist/core/help/index.mjs +0 -418
- package/dist/core/help/theme.d.mts +0 -86
- package/dist/core/help/theme.mjs +0 -69
- package/dist/core/json-schema/index.mjs +0 -1008
- package/dist/core/json-schema/meta-descriptions.generated.d.mts +0 -274
- package/dist/core/json-schema/meta-descriptions.generated.mjs +0 -136
- package/dist/core/output/activity.d.mts +0 -193
- package/dist/core/output/activity.mjs +0 -452
- package/dist/core/output/bind.d.mts +0 -37
- package/dist/core/output/bind.mjs +0 -56
- package/dist/core/output/contracts.d.mts +0 -82
- package/dist/core/output/contracts.mjs +0 -57
- package/dist/core/output/display-value.d.mts +0 -19
- package/dist/core/output/display-value.mjs +0 -32
- package/dist/core/output/index.d.mts +0 -344
- package/dist/core/output/index.mjs +0 -514
- package/dist/core/output/renderers.d.mts +0 -45
- package/dist/core/output/renderers.mjs +0 -46
- package/dist/core/output/writer.d.mts +0 -39
- package/dist/core/output/writer.mjs +0 -12
- package/dist/core/parse/index.d.mts +0 -178
- package/dist/core/parse/index.mjs +0 -850
- package/dist/core/parse/occurrences.d.mts +0 -90
- package/dist/core/parse/occurrences.mjs +0 -114
- package/dist/core/prompt/index.d.mts +0 -213
- package/dist/core/prompt/index.mjs +0 -348
- package/dist/core/read-flags/index.d.mts +0 -150
- package/dist/core/read-flags/index.mjs +0 -217
- package/dist/core/resolve/args.d.mts +0 -39
- package/dist/core/resolve/args.mjs +0 -182
- package/dist/core/resolve/coerce.d.mts +0 -79
- package/dist/core/resolve/coerce.mjs +0 -900
- package/dist/core/resolve/config.d.mts +0 -10
- package/dist/core/resolve/config.mjs +0 -19
- package/dist/core/resolve/contracts.d.mts +0 -146
- package/dist/core/resolve/errors.d.mts +0 -10
- package/dist/core/resolve/errors.mjs +0 -148
- package/dist/core/resolve/flags.d.mts +0 -74
- package/dist/core/resolve/flags.mjs +0 -246
- package/dist/core/resolve/index.d.mts +0 -44
- package/dist/core/resolve/index.mjs +0 -123
- package/dist/core/resolve/path-checks.d.mts +0 -48
- package/dist/core/resolve/path-checks.mjs +0 -102
- package/dist/core/resolve/redaction.d.mts +0 -13
- package/dist/core/resolve/redaction.mjs +0 -14
- package/dist/core/resolve/stages.d.mts +0 -86
- package/dist/core/resolve/stages.mjs +0 -170
- package/dist/core/resolve/standard.d.mts +0 -26
- package/dist/core/resolve/standard.mjs +0 -212
- package/dist/core/schema/activity.d.mts +0 -189
- package/dist/core/schema/arg.d.mts +0 -1461
- package/dist/core/schema/arg.mjs +0 -1139
- package/dist/core/schema/brand.d.mts +0 -17
- package/dist/core/schema/cardinality.d.mts +0 -302
- package/dist/core/schema/cardinality.mjs +0 -514
- package/dist/core/schema/command.d.mts +0 -1132
- package/dist/core/schema/command.mjs +0 -999
- package/dist/core/schema/flag.d.mts +0 -1495
- package/dist/core/schema/flag.mjs +0 -1207
- package/dist/core/schema/index.d.mts +0 -15
- package/dist/core/schema/index.mjs +0 -10
- package/dist/core/schema/middleware.d.mts +0 -129
- package/dist/core/schema/middleware.mjs +0 -41
- package/dist/core/schema/number-constraints.d.mts +0 -96
- package/dist/core/schema/number-constraints.mjs +0 -60
- package/dist/core/schema/prompt.d.mts +0 -135
- package/dist/core/schema/provenance.d.mts +0 -99
- package/dist/core/schema/provenance.mjs +0 -28
- package/dist/core/schema/run.d.mts +0 -211
- package/dist/core/schema/source.d.mts +0 -180
- package/dist/core/schema/source.mjs +0 -206
- package/dist/core/schema/standard.d.mts +0 -100
- package/dist/core/schema/standard.mjs +0 -15
- package/dist/core/schema/stdin.d.mts +0 -97
- package/dist/core/schema/stdin.mjs +0 -91
- package/dist/core/schema/string-constraints.d.mts +0 -108
- package/dist/core/schema/string-constraints.mjs +0 -86
- package/dist/core/schema/value-parsers.d.mts +0 -150
- package/dist/core/schema/value-parsers.mjs +0 -160
- package/dist/core/schema/value.d.mts +0 -243
- package/dist/core/schema/value.mjs +0 -573
- package/dist/core/testkit/index.d.mts +0 -63
- package/dist/core/testkit/index.mjs +0 -102
- package/dist/runtime/adapter.mjs +0 -92
- package/dist/runtime/auto.d.mts +0 -25
- package/dist/runtime/auto.mjs +0 -45
- package/dist/runtime/deno.d.mts +0 -99
- package/dist/runtime/deno.mjs +0 -265
- package/dist/runtime/detect.d.mts +0 -86
- package/dist/runtime/detect.mjs +0 -45
- package/dist/runtime/index.d.mts +0 -6
- package/dist/runtime/node.d.mts +0 -71
- package/dist/runtime/node.mjs +0 -228
- package/dist/runtime/paths.d.mts +0 -31
- package/dist/runtime/paths.mjs +0 -48
- package/dist/strings.d.mts +0 -27
- package/dist/strings.mjs +0 -22
- package/examples/basic.ts +0 -37
- package/examples/flag-types.ts +0 -79
- package/examples/gh/package.json +0 -45
- package/examples/gh/src/commands/auth.ts +0 -66
- package/examples/gh/src/commands/issue.ts +0 -120
- package/examples/gh/src/commands/pr.ts +0 -125
- package/examples/gh/src/data/issues.yaml +0 -5
- package/examples/gh/src/data/issues.yaml.d.ts +0 -17
- package/examples/gh/src/data/pull-requests.yaml +0 -7
- package/examples/gh/src/data/pull-requests.yaml.d.ts +0 -18
- package/examples/gh/src/docs.ts +0 -11
- package/examples/gh/src/lib/auth.ts +0 -37
- package/examples/gh/src/lib/utils.ts +0 -17
- package/examples/gh/src/main.test.ts +0 -307
- package/examples/gh/src/main.ts +0 -46
- package/examples/help-config.ts +0 -43
- package/examples/interactive.ts +0 -67
- package/examples/json-mode.ts +0 -95
- package/examples/middleware.ts +0 -71
- package/examples/multi-command.ts +0 -66
- package/examples/output-extras.ts +0 -46
- package/examples/parser-control.ts +0 -40
- package/examples/pwsh-demo/README.md +0 -40
- package/examples/pwsh-demo/package.json +0 -41
- package/examples/pwsh-demo/pwsh-demo.cmd +0 -3
- package/examples/pwsh-demo/smoke-powershell.ps1 +0 -218
- package/examples/pwsh-demo/src/main.test.ts +0 -45
- package/examples/pwsh-demo/src/main.ts +0 -140
- package/examples/spinner-progress.ts +0 -49
- package/examples/standard-schema.ts +0 -45
- package/examples/testing.ts +0 -147
- package/examples/transport-launcher.ts +0 -85
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kjanat/dreamcli",
|
|
3
|
-
"version": "4.0.0
|
|
3
|
+
"version": "4.0.0",
|
|
4
4
|
"description": "Schema-first, fully typed TypeScript CLI framework",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"dreamcli",
|
|
@@ -25,11 +25,17 @@
|
|
|
25
25
|
"email": "info@kajkowalski.nl",
|
|
26
26
|
"url": "https://github.com/kjanat"
|
|
27
27
|
},
|
|
28
|
+
"sideEffects": false,
|
|
28
29
|
"type": "module",
|
|
29
30
|
"imports": {
|
|
30
31
|
"#dreamcli": "./src/index.ts",
|
|
32
|
+
"#dreamcli/completion": "./src/completion.ts",
|
|
33
|
+
"#dreamcli/config": "./src/config.ts",
|
|
34
|
+
"#dreamcli/json-schema": "./src/json-schema.ts",
|
|
35
|
+
"#dreamcli/prompt": "./src/prompt.ts",
|
|
31
36
|
"#dreamcli/runtime": "./src/runtime.ts",
|
|
32
37
|
"#dreamcli/testkit": "./src/testkit.ts",
|
|
38
|
+
"#dreamcli/version": "./src/version.ts",
|
|
33
39
|
"#internals/*": "./src/*",
|
|
34
40
|
"#schema": "./dreamcli.schema.json",
|
|
35
41
|
"#package.json": "./package.json"
|
|
@@ -39,6 +45,22 @@
|
|
|
39
45
|
"types": "./dist/index.d.mts",
|
|
40
46
|
"default": "./dist/index.mjs"
|
|
41
47
|
},
|
|
48
|
+
"./completion": {
|
|
49
|
+
"types": "./dist/completion.d.mts",
|
|
50
|
+
"default": "./dist/completion.mjs"
|
|
51
|
+
},
|
|
52
|
+
"./config": {
|
|
53
|
+
"types": "./dist/config.d.mts",
|
|
54
|
+
"default": "./dist/config.mjs"
|
|
55
|
+
},
|
|
56
|
+
"./json-schema": {
|
|
57
|
+
"types": "./dist/json-schema.d.mts",
|
|
58
|
+
"default": "./dist/json-schema.mjs"
|
|
59
|
+
},
|
|
60
|
+
"./prompt": {
|
|
61
|
+
"types": "./dist/prompt.d.mts",
|
|
62
|
+
"default": "./dist/prompt.mjs"
|
|
63
|
+
},
|
|
42
64
|
"./runtime": {
|
|
43
65
|
"types": "./dist/runtime.d.mts",
|
|
44
66
|
"default": "./dist/runtime.mjs"
|
|
@@ -55,10 +77,8 @@
|
|
|
55
77
|
"./schema": "./dreamcli.schema.json"
|
|
56
78
|
},
|
|
57
79
|
"files": [
|
|
58
|
-
"CHANGELOG.md",
|
|
59
80
|
"dist",
|
|
60
81
|
"dreamcli.schema.json",
|
|
61
|
-
"examples",
|
|
62
82
|
"skills",
|
|
63
83
|
"!**/.cache",
|
|
64
84
|
"!**/node_modules",
|
|
@@ -68,7 +88,7 @@
|
|
|
68
88
|
],
|
|
69
89
|
"workspaces": ["./examples/*", "./docs"],
|
|
70
90
|
"scripts": {
|
|
71
|
-
"bd": "run -s build typecheck:dist",
|
|
91
|
+
"bd": "run -s build typecheck:dist package:check lazy:check",
|
|
72
92
|
"build": "bun --bun tsdown",
|
|
73
93
|
"build:watch": "run build --watch",
|
|
74
94
|
"ci": "run -pk typecheck lint format:check meta-descriptions:check test docs:build bd",
|
|
@@ -92,12 +112,14 @@
|
|
|
92
112
|
"gh-project:start": "bun gh-project start",
|
|
93
113
|
"gh-project:sync": "bun gh-project sync",
|
|
94
114
|
"knip": "knip",
|
|
115
|
+
"lazy:check": "bun scripts/check-lazy-loading.ts",
|
|
95
116
|
"lint": "biome check",
|
|
96
117
|
"lint:autofix": "biome check --skip-parse-errors --no-errors-on-unmatched --changed --write",
|
|
97
118
|
"lint:fix": "biome check --fix",
|
|
98
119
|
"meta-descriptions": "bun --bun scripts/build-meta-descriptions.ts",
|
|
99
120
|
"meta-descriptions:check": "bun --bun scripts/build-meta-descriptions.ts --check",
|
|
100
121
|
"prepack": "bun --bun tsdown --logLevel silent",
|
|
122
|
+
"package:check": "bun scripts/check-package-budget.ts",
|
|
101
123
|
"prepare": "importmapify",
|
|
102
124
|
"publish:preview": "bunx pkg-pr-new publish --bun --comment=update --packageManager=bun,npm",
|
|
103
125
|
"schema:emit": "bun scripts/emit-definition-schema.ts",
|
|
@@ -124,17 +146,17 @@
|
|
|
124
146
|
"@typescript/native": "npm:typescript@^7",
|
|
125
147
|
"@vitest/coverage-v8": "5.0.0",
|
|
126
148
|
"biome": "npm:@biomejs/biome@^2.5.8",
|
|
127
|
-
"dprint": "0.57.
|
|
149
|
+
"dprint": "0.57.2",
|
|
128
150
|
"importmapify": "1.7.0",
|
|
129
151
|
"knip": "^6.32.2",
|
|
130
152
|
"publint": "^0.3.23",
|
|
131
|
-
"runner-run": "0.
|
|
153
|
+
"runner-run": "0.26.1",
|
|
132
154
|
"tsdown": "0.23.0",
|
|
133
155
|
"typescript": ">=6,<7",
|
|
134
156
|
"vitest": "^5.0.0",
|
|
135
157
|
"yaml": "^2.9.0"
|
|
136
158
|
},
|
|
137
|
-
"packageManager": "bun@1.4.
|
|
159
|
+
"packageManager": "bun@1.4.2",
|
|
138
160
|
"engines": {
|
|
139
161
|
"bun": ">=1.3",
|
|
140
162
|
"deno": ">=2.6.0",
|
|
@@ -43,8 +43,8 @@ or published version rather than training data.
|
|
|
43
43
|
regardless of whether the project installed from npm or JSR:
|
|
44
44
|
|
|
45
45
|
```bash
|
|
46
|
-
deno doc jsr:@kjanat/dreamcli 2>/dev/null #
|
|
47
|
-
deno doc jsr:@kjanat/dreamcli/
|
|
46
|
+
deno doc jsr:@kjanat/dreamcli 2>/dev/null # root entry: builders, parsing, help, errors, every public type
|
|
47
|
+
deno doc jsr:@kjanat/dreamcli/completion 2>/dev/null # one subpath at a time; also /config, /json-schema, /prompt, /testkit, /runtime, /version, /schema
|
|
48
48
|
deno doc --json jsr:@kjanat/dreamcli 2>/dev/null # machine-readable, for scripted lookups
|
|
49
49
|
deno doc --filter=CLIBuilder jsr:@kjanat/dreamcli 2>/dev/null # one symbol
|
|
50
50
|
```
|
|
@@ -52,7 +52,7 @@ deno doc --filter=CLIBuilder jsr:@kjanat/dreamcli 2>/dev/null # one symbol
|
|
|
52
52
|
`2>/dev/null` matters: deno writes download and type-check progress to stderr,
|
|
53
53
|
which otherwise swamps the documentation output.
|
|
54
54
|
|
|
55
|
-
Pin a version with `jsr:@kjanat/dreamcli@4.0.0
|
|
55
|
+
Pin a version with `jsr:@kjanat/dreamcli@4.0.0` when the project is not on
|
|
56
56
|
latest. `--filter` takes a declaration name; it prints nothing for a name that
|
|
57
57
|
does not exist, which is itself a useful signal.
|
|
58
58
|
|
|
@@ -159,12 +159,15 @@ defaulted"; never drop `.default()` to detect that, since it also drops
|
|
|
159
159
|
**Cross-flag rules.** Put them in `.derive()`, which runs after resolution and
|
|
160
160
|
before the action, and return derived state to widen `ctx`.
|
|
161
161
|
|
|
162
|
-
**Diagnostics.**
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
162
|
+
**Diagnostics.** Sensitivity, not source, controls disclosure. Mark every
|
|
163
|
+
credential-bearing input `.sensitive()`; that redacts the value in messages and
|
|
164
|
+
omits `details.value` whether it came from argv, stdin, env, config, a prompt,
|
|
165
|
+
or a default. A non-sensitive value may be shown from any of those sources, so
|
|
166
|
+
`flag.string().env('API_TOKEN')` without `.sensitive()` prints the token in a
|
|
167
|
+
validation failure. The framework cannot redact text your own code writes: a
|
|
168
|
+
`flag.custom()` parse function's thrown message and a Standard Schema issue
|
|
169
|
+
message are shown verbatim, so write them to describe the expectation rather
|
|
170
|
+
than to interpolate the value.
|
|
168
171
|
|
|
169
172
|
**Output.** `out.log()` for results, `out.status()` for progress notes (stderr,
|
|
170
173
|
suppressed by `--quiet`), `out.table()` for lists, `out.json()` behind
|
|
@@ -186,8 +189,10 @@ Assert output including trailing newlines.
|
|
|
186
189
|
## Guardrails
|
|
187
190
|
|
|
188
191
|
- Do not modify DreamCLI core internals for consumer-app requests.
|
|
189
|
-
- Keep generated imports on
|
|
190
|
-
|
|
192
|
+
- Keep generated imports on the documented package entrypoints: `@kjanat/dreamcli`
|
|
193
|
+
and its `/testkit`, `/runtime`, `/completion`, `/config`, `/json-schema`,
|
|
194
|
+
`/prompt`, `/schema`, and `/version` subpaths; never reach into `#internals/*`
|
|
195
|
+
or `dist/`.
|
|
191
196
|
- Preserve the typed resolution flow: argv, stdin, env, config, prompt, default.
|
|
192
197
|
- Keep stdout machine-clean: progress and status go to stderr via `out.status()`,
|
|
193
198
|
never interleaved with `out.json()`.
|