CommandLineDefinition.ts

// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.

/**
 * For use with CommandLineParser, this interface represents a generic command-line parameter
 */
export interface IBaseCommandLineDefinition {
  /**
   * The long name of the flag including double dashes, e.g. "--do-something"
   */
  parameterLongName: string;

  /**
   * An optional short name for the flag including the dash, e.g. "-d"
   */
  parameterShortName?: string;

  /**
   * Documentation for the flag, that will be shown when invoking the tool with "--help"
   */
  description: string;
}

export interface IKeyedCommandLineDefinition extends IBaseCommandLineDefinition {
  /**
   * The key used to identify the value of this parameter. This must be a unique value. If it is
   * omitted, a unique key is created. This key name appears in the help menu.
   * For certain definitions, the key value is not surfaced in the UI.
   */
  key?: string;
}

/**
 * For use with CommandLineParser, this interface represents a boolean flag command line parameter
 */
export interface ICommandLineFlagDefinition extends IBaseCommandLineDefinition { }

/**
 * For use with CommandLineParser, this interface represents a string command line parameter
 */
export interface ICommandLineStringDefinition extends IKeyedCommandLineDefinition { }

/**
 * For use with CommandLineParser, this interface represents a string command line parameter
 */
export interface ICommandLineStringListDefinition extends IKeyedCommandLineDefinition { }

/**
 * For use with CommandLineParser, this interface represents a parameter which is constrained to
 * a list of possible options
 */
export interface ICommandLineOptionDefinition extends IBaseCommandLineDefinition {
  /**
   * A list of strings (which contain no spaces), of possible options which can be selected
   */
  options: string[];

  /**
   * The default value which will be used if the parameter is omitted from the command line
   */
  defaultValue?: string;
}

/**
 * For use with CommandLineParser, this interface represents an integer command line parameter
 */
export interface ICommandLineIntegerDefinition extends IKeyedCommandLineDefinition { }