Merge remote-tracking branch 'origin/main' into deps

Author: mmkal

src/parse-procedure.ts

@@ -477,14 +477,22 @@ const toRoughJsonSchema7 = (schema: JSONSchema7Definition | undefined): JSONSche
   return schema
 }
 
-const parameterName = (s: JSONSchema7Definition, position: number): string => {
-  if (looksLikeArray(s)) {
+const maybeParameterName = (s: JSONSchema7Definition): string | undefined => {
+  const value = schemaDefPropValue(s, 'title') || schemaDefPropValue(s, 'description')
+  // only look at array item title if we don't have one for the outer array itself
+  // e.g. for {title: 'file collection', items: {title: 'file'}} we prefer 'file collection' as the parameter name
+  if (!value && looksLikeArray(s)) {
     const items = toRoughJsonSchema7(s).items
-    const elementName = parameterName(!items || Array.isArray(items) ? {} : items, position)
-    return `[${elementName.slice(1, -1)}...]`
+    return items && !Array.isArray(items) ? maybeParameterName(items) : undefined
   }
+  return value
+}
+
+const parameterName = (s: JSONSchema7Definition, position: number): string => {
+  let name = maybeParameterName(s) || `parameter_${position}`
+  if (looksLikeArray(s)) return `[${name}...]`
+
   // commander requiremenets: no special characters in positional parameters; `<name>` for required and `[name]` for optional parameters
-  let name = schemaDefPropValue(s, 'title') || schemaDefPropValue(s, 'description') || `parameter_${position}`
   name = name.replaceAll(/\W+/g, ' ').trim()
   return isOptional(s) ? `[${name}]` : `<${name}>`
 }

test/parse.test.ts

@@ -238,6 +238,32 @@ test('non-primitive option union', async () => {
   )
 })
 
+test('positional array with title', async () => {
+  const router = t.router({
+    foo: t.procedure
+      .input(z.array(z.string()).describe('files')) //
+      .query(({input}) => JSON.stringify(input)),
+    bar: t.procedure
+      .input(z.array(z.string().describe('files'))) //
+      .query(({input}) => JSON.stringify(input)),
+    baz: t.procedure
+      .input(z.array(z.string().describe('one single file')).describe('file collection'))
+      .query(({input}) => JSON.stringify(input)),
+  })
+
+  const cli = createCli({router})
+  expect(await output(cli, ['foo', 'abc', 'def'])).toMatchInlineSnapshot(`"["abc","def"]"`)
+  expect((await output(cli, ['foo', '--help'])).split('\n')[0]).toMatchInlineSnapshot(
+    `"Usage: program foo [options] <files...>"`,
+  )
+  expect((await output(cli, ['bar', '--help'])).split('\n')[0]).toMatchInlineSnapshot(
+    `"Usage: program bar [options] <files...>"`,
+  )
+  expect((await output(cli, ['baz', '--help'])).split('\n')[0]).toMatchInlineSnapshot(
+    `"Usage: program baz [options] <file collection...>"`,
+  )
+})
+
 const run = async (cli: TrpcCli, argv: string[]) => {
   const exit = vi.fn() as any
   const log = vi.fn()