Options
All
  • Public
  • Public/Protected
  • All
Menu

DocOpts generator for SfdxCommands. See http://docopt.org/.

flag.exclusive: groups elements when one of the mutually exclusive cases is a required flag: (--apple | --orange) flag.exclusive: groups elements when none of the mutually exclusive cases is required (optional flags): [--apple | --orange] flag.dependsOn: specifies that if one element is present, then another one is required: (--apple --orange) cmd.variableArgs: produces 'name=value'

example

{ name: 'classnames', required: true, exclusive: ['suitenames'] ... },{ name: 'suitenames', type: 'array' required: true ... }

Results in: Usage: <%= command.id %> (-n | -s )

example

{ name: 'classnames', ... excludes: ['suitenames'] },{ name: 'suitenames', ... }

Results in: Usage: <%= command.id %> [-n | -s ]

example

{ name: 'classnames', ... dependsOn: ['suitenames'] },{ name: 'suitenames', type: 'flag' ... }

Results in: Usage: <%= command.id %> (-n -s)

TODO:

  • Support nesting, eg: Usage: my_program (--either-this | ) Usage: my_program [( )]
param

Type parameters

  • T: typeof SfdxCommand

Hierarchy

  • DocOpts

Index

Constructors

Methods

Constructors

constructor

Methods

toString

  • toString(): string

Static generate

  • generate<T>(cmdDef: T): string
  • Type parameters

    • T: typeof SfdxCommand

    Parameters

    • cmdDef: T

    Returns string