mirror of
https://github.com/deepseek-ai/deepseek-harness.git
synced 2026-10-26 16:55:08 +00:00
Tianyi Cui
231d5a311e
`collectCliHelp` stops propagating an alias when it reaches a page already on the current path, so a `help [command]` row that prints its parent's help no longer recurses until the stack overflows. `serve|s` command rows are split into separately collected names. The CLI reference and upgrade guide describe the forwarded-argument boundary that Commander applies, including a leading pnpm option, and args.spec.ts pins that `--profile` placed after a leading pnpm option is forwarded. Generated pages use the repository's two-line generated header, and docs/AGENTS.md lists the CLI help among the generated references. Refs #4114
52 lines
2.7 KiB
TypeScript
52 lines
2.7 KiB
TypeScript
/** Command discovery and complete output preservation for the CLI reference. */
|
|
|
|
import { describe, expect, it } from 'vitest'
|
|
import { collectCliHelp, parseCliHelp } from './gen-cli-help.ts'
|
|
|
|
describe('CLI help discovery', () => {
|
|
it('reads command rows while retaining wrapped descriptions and examples', () => {
|
|
const help = 'Usage: dsh\r\n\r\nCommands:\r\n web [options] Serve the browser\r\n with a wrapped description\r\n plugin Manage plugins\r\n\r\nExamples:\r\n dsh web\r\n'
|
|
const result = parseCliHelp(help)
|
|
expect(result.commands).toEqual(['web', 'plugin'])
|
|
expect(result.output).toBe(help.replaceAll('\r\n', '\n'))
|
|
})
|
|
|
|
it('includes plugin, both profile forms, and their nested commands when launcher help has no command list', async () => {
|
|
const visited: string[] = []
|
|
const pages = await collectCliHelp(async (args) => {
|
|
visited.push(args.join(' '))
|
|
if (args.length === 0) return 'Usage: dsh [--profile] <name>\n'
|
|
if (args[0] === 'plugin') return 'Usage: dsh plugin --profile <name> <args...>\n'
|
|
const selected = args[0] === '--profile' ? args.slice(1) : args
|
|
if (selected[1] === 'nested') return 'Usage: nested\n'
|
|
return `Usage: ${selected[0]} [command]\n\nCommands:\n nested Run the nested command\n`
|
|
}, ['web'])
|
|
expect(visited).toEqual(['', 'plugin', 'web', 'web nested', '--profile web'])
|
|
expect(pages.map(page => page.invocations)).toEqual([
|
|
['dsh'], ['dsh plugin'], ['dsh web', 'dsh --profile web'],
|
|
['dsh web nested', 'dsh --profile web nested'],
|
|
])
|
|
})
|
|
|
|
it('visits each command alias and lists a help command that repeats its parent once', async () => {
|
|
const visited: string[] = []
|
|
const parent = 'Usage: web [command]\n\nCommands:\n serve|s [options] Serve the UI\n help [command] display help for command\n'
|
|
const pages = await collectCliHelp(async (args) => {
|
|
visited.push(args.join(' '))
|
|
if (args.length === 0) return 'Usage: dsh\n'
|
|
if (args[0] === 'plugin') return 'Usage: dsh plugin\n'
|
|
const selected = args[0] === '--profile' ? args.slice(1) : args
|
|
return selected[1] === 'serve' || selected[1] === 's' ? 'Usage: web serve\n' : parent
|
|
}, ['web'])
|
|
expect(visited).toEqual(['', 'plugin', 'web', 'web serve', 'web s', 'web help', '--profile web'])
|
|
expect(pages.map(page => page.invocations)).toEqual([
|
|
['dsh'], ['dsh plugin'], ['dsh web', 'dsh web help', 'dsh --profile web', 'dsh --profile web help'],
|
|
['dsh web serve', 'dsh web s', 'dsh --profile web serve', 'dsh --profile web s'],
|
|
])
|
|
})
|
|
|
|
it.each(['', ' \r\n\n'])('rejects blank help %j', (help) => {
|
|
expect(() => parseCliHelp(help)).toThrow('CLI help returned empty output')
|
|
})
|
|
})
|