argsbarg 1.4.0 → 1.4.2
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/.cursor/plans/mcp_v1.2_invocation_and_extensions_a4f82c1e.plan.md +647 -0
- package/.cursor/plans/v1.3_parser_ergonomics_b3e91f02.plan.md +455 -0
- package/CHANGELOG.md +28 -1
- package/README.md +11 -7
- package/docs/mcp.md +96 -7
- package/examples/mcp-test.ts +66 -0
- package/index.d.ts +111 -33
- package/package.json +1 -1
- package/src/completion.ts +55 -1
- package/src/context.ts +42 -1
- package/src/help.ts +12 -2
- package/src/index.test.ts +648 -6
- package/src/index.ts +12 -1
- package/src/invoke.ts +1 -1
- package/src/mcp/env.ts +99 -0
- package/src/mcp/server.ts +34 -22
- package/src/mcp/tools.ts +59 -6
- package/src/mcp.ts +4 -0
- package/src/parse.ts +77 -10
- package/src/runtime.ts +1 -1
- package/src/types.ts +66 -11
- package/src/validate.ts +54 -16
|
@@ -0,0 +1,455 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: v1.3 — parser ergonomics
|
|
3
|
+
overview: "Four targeted parser and DX improvements: nested fallbackCommand on any routing node, varargs + trailing options interleaved (fixes --flag after positionals), ctx.positional(name) named accessor, and MCP string→array coercion for varargs positionals."
|
|
4
|
+
todos:
|
|
5
|
+
- id: types-jsdoc
|
|
6
|
+
content: "Step 1: Update JSDoc on fallbackCommand/fallbackMode to remove 'root-only' / 'top-level' language; no type changes needed"
|
|
7
|
+
status: completed
|
|
8
|
+
- id: validate-fallback
|
|
9
|
+
content: "Step 2: Remove root-only restriction on fallbackCommand/fallbackMode in validate.ts; add validation that fallbackCommand names a valid child key on any routing node"
|
|
10
|
+
status: completed
|
|
11
|
+
- id: parser-fallback
|
|
12
|
+
content: "Step 3: Extend routing loop to apply fallbackCommand/fallbackMode at non-root routing nodes (mirrors existing root logic)"
|
|
13
|
+
status: completed
|
|
14
|
+
- id: parser-varargs-trailing
|
|
15
|
+
content: "Step 4: Fix finishLeaf varargs loop to interleave known-option scanning instead of greedy-consuming all remaining tokens"
|
|
16
|
+
status: completed
|
|
17
|
+
- id: ctx-positional
|
|
18
|
+
content: "Step 5: Add ctx.positional(name) accessor to CliContext — named positional lookup computed from schema + commandPath + args"
|
|
19
|
+
status: completed
|
|
20
|
+
- id: mcp-coerce
|
|
21
|
+
content: "Step 6: Coerce string → string[] in mcpToolCallToArgv for varargs positionals (comma-split or single-item)"
|
|
22
|
+
status: completed
|
|
23
|
+
- id: tests
|
|
24
|
+
content: "Step 7: Unit + integration tests for all four features"
|
|
25
|
+
status: completed
|
|
26
|
+
- id: docs-changelog
|
|
27
|
+
content: "Step 8: Update README, CHANGELOG, docs/mcp.md; run just typegen and just test"
|
|
28
|
+
status: completed
|
|
29
|
+
isProject: false
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
# v1.3 — parser ergonomics
|
|
33
|
+
|
|
34
|
+
Four parser and DX improvements. No new runtime dependencies, no public API removals, no MCP protocol changes. All four were explicitly deferred from v1.2 and follow directly from consumer app feedback.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Background
|
|
39
|
+
|
|
40
|
+
From reading the current source before writing this plan:
|
|
41
|
+
|
|
42
|
+
- **`fallbackCommand` types already support non-root** — `CliCommand` union allows `fallbackCommand` on any router node. The restriction is purely in `validate.ts` lines 39–52 (`!isRoot && cmd.fallbackCommand !== undefined → throw`). Parser fix is in the routing `while(true)` loop.
|
|
43
|
+
- **Trailing options are already partially wired** — `finishLeaf` calls `consumeOptions` on the tail for bounded-arity positionals (see `allowsTrailingOptions`). The gap is varargs (`argMax === 0`): the greedy loop at line 289–304 consumes all remaining tokens before any trailing option scan can happen.
|
|
44
|
+
- **`ctx.positional(name)`** — `CliContext` has `args: string[]` and `schema: CliCommand`. Named positional access can be computed from those; no parser change required.
|
|
45
|
+
- **MCP string→array coercion** — `mcpToolCallToArgv` currently requires `args[pos.name]` to be `string[]` for varargs. Accepts only arrays; agents passing `"a,b"` or `"a"` silently fail.
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Implementation order
|
|
50
|
+
|
|
51
|
+
1. JSDoc cleanup (no logic)
|
|
52
|
+
2. Validation: remove root-only fallback restriction
|
|
53
|
+
3. Parser: nested fallback routing
|
|
54
|
+
4. Parser: varargs + trailing options interleaved
|
|
55
|
+
5. `ctx.positional(name)`
|
|
56
|
+
6. MCP string→array coercion
|
|
57
|
+
7. Tests
|
|
58
|
+
8. Docs + changelog
|
|
59
|
+
|
|
60
|
+
Do steps 3 and 4 independently — they touch different parts of `parse.ts`. Step 3 is the routing loop; step 4 is `finishLeaf`. Both must pass existing tests before moving on.
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Step 1: JSDoc ([`src/types.ts`](src/types.ts))
|
|
65
|
+
|
|
66
|
+
No type changes. Update JSDoc on the router branch of `CliCommand`:
|
|
67
|
+
|
|
68
|
+
- `fallbackCommand`: change "Default **top-level** subcommand" → "Default subcommand"
|
|
69
|
+
- `fallbackMode`: change "How fallbackCommand is applied" — add note that both fields work on any routing node, not just root
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Step 2: Validation ([`src/validate.ts`](src/validate.ts))
|
|
74
|
+
|
|
75
|
+
### Remove root-only restriction
|
|
76
|
+
|
|
77
|
+
Delete lines 39–52 entirely:
|
|
78
|
+
```typescript
|
|
79
|
+
// DELETE:
|
|
80
|
+
if (!isRoot && cmd.fallbackCommand !== undefined) {
|
|
81
|
+
throw new CliSchemaValidationError(
|
|
82
|
+
"Fallback is only supported on the program root (not on " + cmd.key + ")",
|
|
83
|
+
);
|
|
84
|
+
}
|
|
85
|
+
if (!isRoot && cmd.fallbackMode !== undefined && ...) {
|
|
86
|
+
throw new CliSchemaValidationError(
|
|
87
|
+
"fallbackMode may only be set on the program root (not on " + cmd.key + ")",
|
|
88
|
+
);
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Add fallbackCommand child validation (apply to ALL routing nodes, not just root)
|
|
93
|
+
|
|
94
|
+
After the duplicate child name check (the `seenNames` loop), add:
|
|
95
|
+
|
|
96
|
+
```typescript
|
|
97
|
+
// fallbackMode without fallbackCommand is always invalid — check unconditionally
|
|
98
|
+
if (cmd.fallbackMode !== undefined && cmd.fallbackCommand === undefined) {
|
|
99
|
+
throw new CliSchemaValidationError(
|
|
100
|
+
`fallbackMode requires fallbackCommand on '${cmd.key}'`,
|
|
101
|
+
);
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
if (cmd.fallbackCommand !== undefined) {
|
|
105
|
+
const children = cmd.commands ?? [];
|
|
106
|
+
const valid = children.find((c) => c.key === cmd.fallbackCommand);
|
|
107
|
+
if (!valid) {
|
|
108
|
+
throw new CliSchemaValidationError(
|
|
109
|
+
`fallbackCommand '${cmd.fallbackCommand}' is not a child of '${cmd.key}'`,
|
|
110
|
+
);
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
**Note:** The existing root-level validation already does the child-lookup check implicitly via the runtime. Moving it into schema validation means it's caught at startup, not at dispatch time.
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## Step 3: Parser — nested `fallbackCommand` ([`src/parse.ts`](src/parse.ts))
|
|
120
|
+
|
|
121
|
+
The routing `while(true)` loop (line ~459) has two places where non-root routing nodes currently error. Both need fallback logic inserted before the error return.
|
|
122
|
+
|
|
123
|
+
### Place 1: End of argv, current node has children (line ~485)
|
|
124
|
+
|
|
125
|
+
Currently: `return helpResult(path, false)` when `current.commands.length > 0` and argv is exhausted.
|
|
126
|
+
|
|
127
|
+
Add before that return:
|
|
128
|
+
```typescript
|
|
129
|
+
if ((current.commands ?? []).length > 0) {
|
|
130
|
+
const fb = current.fallbackCommand;
|
|
131
|
+
const fm = current.fallbackMode ?? CliFallbackMode.MissingOnly;
|
|
132
|
+
if (
|
|
133
|
+
fb !== undefined &&
|
|
134
|
+
(fm === CliFallbackMode.MissingOnly || fm === CliFallbackMode.MissingOrUnknown)
|
|
135
|
+
) {
|
|
136
|
+
const fbNode = findChild(current.commands ?? [], fb);
|
|
137
|
+
if (fbNode) {
|
|
138
|
+
path.push(fb);
|
|
139
|
+
current = fbNode;
|
|
140
|
+
continue;
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
return helpResult(path, false);
|
|
144
|
+
}
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Place 2: Unknown subcommand token (line ~515–526)
|
|
148
|
+
|
|
149
|
+
Currently: `return error "Unknown subcommand: tok"` when the token doesn't match any child.
|
|
150
|
+
|
|
151
|
+
Add before that return:
|
|
152
|
+
```typescript
|
|
153
|
+
if ((current.commands ?? []).length > 0) {
|
|
154
|
+
const fb = current.fallbackCommand;
|
|
155
|
+
const fm = current.fallbackMode ?? CliFallbackMode.MissingOnly;
|
|
156
|
+
const canRouteUnknown =
|
|
157
|
+
fb !== undefined &&
|
|
158
|
+
(fm === CliFallbackMode.MissingOrUnknown || fm === CliFallbackMode.UnknownOnly);
|
|
159
|
+
|
|
160
|
+
if (canRouteUnknown) {
|
|
161
|
+
const fbNode = findChild(current.commands ?? [], fb!);
|
|
162
|
+
if (fbNode) {
|
|
163
|
+
// Do NOT advance i — the unrecognized token stays as argv for the fallback
|
|
164
|
+
path.push(fb!);
|
|
165
|
+
current = fbNode;
|
|
166
|
+
continue;
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
return { kind: ParseKind.Error, ..., errorMsg: `Unknown subcommand: ${tok}` };
|
|
170
|
+
}
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
This mirrors the root-level fallback logic at lines 406–452 exactly. The same `CliFallbackMode` semantics apply at every routing level.
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## Step 4: Parser — varargs + trailing options ([`src/parse.ts`](src/parse.ts) — `finishLeaf`)
|
|
178
|
+
|
|
179
|
+
### The problem
|
|
180
|
+
|
|
181
|
+
`finishLeaf`'s varargs branch (line ~289–304):
|
|
182
|
+
```typescript
|
|
183
|
+
if (argMax === 0) {
|
|
184
|
+
while (idx < argv.length) {
|
|
185
|
+
args.push(argv[idx]); // ← greedy: swallows --json and all flags
|
|
186
|
+
idx += 1;
|
|
187
|
+
count += 1;
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
All remaining tokens (including `--flag` tokens) are consumed as positionals. The trailing option scan at lines 307–325 never runs because `idx === argv.length` after the greedy loop.
|
|
193
|
+
|
|
194
|
+
### The fix
|
|
195
|
+
|
|
196
|
+
Replace the greedy varargs loop with an interleaved loop that recognizes known options:
|
|
197
|
+
|
|
198
|
+
```typescript
|
|
199
|
+
if (argMax === 0) {
|
|
200
|
+
while (idx < argv.length) {
|
|
201
|
+
const tok = argv[idx];
|
|
202
|
+
|
|
203
|
+
// -- separator: force remaining tokens as positionals
|
|
204
|
+
if (!forcePositionals && tok === "--") {
|
|
205
|
+
forcePositionals = true;
|
|
206
|
+
idx++;
|
|
207
|
+
continue;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
// Scoped help inside varargs tail — mirrors bounded path at lines 312–314
|
|
211
|
+
if (!forcePositionals && isHelpTok(tok)) {
|
|
212
|
+
return helpResult(path, true);
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
// Possible option token: attempt to consume as a known flag
|
|
216
|
+
if (!forcePositionals && tok.startsWith("-")) {
|
|
217
|
+
// MUST be false — lenient mode swallows unknown flags as positionals silently
|
|
218
|
+
const tailRep = consumeOptions(optionDefs, false, argv, idx, opts);
|
|
219
|
+
if (tailRep.report.err) {
|
|
220
|
+
return errorResult(tailRep.report.err);
|
|
221
|
+
}
|
|
222
|
+
if (tailRep.report.sawDoubleDash) {
|
|
223
|
+
forcePositionals = true;
|
|
224
|
+
}
|
|
225
|
+
if (tailRep.nextIndex > idx) {
|
|
226
|
+
// Consumed one or more options — loop without pushing a positional
|
|
227
|
+
idx = tailRep.nextIndex;
|
|
228
|
+
continue;
|
|
229
|
+
}
|
|
230
|
+
// consumeOptions stopped without advancing (unknown token in lenient mode
|
|
231
|
+
// would return stoppedOnUnknown, but we pass lenientUnknown=false, so
|
|
232
|
+
// any unknown -flag is already an error above). Fallthrough to error.
|
|
233
|
+
return errorResult(`Unexpected option token: ${tok}`);
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
// Plain positional token
|
|
237
|
+
args.push(tok);
|
|
238
|
+
idx++;
|
|
239
|
+
count++;
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
**Key rules:**
|
|
245
|
+
- `consumeOptions` is called with `lenientUnknown: false` — unknown flags in varargs tails are still errors, not silently treated as positionals
|
|
246
|
+
- `--` terminates option scanning exactly as before; tokens after it go straight to `args`
|
|
247
|
+
- Bounded positionals are unchanged — their existing trailing option scan at lines 307–325 still runs and is unaffected
|
|
248
|
+
|
|
249
|
+
**Remove `allowsTrailingOptions`** — it becomes dead code once varargs interleaves. Delete the function and its call site.
|
|
250
|
+
|
|
251
|
+
---
|
|
252
|
+
|
|
253
|
+
## Step 5: `ctx.positional(name)` ([`src/context.ts`](src/context.ts))
|
|
254
|
+
|
|
255
|
+
### Accessor
|
|
256
|
+
|
|
257
|
+
```typescript
|
|
258
|
+
/**
|
|
259
|
+
* Returns the value(s) for a named positional slot.
|
|
260
|
+
* Varargs slots (argMax === 0) return string[]; single slots return string | undefined.
|
|
261
|
+
*/
|
|
262
|
+
positional(name: string): string | string[] | undefined {
|
|
263
|
+
return this._positionalMap()[name];
|
|
264
|
+
}
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
### Implementation (`_positionalMap`)
|
|
268
|
+
|
|
269
|
+
Compute lazily and cache. Walk `this.schema` along `this.commandPath` to find the leaf, then map positional definitions to slices of `this.args`:
|
|
270
|
+
|
|
271
|
+
```typescript
|
|
272
|
+
private _posMap: Record<string, string | string[]> | undefined;
|
|
273
|
+
|
|
274
|
+
private _positionalMap(): Record<string, string | string[]> {
|
|
275
|
+
if (this._posMap) return this._posMap;
|
|
276
|
+
|
|
277
|
+
let node: CliCommand = this.schema;
|
|
278
|
+
for (const seg of this.commandPath) {
|
|
279
|
+
const child = (node.commands ?? []).find((c) => c.key === seg);
|
|
280
|
+
if (!child) { this._posMap = {}; return {}; }
|
|
281
|
+
node = child;
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
const map: Record<string, string | string[]> = {};
|
|
285
|
+
let argIdx = 0;
|
|
286
|
+
for (const p of node.positionals ?? []) {
|
|
287
|
+
const { argMax = 1 } = p;
|
|
288
|
+
if (argMax === 0) {
|
|
289
|
+
map[p.name] = this.args.slice(argIdx);
|
|
290
|
+
argIdx = this.args.length;
|
|
291
|
+
} else {
|
|
292
|
+
const val = this.args[argIdx];
|
|
293
|
+
if (val !== undefined) map[p.name] = val;
|
|
294
|
+
argIdx++;
|
|
295
|
+
}
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
this._posMap = map;
|
|
299
|
+
return map;
|
|
300
|
+
}
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
**Return type semantics:**
|
|
304
|
+
- Varargs (`argMax === 0`) → always `string[]` (may be empty)
|
|
305
|
+
- Single slot (`argMax === 1`) → `string` if present, `undefined` if optional and absent
|
|
306
|
+
- Always consistent with `ctx.args` — `ctx.positional` is a named view over the same data
|
|
307
|
+
|
|
308
|
+
**No changes to `ctx.args`** — existing handlers continue to work; this is purely additive.
|
|
309
|
+
|
|
310
|
+
### Export
|
|
311
|
+
|
|
312
|
+
Add `positional` to the public method list in JSDoc. No changes to `src/index.ts` needed — `CliContext` is already exported and consumers get the new method automatically.
|
|
313
|
+
|
|
314
|
+
---
|
|
315
|
+
|
|
316
|
+
## Step 6: MCP string→array coercion ([`src/mcp/tools.ts`](src/mcp/tools.ts) — `mcpToolCallToArgv`)
|
|
317
|
+
|
|
318
|
+
### Current behavior (varargs positional)
|
|
319
|
+
|
|
320
|
+
```typescript
|
|
321
|
+
// Current:
|
|
322
|
+
const val = args[pos.name];
|
|
323
|
+
// assumes val is string[] — agents passing "a,b" or "a" get undefined behavior
|
|
324
|
+
argv.push(...(val as string[]));
|
|
325
|
+
```
|
|
326
|
+
|
|
327
|
+
### Fix
|
|
328
|
+
|
|
329
|
+
```typescript
|
|
330
|
+
const raw = args[pos.name];
|
|
331
|
+
let items: string[];
|
|
332
|
+
if (Array.isArray(raw)) {
|
|
333
|
+
items = raw.map(String);
|
|
334
|
+
} else if (typeof raw === "string") {
|
|
335
|
+
// Coerce: comma-split or single item
|
|
336
|
+
items = raw.includes(",")
|
|
337
|
+
? raw.split(",").map((s) => s.trim()).filter(Boolean)
|
|
338
|
+
: raw.trim() ? [raw.trim()] : [];
|
|
339
|
+
} else {
|
|
340
|
+
items = [];
|
|
341
|
+
}
|
|
342
|
+
argv.push(...items);
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
**`inputSchema` stays `{ type: "array", items: { type: "string" } }`** — array is the correct type for well-behaved agents. The coercion is a silent recovery from agents that pass strings anyway. Do not change the schema to `oneOf` — that complicates the JSON Schema unnecessarily.
|
|
346
|
+
|
|
347
|
+
**Single string `"a"` → `["a"]`** (not comma-split). Comma is the delimiter only when present.
|
|
348
|
+
|
|
349
|
+
---
|
|
350
|
+
|
|
351
|
+
## Step 7: Tests ([`src/index.test.ts`](src/index.test.ts))
|
|
352
|
+
|
|
353
|
+
### Nested `fallbackCommand` — unit tests
|
|
354
|
+
|
|
355
|
+
1. Router node with `fallbackCommand` and empty argv → routes to fallback leaf.
|
|
356
|
+
2. Router node with `fallbackCommand` + `MissingOrUnknown` + unknown token → routes to fallback (token stays in argv for fallback leaf).
|
|
357
|
+
3. Router node with `fallbackCommand` + `MissingOnly` + unknown token → error "Unknown subcommand".
|
|
358
|
+
4. `cliValidateRoot` rejects `fallbackCommand` naming a non-existent child on a non-root node.
|
|
359
|
+
5. `cliValidateRoot` accepts `fallbackCommand` on a non-root router node when child exists.
|
|
360
|
+
6. Scoped help: `myapp docs --help` on a router with fallback → shows docs subcommands, not fallback content.
|
|
361
|
+
|
|
362
|
+
### Varargs + trailing options — unit tests
|
|
363
|
+
|
|
364
|
+
7. `cliInvoke(root, ["read", "file.txt", "--json"])` where `read` has varargs positional and `--json` is a known option → `kind: "ok"`, `args: ["file.txt"]`, `opts: { json: "1" }`.
|
|
365
|
+
8. `cliInvoke(root, ["read", "--json", "file.txt"])` → same result (option before varargs).
|
|
366
|
+
9. `cliInvoke(root, ["read", "a.txt", "b.txt", "--json"])` → `args: ["a.txt", "b.txt"]`, `opts: { json: "1" }`.
|
|
367
|
+
10. `cliInvoke(root, ["read", "file.txt", "--", "--json"])` → `args: ["file.txt", "--json"]`, `opts: {}` (`--` forces positional).
|
|
368
|
+
11. `cliInvoke(root, ["read", "--unknown"])` → `kind: "error"`, errorMsg mentions `--unknown`.
|
|
369
|
+
12. `parse(root, ["read", "file.txt", "--help"])` on a varargs leaf → `kind: Help`, `helpPath` contains `"read"` (scoped help, not an error). This guards the `isHelpTok` insertion.
|
|
370
|
+
|
|
371
|
+
**Regression test inversion:** The existing test `"varargs tail does not parse trailing options"` (approximately line 337 in `index.test.ts`) currently *asserts the broken behavior* — `--json` ends up in `args`. Invert it: after Step 4, assert `--json` is in `opts` and absent from `args`. Do this as part of Step 7, not before.
|
|
372
|
+
|
|
373
|
+
### `ctx.positional(name)` — unit tests
|
|
374
|
+
|
|
375
|
+
13. Handler reads `ctx.positional("path")` on single-slot positional — returns the string value.
|
|
376
|
+
14. Handler reads `ctx.positional("files")` on varargs positional — returns `string[]`.
|
|
377
|
+
15. Handler reads `ctx.positional("opt")` on absent optional positional — returns `undefined`.
|
|
378
|
+
16. `ctx.positional("files")` consistent with `ctx.args`: `ctx.positional("files")` deep-equals `ctx.args` when there is one varargs positional.
|
|
379
|
+
|
|
380
|
+
### MCP string→array coercion — unit tests
|
|
381
|
+
|
|
382
|
+
17. `mcpToolCallToArgv` with varargs positional: `args: { files: "a,b" }` → argv includes `"a"`, `"b"` as separate tokens.
|
|
383
|
+
18. `mcpToolCallToArgv` with varargs positional: `args: { files: "a" }` (no comma) → argv includes `"a"` once.
|
|
384
|
+
19. `mcpToolCallToArgv` with varargs positional: `args: { files: ["a","b"] }` (array) → unchanged behavior.
|
|
385
|
+
20. `mcpToolCallToArgv` with varargs positional: `args: { files: "" }` (empty string) → no tokens appended.
|
|
386
|
+
|
|
387
|
+
---
|
|
388
|
+
|
|
389
|
+
## Step 8: Docs + changelog
|
|
390
|
+
|
|
391
|
+
### [`README.md`](README.md)
|
|
392
|
+
|
|
393
|
+
- Update `fallbackCommand` / `fallbackMode` table to note they work on any routing node.
|
|
394
|
+
- Add `ctx.positional(name)` to the Reading values section.
|
|
395
|
+
|
|
396
|
+
### [`docs/mcp.md`](docs/mcp.md)
|
|
397
|
+
|
|
398
|
+
- Note MCP string→array coercion under tool arguments: agents may pass a comma-separated string for varargs positionals.
|
|
399
|
+
|
|
400
|
+
### [`CHANGELOG.md`](CHANGELOG.md) — `[Unreleased]` → Added / Fixed
|
|
401
|
+
|
|
402
|
+
**Added:**
|
|
403
|
+
- `fallbackCommand` / `fallbackMode` now work on any routing node, not just the program root
|
|
404
|
+
- `ctx.positional(name)` — named positional lookup; varargs return `string[]`, single slots return `string | undefined`
|
|
405
|
+
- MCP varargs coercion: agents may pass `"a,b"` or `"a"` where `string[]` is expected
|
|
406
|
+
|
|
407
|
+
**Fixed:**
|
|
408
|
+
- Known options (`--flag`) after varargs positionals now parse correctly instead of being consumed as positional tokens
|
|
409
|
+
|
|
410
|
+
### Typegen
|
|
411
|
+
|
|
412
|
+
```
|
|
413
|
+
just typegen
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
Verify `index.d.ts` reflects the new `positional` method on `CliContext`. No other new public types in this release.
|
|
417
|
+
|
|
418
|
+
---
|
|
419
|
+
|
|
420
|
+
## Pitfalls (do NOT)
|
|
421
|
+
|
|
422
|
+
- Change `inputSchema` for varargs from `array` to `oneOf` — coercion is silent, schema stays canonical
|
|
423
|
+
- Remove `ctx.args` — additive only; existing handlers must continue to work
|
|
424
|
+
- Apply nested fallback logic before the existing root fallback — the root-level fallback code (lines 406–452 in `parse.ts`) stays as-is; the new code mirrors it in the routing loop body
|
|
425
|
+
- Use `lenientUnknown: true` in the varargs interleaved option scan — unknown flags in varargs tails must still error
|
|
426
|
+
- Break `allowsTrailingOptions` callers before deleting it — verify it has only one call site (line 308) before removing
|
|
427
|
+
|
|
428
|
+
---
|
|
429
|
+
|
|
430
|
+
## File change summary
|
|
431
|
+
|
|
432
|
+
| File | Action |
|
|
433
|
+
|------|--------|
|
|
434
|
+
| [`src/types.ts`](src/types.ts) | JSDoc updates only |
|
|
435
|
+
| [`src/validate.ts`](src/validate.ts) | Remove root-only fallback restriction; add child-key validation for all routing nodes |
|
|
436
|
+
| [`src/parse.ts`](src/parse.ts) | Nested fallback in routing loop; varargs interleaved option scan; remove `allowsTrailingOptions` |
|
|
437
|
+
| [`src/context.ts`](src/context.ts) | `positional(name)` accessor + `_positionalMap` private helper |
|
|
438
|
+
| [`src/mcp/tools.ts`](src/mcp/tools.ts) | String→array coercion in `mcpToolCallToArgv` |
|
|
439
|
+
| [`src/index.test.ts`](src/index.test.ts) | All new tests |
|
|
440
|
+
| [`README.md`](README.md) | fallback + ctx.positional docs |
|
|
441
|
+
| [`docs/mcp.md`](docs/mcp.md) | MCP coercion note |
|
|
442
|
+
| [`CHANGELOG.md`](CHANGELOG.md) | Unreleased entries |
|
|
443
|
+
| [`index.d.ts`](index.d.ts) | Regenerated via `just typegen` |
|
|
444
|
+
|
|
445
|
+
---
|
|
446
|
+
|
|
447
|
+
## Out of scope (explicitly deferred)
|
|
448
|
+
|
|
449
|
+
- `ctx.positional` type overloads by argMax — return type is `string | string[] | undefined` for all slots; narrowing by schema type is possible but requires conditional types and adds complexity without clear benefit
|
|
450
|
+
- `mcpTool.group` / `risk` / `requiresTty` annotations
|
|
451
|
+
- `structuredError` for JSON on exit(1)
|
|
452
|
+
- Streaming tool calls
|
|
453
|
+
- Shared option groups / `extends`
|
|
454
|
+
- Output truncation in MCP results
|
|
455
|
+
- GNU-style option parsing before command routing (options mixed with subcommand tokens at root level)
|
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [1.4.2] - 2026-06-19
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- **`fallbackCommand` / `fallbackMode` on any routing node** — nested routers can define default subcommand routing, not just the program root.
|
|
15
|
+
- **`ctx.positional(name)`** — named positional lookup; varargs return `string[]`, single slots return `string | undefined`.
|
|
16
|
+
- **MCP varargs coercion** — agents may pass `"a,b"` or `"a"` where `string[]` is expected.
|
|
17
|
+
|
|
18
|
+
### Fixed
|
|
19
|
+
|
|
20
|
+
- **Known options after varargs positionals** — `--flag` tokens after a varargs tail parse as options instead of being consumed as positional arguments.
|
|
21
|
+
|
|
22
|
+
## [1.4.1] - 2026-06-19
|
|
23
|
+
|
|
24
|
+
### Added
|
|
25
|
+
|
|
26
|
+
- **`ctx.invocation`** (`"cli"` or `"mcp"`) on `CliContext` for handler branching.
|
|
27
|
+
- **`cliInvoke`** and `CliInvokeResult` exported from the public API.
|
|
28
|
+
- **`CliOptionKind.Enum`** with `choices` — JSON Schema `enum`, shell completions, parse validation, help labels.
|
|
29
|
+
- **`mcpTool.description`** — per-leaf MCP tool description override.
|
|
30
|
+
- **`mcpTool.requiresEnv`** — env requirements in auto-generated descriptions; enforced at `tools/call` (empty string counts as absent).
|
|
31
|
+
- **`mcpServer.resources`** — pluggable `CliMcpResource` items in `resources/list` and `resources/read`.
|
|
32
|
+
- **`mcpServer.shellEnv`** — login-shell env captured at MCP server start; `PATH` always merged, other vars fill gaps in host env.
|
|
33
|
+
- **`mcpServer.envFile`** — `.env` file loaded into `process.env` after `shellEnv` (warns on stderr if missing).
|
|
34
|
+
|
|
10
35
|
## [1.4.0] - 2026-06-19
|
|
11
36
|
|
|
12
37
|
### Added
|
|
@@ -98,7 +123,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
98
123
|
- Migrate schemas: rename every `children` property to **`commands`**; move positional definitions to **`CliPositional`** objects on `positionals` and strip `positional` / `argMin` / `argMax` from flag definitions under `options` (flags only carry `name`, `description`, `kind`, and optional `shortName`).
|
|
99
124
|
- Imports: use `CliPositional` where needed; replace `CliOptionDef` with `CliOption` or `CliPositional` as appropriate.
|
|
100
125
|
|
|
101
|
-
[Unreleased]: https://github.com/bdombro/bun-argsbarg/compare/v1.4.
|
|
126
|
+
[Unreleased]: https://github.com/bdombro/bun-argsbarg/compare/v1.4.2...HEAD
|
|
127
|
+
[1.4.2]: https://github.com/bdombro/bun-argsbarg/releases/tag/v1.4.2
|
|
128
|
+
[1.4.1]: https://github.com/bdombro/bun-argsbarg/releases/tag/v1.4.1
|
|
102
129
|
[1.4.0]: https://github.com/bdombro/bun-argsbarg/releases/tag/v1.4.0
|
|
103
130
|
[1.3.1]: https://github.com/bdombro/bun-argsbarg/releases/tag/v1.3.1
|
|
104
131
|
[1.3.0]: https://github.com/bdombro/bun-argsbarg/releases/tag/v1.3.0
|
package/README.md
CHANGED
|
@@ -78,7 +78,7 @@ await cliRun(cli);
|
|
|
78
78
|
Everything you need for a first-class CLI:
|
|
79
79
|
|
|
80
80
|
- **Nested subcommands** (`CliCommand` with `commands` for groups, `handler` for leaves)
|
|
81
|
-
- **POSIX-style options** (`-x`, `--long`, `--long=value`)
|
|
81
|
+
- **POSIX-style options** (`-x`, `--long`, `--long=value`) — kinds: presence, string, number, **enum** (`choices` array)
|
|
82
82
|
- **Bundled presence flags** (`-abc`)
|
|
83
83
|
- **Positional arguments and varargs tails** (`CliPositional` objects on `positionals`)
|
|
84
84
|
- **Scoped help** at any routing depth (`-h` / `--help`)
|
|
@@ -105,9 +105,9 @@ Do not declare an option named **`schema`** — it is reserved for `--schema`.
|
|
|
105
105
|
|
|
106
106
|
### MCP (AI agents)
|
|
107
107
|
|
|
108
|
-
Opt in on the program root with `mcpServer: {}` (or `{ name, version, … }`), then run `myapp mcp` for a stdio MCP server. Each leaf command becomes a tool; the CLI tree is available as resource `argsbarg://schema`.
|
|
108
|
+
Opt in on the program root with `mcpServer: {}` (or `{ name, version, … }`), then run `myapp mcp` for a stdio MCP server. Each leaf command becomes a tool; the CLI tree is available as resource `argsbarg://schema`. Handlers can read `ctx.invocation` and use `cliInvoke` for headless testing.
|
|
109
109
|
|
|
110
|
-
See **[docs/mcp.md](docs/mcp.md)** for configuration,
|
|
110
|
+
See **[docs/mcp.md](docs/mcp.md)** for configuration, env bootstrapping, custom resources, Cursor setup, and protocol details.
|
|
111
111
|
|
|
112
112
|
|
|
113
113
|
### Shell completions
|
|
@@ -132,7 +132,7 @@ bun add bun-argsbarg
|
|
|
132
132
|
|
|
133
133
|
## How it works
|
|
134
134
|
|
|
135
|
-
1. Build a **program root** `CliCommand` using pure TypeScript objects: `key` is the app/binary name, `commands` are top-level subcommands, `options` are global flags. The root must not set `handler` or declare `positionals` (validated at startup). Use `fallbackCommand` / `fallbackMode` on
|
|
135
|
+
1. Build a **program root** `CliCommand` using pure TypeScript objects: `key` is the app/binary name, `commands` are top-level subcommands, `options` are global flags. The root must not set `handler` or declare `positionals` (validated at startup). Use `fallbackCommand` / `fallbackMode` on any **routing node** for default subcommand routing (not root-only).
|
|
136
136
|
2. Call `await cliRun(root)` with that root — validates, parses argv, renders help or errors, invokes the leaf handler, and `process.exit`s with status **0** on success, **1** on implicit help or error (explicit `--help` → **0**).
|
|
137
137
|
3. From a handler, `cliErrWithHelp(ctx, "message")` prints a red error line plus contextual help on stderr and exits **1**.
|
|
138
138
|
|
|
@@ -144,7 +144,9 @@ bun add bun-argsbarg
|
|
|
144
144
|
| `MissingOrUnknown` | Default command | Default command (token becomes argv for the default) |
|
|
145
145
|
| `UnknownOnly` | Root help (exit 1) | Default command |
|
|
146
146
|
|
|
147
|
-
With `MissingOrUnknown` / `UnknownOnly`, unrecognized **
|
|
147
|
+
With `MissingOrUnknown` / `UnknownOnly`, unrecognized flags at the **current routing node** stop option consumption and the remainder is passed to the default command.
|
|
148
|
+
|
|
149
|
+
Set `fallbackCommand` / `fallbackMode` on nested routers too — e.g. `docs` with `fallbackCommand: "guide"` routes `myapp docs` to the guide leaf without requiring a root-level default.
|
|
148
150
|
|
|
149
151
|
### Positionals (help labels)
|
|
150
152
|
|
|
@@ -163,6 +165,7 @@ Add `CliPositional` entries to the command’s `positionals` list (separate from
|
|
|
163
165
|
- `ctx.stringOpt("name")` / `ctx.numberOpt("count")` — `string | undefined` / `number | null`.
|
|
164
166
|
- `ctx.typedOpt<T>("custom", parseFn)` — pass a custom parsing function for type-safe option resolution.
|
|
165
167
|
- `ctx.args` — positional words in order as `string[]`.
|
|
168
|
+
- `ctx.positional("name")` — named positional lookup; varargs slots return `string[]`, single slots return `string | undefined`.
|
|
166
169
|
- `ctx.schema` — merged program root (`CliCommand`) for contextual help.
|
|
167
170
|
|
|
168
171
|
|
|
@@ -197,10 +200,11 @@ The package root (`argsbarg` / `src/index.ts`) exports the types and runtime you
|
|
|
197
200
|
| Symbol | Role |
|
|
198
201
|
| --- | --- |
|
|
199
202
|
| `CliCommand`, `CliOption`, `CliPositional`, `CliHandler` | Schema and handler types. |
|
|
200
|
-
| `CliOptionKind`, `CliFallbackMode` | Option kinds and root fallback behavior. |
|
|
203
|
+
| `CliOptionKind`, `CliFallbackMode` | Option kinds (`Presence`, `String`, `Number`, `Enum`) and root fallback behavior. |
|
|
201
204
|
| `CliSchemaValidationError` | Thrown when the static command tree violates schema rules. |
|
|
202
|
-
| `CliContext` | Handler context (`ctx.flag`, `ctx.stringOpt`, `ctx.args`, …). |
|
|
205
|
+
| `CliContext` | Handler context (`ctx.flag`, `ctx.stringOpt`, `ctx.args`, `ctx.invocation`, …). |
|
|
203
206
|
| `cliRun(root, [argv])` | Validate, parse argv, dispatch, exit. |
|
|
207
|
+
| `cliInvoke(root, argv)` | Parse and dispatch without exiting; returns captured stdout/stderr. |
|
|
204
208
|
| `cliErrWithHelp(ctx, msg)` | Print error + scoped help on stderr, exit 1. |
|
|
205
209
|
|
|
206
210
|
Reserved identifier (validated at startup): root command **`completion`**.
|