commanderdoc - v0.1.11 › Globals
commanderdoc [options] [command]
commanderdoc markdown [options] <sourcefile>
- -e --exported <
commanderObject
> Name of the exported commander object to inspect (default:commander
) - -o --out-file <
outfile
> File to store markdown output (defaults to stdout) - -n --cli-name <
name
> Name of the executable
Extract inspected commander as JSON
commanderdoc json [options] <sourcefile>
- -e --exported <
commanderObject
> Name of the exported commander object to inspect (default:commander
) - -o --out-file <
outfile
> File to store markdown output (defaults to stdout)
commanderdoc - v0.1.11 › Globals
Ƭ CommandType: object
Defined in index.ts:42
-
args? : object[]
-
commands? : CommandType[]
-
description? : undefined | string
-
name: string
-
options? : OptionType[]
Ƭ OptionType: ReturnType‹typeof getOption›
Defined in index.ts:41
▸ commandToMd(command
: CommandType, startLevel
: number, parents
: string[]): string
Defined in index.ts:104
Convert an inspected command to a markdown string
Parameters:
Name | Type | Default | Description |
---|---|---|---|
command |
CommandType | - | inspected command to inspect (result of getCommand(command)) |
startLevel |
number | 1 | header level to start with |
parents |
string[] | [] | list of parent commands and cli name to document usage |
Returns: string
▸ commanderToMd(commander
: object, cliName
: string, startLevel
: number): string
Defined in index.ts:173
Document a top-level cli - recommended use case
Parameters:
Name | Type | Default | Description |
---|---|---|---|
commander |
object | - | Top level commander object (usually from export commander or module.exports.commander = commander ) |
cliName |
string | - | Name of the executable (for usage documentation) |
startLevel |
number | 1 | Level to start the markdown headers (e.g. use 2 or greater to fit it into sub-documentation) |
Returns: string
▸ getCommand(command
: object): CommandType
Defined in index.ts:60
Generate a map of properties of a command object
Parameters:
Name | Type | Description |
---|---|---|
command |
object | Commander command object to inspect |
Returns: CommandType
▸ getCommands(commands
: object[]): CommandType[]
Defined in index.ts:53
Recursively inspect a list of commands
Parameters:
Name | Type | Description |
---|---|---|
commands |
object[] | List of commands to inspect (usually from command.commands ) |
Returns: CommandType[]
▸ getOption(option
: object): object
Defined in index.ts:13
Get filtered list of attributes for a single options
Parameters:
Name | Type | Description |
---|---|---|
option |
object | Option for a commands |
Returns: object
-
args: any
-
defaultValue: any
-
description: any
-
flags: any
-
long: any
-
mandatory: any
-
negate: any
-
optional: any
-
required: any
-
short: any
-
variadic: any
▸ getOptions(options
: any[]): object[]
Defined in index.ts:7
Get filtered map of attributes for a list of options
Parameters:
Name | Type | Description |
---|---|---|
options |
any[] | Options for a command |
Returns: object[]
▸ optionToMd(option
: OptionType): string
Defined in index.ts:87
Generate markdown for a single commander option
Parameters:
Name | Type | Description |
---|---|---|
option |
OptionType | Option to generate markdown for |
Returns: string
▸ padLevel(level
: number): string
Defined in index.ts:81
Generate a markdown header prefix at the indicated level
internal
Parameters:
Name | Type | Description |
---|---|---|
level |
number | level of the markdown header padding |
Returns: string