Commander Document Generator

This generates document for tj/commander.js. It helps you to write sections of command guide on README.md.

Installation

$ yarn add commander-document-generator

Write template

You must write a template for a command with janl/mustache.js.

You can use a variable 'command' in template. The following is property list of 'command'.

Command

• name: string
• args: Argument[]
• options: Option[]
• description: string

Argument

• name: string
• display: boolean
• required: boolean
• variadic: boolean

Option

• flags: string
• required: boolean
• optional: boolean
• bool: boolean
• short?: string
• long: string
• description: string

Example

1import {Command as Commander} from "commander"
2import CommandDocument from "commander-document-genertor"
3
4const program = new Commander()
5
6program
7  .command('hello <message>')
8  .description('just hello')
9  .option("-t, --to <name>", "target user")
10  .option("-s, --silent", "not say")
11
12const template = `
13{{#commands}}
14### {{name}} {{{args.0.display}}}
15
16{{description}}
17
18{{#options}}
19#### {{{flags}}}
20
21{{description}}
22{{/options}}
23{{/commands}}
24`
25
26const doc = CommandDocument.parse(program)
27console.log(doc.render(template))

output

### hello <message>

just hello

#### -t, --to <name>

target user

#### -s, --silent

not say