kebab case options

mmkal · mmkal · commit 4800ca3aed87 · 2025-03-18T12:50:10.000-04:00
diff --git a/README.md b/README.md
@@ -167,7 +167,7 @@ Which could be invoked with any of:
 
 #### Flags
 
-`z.object(...)` inputs become flags (passed with `--foo bar` or `--foo=bar`) syntax. Values are accepted in either `--camelCase` or `--kebab-case`, and are parsed like in most CLI programs:
+`z.object(...)` inputs become flags (passed with `--foo bar` or `--foo=bar`) syntax. Values are accepted in `--kebab-case`, and are parsed like in most CLI programs:
 
 Strings:
 
@@ -198,6 +198,11 @@ Other types:
 - `z.object({ foo: z.object({ bar: z.number() }) })` will parse inputs as JSON:
    - `--foo '{"bar": 1}'` maps to `{foo: {bar: 1}}`
 
+Multi-word flags:
+
+- `z.object({ multiWord: z.string() })` will map:
+  - `--multi-word foo` to `{multiWord: 'foo'}`
+
 Unions and intersections should also work as expected, but make sure to test them thoroughly, especially if they are deeply-nested.
 
 #### Both
@@ -642,20 +647,18 @@ In general, you should rely on `trpc-cli` to correctly handle the lifecycle and
 
 ## Features and Limitations
 
-- Nested subrouters ([example](./test/fixtures//migrations.ts)) - command will be dot separated e.g. `search.byId`
+- Nested subrouters ([example](./test/fixtures/migrations.ts)) - procedures in nested routers will become subcommands will be dot separated e.g. `mycli search byId --id 123`
 - Middleware, `ctx`, multi-inputs work as normal
 - Return values are logged using `console.info` (can be configured to pass in a custom logger)
 - `process.exit(...)` called with either 0 or 1 depending on successful resolve
 - Help text shown on invalid inputs
-- Support kebab-case flag aliases
-- Support flag aliases via `alias` callback (see migrations example below)
+- Support flag aliases via `aliases` meta property (see migrations example below)
 - Union types work, but they should ideally be non-overlapping for best results
 - Limitation: Only zod types are supported right now
 - Limitation: Only object types are allowed as input. No positional arguments supported
    - If there's interest, this could be added in future for inputs of type `z.string()` or `z.tuple([z.string(), ...])`
 - Limitation: Nested-object input props must be passed as json
    - e.g. `z.object({ foo: z.object({ bar: z.number() }) }))` can be supplied via using `--foo '{"bar": 123}'`
-   - If there's interest, support for `--foo.bar=1` could be added using [type-flag's dot-nested flags](https://github.com/privatenumber/type-flag?tab=readme-ov-file#dot-nested-flags) but edge cases/preprocessing needs proper consideration first.
 - Limitation: No `subscription` support.
    - In theory, this might be supportable via `@inquirer/prompts`. Proposals welcome!
 
diff --git a/test/e2e.test.ts b/test/e2e.test.ts
@@ -380,13 +380,13 @@ test('fs copy', async () => {
     Usage: fs diff [options] <Base path> <Head path>
 
     Arguments:
-      Base path                     Base path (required)
-      Head path                     Head path (required)
+      Base path                      Base path (required)
+      Head path                      Head path (required)
 
     Options:
-      --ignoreWhitespace [boolean]  Ignore whitespace changes (default: false)
-      --trim [boolean]              Trim start/end whitespace (default: false)
-      -h, --help                    display help for command
+      --ignore-whitespace [boolean]  Ignore whitespace changes (default: false)
+      --trim [boolean]               Trim start/end whitespace (default: false)
+      -h, --help                     display help for command
     "
   `)
 })
@@ -396,20 +396,20 @@ test('fs diff', async () => {
     "Usage: fs diff [options] <Base path> <Head path>
 
     Arguments:
-      Base path                     Base path (required)
-      Head path                     Head path (required)
+      Base path                      Base path (required)
+      Head path                      Head path (required)
 
     Options:
-      --ignoreWhitespace [boolean]  Ignore whitespace changes (default: false)
-      --trim [boolean]              Trim start/end whitespace (default: false)
-      -h, --help                    display help for command"
+      --ignore-whitespace [boolean]  Ignore whitespace changes (default: false)
+      --trim [boolean]               Trim start/end whitespace (default: false)
+      -h, --help                     display help for command"
   `)
   expect(await tsx('fs', ['diff', 'one', 'two'])).toMatchInlineSnapshot(`""`)
   expect(await tsx('fs', ['diff', 'one', 'three'])).toMatchInlineSnapshot(
     `"base and head differ at index 0 ("a" !== "x")"`,
   )
   expect(await tsx('fs', ['diff', 'three', 'four'])).toMatchInlineSnapshot(`"base has length 5 and head has length 6"`)
-  expect(await tsx('fs', ['diff', 'three', 'four', '--ignoreWhitespace'])).toMatchInlineSnapshot(`""`)
+  expect(await tsx('fs', ['diff', 'three', 'four', '--ignore-whitespace'])).toMatchInlineSnapshot(`""`)
 })
 
 test('thrown error in procedure includes call stack', async () => {
diff --git a/test/zod-inputs.test.ts b/test/zod-inputs.test.ts
@@ -285,10 +285,10 @@ test('custom default procedure', async () => {
 
   const params: TrpcCliParams<typeof yarn> = {router: yarn}
 
-  const yarnOutput = await runWith(params, ['--frozenLockfile'])
+  const yarnOutput = await runWith(params, ['--frozen-lockfile'])
   expect(yarnOutput).toMatchInlineSnapshot(`"install: {"frozenLockfile":true}"`)
 
-  const yarnInstallOutput = await runWith(params, ['install', '--frozenLockfile'])
+  const yarnInstallOutput = await runWith(params, ['install', '--frozen-lockfile'])
   expect(yarnInstallOutput).toMatchInlineSnapshot(`"install: {"frozenLockfile":true}"`)
 })
 
@@ -302,7 +302,7 @@ test('command alias', async () => {
 
   const params: TrpcCliParams<typeof yarn> = {router: yarn}
 
-  const yarnIOutput = await runWith(params, ['i', '--frozenLockfile'])
+  const yarnIOutput = await runWith(params, ['i', '--frozen-lockfile'])
   expect(yarnIOutput).toMatchInlineSnapshot(`"install: {"frozenLockfile":true}"`)
 })
 
