Class Options

constructor

• new Options(): Options

  Returns Options

Internal_definitions

argv

failureLevel

options

positionals

stdin

values

_buildConvertOptions

• _buildConvertOptions(
      extraAttrs?: any[],
  ): {
      failureLevel: any;
      options: {
          attributes: any[];
          mkdirs: boolean;
          safe: unknown;
          standalone: boolean;
          timings: unknown;
          trace: unknown;
          verbose: number;
      };
  }
  Internal

  Parameters

  • OptionalextraAttrs: any[]

  Returns {
      failureLevel: any;
      options: {
          attributes: any[];
          mkdirs: boolean;
          safe: unknown;
          standalone: boolean;
          timings: unknown;
          trace: unknown;
          verbose: number;
      };
  }

addOption

• addOption(key: string, opt: OptionDefinition): this

  Register a custom CLI option. Call this in your subclass constructor before invoking Options#parse.

  Parameters

  • key: string

    the long option name (without --)

  • opt: OptionDefinition

    the option definition

  Returns this

buildHelpText

• buildHelpText(): string

  Build the help text from all registered option definitions.

  Returns string

getHelpDescription

• getHelpDescription(): string

  Return the description printed below the usage line in --help.

  Returns string

getHelpPreamble

• getHelpPreamble(): string

  Return the usage line, description, and "Options:" header printed above the options list in --help. Assembled from Options#getUsageLine and Options#getHelpDescription; override those instead where possible. Override this method directly only as a last resort, e.g. to drop the "Options:" header or restructure the preamble entirely.

  Returns string

getProgramName

• getProgramName(): string

  Return the program name shown in the --help usage line. Override this for the common case of wrapping this CLI under a different command name.

  Returns string

getUsageLine

• getUsageLine(): string

  Return the usage line printed at the top of --help (e.g., asciidoctor [options...] files...). Override to change the argument summary; override Options#getProgramName to only change the name.

  Returns string

parse

• parse(argv: string[]): this

  Parse the command-line arguments. Populates Options#values, Options#positionals, Options#stdin, Options#options, and Options#failureLevel.

  Parameters

  • argv: string[]

    the process arguments (typically process.argv)

  Returns this