@rushstack/ts-command-line 4.9.1

package/lib/parameters/CommandLineChoiceParameter.d.ts

@@ -0,0 +1,40 @@
+import { ICommandLineChoiceDefinition } from './CommandLineDefinition';
+import { CommandLineParameter, CommandLineParameterKind } from './BaseClasses';
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineChoiceParameter}.
+ * @public
+ */
+export declare class CommandLineChoiceParameter extends CommandLineParameter {
+    /** {@inheritDoc ICommandLineChoiceDefinition.alternatives} */
+    readonly alternatives: ReadonlyArray<string>;
+    /** {@inheritDoc ICommandLineStringDefinition.defaultValue} */
+    readonly defaultValue: string | undefined;
+    private _value;
+    /** {@inheritDoc ICommandLineChoiceDefinition.completions} */
+    readonly completions: (() => Promise<string[]>) | undefined;
+    /** @internal */
+    constructor(definition: ICommandLineChoiceDefinition);
+    /** {@inheritDoc CommandLineParameter.kind} */
+    get kind(): CommandLineParameterKind;
+    /**
+     * {@inheritDoc CommandLineParameter._setValue}
+     * @internal
+     */
+    _setValue(data: any): void;
+    /**
+     * {@inheritDoc CommandLineParameter._getSupplementaryNotes}
+     * @internal
+     */
+    _getSupplementaryNotes(supplementaryNotes: string[]): void;
+    /**
+     * Returns the argument value for a choice parameter that was parsed from the command line.
+     *
+     * @remarks
+     * The return value will be `undefined` if the command-line has not been parsed yet,
+     * or if the parameter was omitted and has no default value.
+     */
+    get value(): string | undefined;
+    /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
+    appendToArgList(argList: string[]): void;
+}
+//# sourceMappingURL=CommandLineChoiceParameter.d.ts.map

package/lib/parameters/CommandLineChoiceParameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineChoiceParameter.d.ts","sourceRoot":"","sources":["../../src/parameters/CommandLineChoiceParameter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAE/E;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,oBAAoB;IAClE,8DAA8D;IAC9D,SAAgB,YAAY,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAEpD,8DAA8D;IAC9D,SAAgB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjD,OAAO,CAAC,MAAM,CAAiC;IAE/C,6DAA6D;IAC7D,SAAgB,WAAW,EAAE,CAAC,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;IAEnE,gBAAgB;gBACG,UAAU,EAAE,4BAA4B;IAqB3D,8CAA8C;IAC9C,IAAW,IAAI,IAAI,wBAAwB,CAE1C;IAED;;;OAGG;IAEI,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAkCjC;;;OAGG;IACI,sBAAsB,CAAC,kBAAkB,EAAE,MAAM,EAAE,GAAG,IAAI;IAQjE;;;;;;OAMG;IACH,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED,mEAAmE;IAC5D,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;CAMhD"}

package/lib/parameters/CommandLineChoiceParameter.js

@@ -0,0 +1,95 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineChoiceParameter = void 0;
+const BaseClasses_1 = require("./BaseClasses");
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineChoiceParameter}.
+ * @public
+ */
+class CommandLineChoiceParameter extends BaseClasses_1.CommandLineParameter {
+    /** @internal */
+    constructor(definition) {
+        super(definition);
+        this._value = undefined;
+        if (definition.alternatives.length < 1) {
+            throw new Error(`When defining a choice parameter, the alternatives list must contain at least one value.`);
+        }
+        if (definition.defaultValue && definition.alternatives.indexOf(definition.defaultValue) === -1) {
+            throw new Error(`The specified default value "${definition.defaultValue}"` +
+                ` is not one of the available options: ${definition.alternatives.toString()}`);
+        }
+        this.alternatives = definition.alternatives;
+        this.defaultValue = definition.defaultValue;
+        this.validateDefaultValue(!!this.defaultValue);
+        this.completions = definition.completions;
+    }
+    /** {@inheritDoc CommandLineParameter.kind} */
+    get kind() {
+        return BaseClasses_1.CommandLineParameterKind.Choice;
+    }
+    /**
+     * {@inheritDoc CommandLineParameter._setValue}
+     * @internal
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    _setValue(data) {
+        // abstract
+        if (data !== null && data !== undefined) {
+            if (typeof data !== 'string') {
+                this.reportInvalidData(data);
+            }
+            this._value = data;
+            return;
+        }
+        if (this.environmentVariable !== undefined) {
+            // Try reading the environment variable
+            const environmentValue = process.env[this.environmentVariable];
+            if (environmentValue !== undefined && environmentValue !== '') {
+                if (this.alternatives.indexOf(environmentValue) < 0) {
+                    const choices = '"' + this.alternatives.join('", "') + '"';
+                    throw new Error(`Invalid value "${environmentValue}" for the environment variable` +
+                        ` ${this.environmentVariable}.  Valid choices are: ${choices}`);
+                }
+                this._value = environmentValue;
+                return;
+            }
+        }
+        if (this.defaultValue !== undefined) {
+            this._value = this.defaultValue;
+            return;
+        }
+        this._value = undefined;
+    }
+    /**
+     * {@inheritDoc CommandLineParameter._getSupplementaryNotes}
+     * @internal
+     */
+    _getSupplementaryNotes(supplementaryNotes) {
+        // virtual
+        super._getSupplementaryNotes(supplementaryNotes);
+        if (this.defaultValue !== undefined) {
+            supplementaryNotes.push(`The default value is "${this.defaultValue}".`);
+        }
+    }
+    /**
+     * Returns the argument value for a choice parameter that was parsed from the command line.
+     *
+     * @remarks
+     * The return value will be `undefined` if the command-line has not been parsed yet,
+     * or if the parameter was omitted and has no default value.
+     */
+    get value() {
+        return this._value;
+    }
+    /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
+    appendToArgList(argList) {
+        if (this.value !== undefined) {
+            argList.push(this.longName);
+            argList.push(this.value);
+        }
+    }
+}
+exports.CommandLineChoiceParameter = CommandLineChoiceParameter;
+//# sourceMappingURL=CommandLineChoiceParameter.js.map

package/lib/parameters/CommandLineChoiceParameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineChoiceParameter.js","sourceRoot":"","sources":["../../src/parameters/CommandLineChoiceParameter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,+CAA+E;AAE/E;;;GAGG;AACH,MAAa,0BAA2B,SAAQ,kCAAoB;IAYlE,gBAAgB;IAChB,YAAmB,UAAwC;QACzD,KAAK,CAAC,UAAU,CAAC,CAAC;QAPZ,WAAM,GAAuB,SAAS,CAAC;QAS7C,IAAI,UAAU,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CACb,0FAA0F,CAC3F,CAAC;SACH;QACD,IAAI,UAAU,CAAC,YAAY,IAAI,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE;YAC9F,MAAM,IAAI,KAAK,CACb,gCAAgC,UAAU,CAAC,YAAY,GAAG;gBACxD,yCAAyC,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,CAChF,CAAC;SACH;QAED,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IAC5C,CAAC;IAED,8CAA8C;IAC9C,IAAW,IAAI;QACb,OAAO,sCAAwB,CAAC,MAAM,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,8DAA8D;IACvD,SAAS,CAAC,IAAS;QACxB,WAAW;QACX,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE;YACvC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC5B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;aAC9B;YACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,OAAO;SACR;QAED,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE;YAC1C,uCAAuC;YACvC,MAAM,gBAAgB,GAAuB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnF,IAAI,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,KAAK,EAAE,EAAE;gBAC7D,IAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE;oBACnD,MAAM,OAAO,GAAW,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;oBACnE,MAAM,IAAI,KAAK,CACb,kBAAkB,gBAAgB,gCAAgC;wBAChE,IAAI,IAAI,CAAC,mBAAmB,yBAAyB,OAAO,EAAE,CACjE,CAAC;iBACH;gBACD,IAAI,CAAC,MAAM,GAAG,gBAAgB,CAAC;gBAC/B,OAAO;aACR;SACF;QAED,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACnC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;YAChC,OAAO;SACR;QAED,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,sBAAsB,CAAC,kBAA4B;QACxD,UAAU;QACV,KAAK,CAAC,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE;YACnC,kBAAkB,CAAC,IAAI,CAAC,yBAAyB,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;SACzE;IACH,CAAC;IAED;;;;;;OAMG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,mEAAmE;IAC5D,eAAe,CAAC,OAAiB;QACtC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;YAC5B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SAC1B;IACH,CAAC;CACF;AA5GD,gEA4GC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { ICommandLineChoiceDefinition } from './CommandLineDefinition';\r\nimport { CommandLineParameter, CommandLineParameterKind } from './BaseClasses';\r\n\r\n/**\r\n * The data type returned by {@link CommandLineParameterProvider.defineChoiceParameter}.\r\n * @public\r\n */\r\nexport class CommandLineChoiceParameter extends CommandLineParameter {\r\n  /** {@inheritDoc ICommandLineChoiceDefinition.alternatives} */\r\n  public readonly alternatives: ReadonlyArray<string>;\r\n\r\n  /** {@inheritDoc ICommandLineStringDefinition.defaultValue} */\r\n  public readonly defaultValue: string | undefined;\r\n\r\n  private _value: string | undefined = undefined;\r\n\r\n  /** {@inheritDoc ICommandLineChoiceDefinition.completions} */\r\n  public readonly completions: (() => Promise<string[]>) | undefined;\r\n\r\n  /** @internal */\r\n  public constructor(definition: ICommandLineChoiceDefinition) {\r\n    super(definition);\r\n\r\n    if (definition.alternatives.length < 1) {\r\n      throw new Error(\r\n        `When defining a choice parameter, the alternatives list must contain at least one value.`\r\n      );\r\n    }\r\n    if (definition.defaultValue && definition.alternatives.indexOf(definition.defaultValue) === -1) {\r\n      throw new Error(\r\n        `The specified default value \"${definition.defaultValue}\"` +\r\n          ` is not one of the available options: ${definition.alternatives.toString()}`\r\n      );\r\n    }\r\n\r\n    this.alternatives = definition.alternatives;\r\n    this.defaultValue = definition.defaultValue;\r\n    this.validateDefaultValue(!!this.defaultValue);\r\n    this.completions = definition.completions;\r\n  }\r\n\r\n  /** {@inheritDoc CommandLineParameter.kind} */\r\n  public get kind(): CommandLineParameterKind {\r\n    return CommandLineParameterKind.Choice;\r\n  }\r\n\r\n  /**\r\n   * {@inheritDoc CommandLineParameter._setValue}\r\n   * @internal\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n  public _setValue(data: any): void {\r\n    // abstract\r\n    if (data !== null && data !== undefined) {\r\n      if (typeof data !== 'string') {\r\n        this.reportInvalidData(data);\r\n      }\r\n      this._value = data;\r\n      return;\r\n    }\r\n\r\n    if (this.environmentVariable !== undefined) {\r\n      // Try reading the environment variable\r\n      const environmentValue: string | undefined = process.env[this.environmentVariable];\r\n      if (environmentValue !== undefined && environmentValue !== '') {\r\n        if (this.alternatives.indexOf(environmentValue) < 0) {\r\n          const choices: string = '\"' + this.alternatives.join('\", \"') + '\"';\r\n          throw new Error(\r\n            `Invalid value \"${environmentValue}\" for the environment variable` +\r\n              ` ${this.environmentVariable}.  Valid choices are: ${choices}`\r\n          );\r\n        }\r\n        this._value = environmentValue;\r\n        return;\r\n      }\r\n    }\r\n\r\n    if (this.defaultValue !== undefined) {\r\n      this._value = this.defaultValue;\r\n      return;\r\n    }\r\n\r\n    this._value = undefined;\r\n  }\r\n\r\n  /**\r\n   * {@inheritDoc CommandLineParameter._getSupplementaryNotes}\r\n   * @internal\r\n   */\r\n  public _getSupplementaryNotes(supplementaryNotes: string[]): void {\r\n    // virtual\r\n    super._getSupplementaryNotes(supplementaryNotes);\r\n    if (this.defaultValue !== undefined) {\r\n      supplementaryNotes.push(`The default value is \"${this.defaultValue}\".`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Returns the argument value for a choice parameter that was parsed from the command line.\r\n   *\r\n   * @remarks\r\n   * The return value will be `undefined` if the command-line has not been parsed yet,\r\n   * or if the parameter was omitted and has no default value.\r\n   */\r\n  public get value(): string | undefined {\r\n    return this._value;\r\n  }\r\n\r\n  /** {@inheritDoc CommandLineParameter.appendToArgList} @override */\r\n  public appendToArgList(argList: string[]): void {\r\n    if (this.value !== undefined) {\r\n      argList.push(this.longName);\r\n      argList.push(this.value);\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/parameters/CommandLineDefinition.d.ts

@@ -0,0 +1,207 @@
+/**
+ * For use with CommandLineParser, this interface represents a generic command-line parameter
+ *
+ * @public
+ */
+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 parameter that will be shown when invoking the tool with "--help"
+     */
+    description: string;
+    /**
+     * If true, then an error occurs if the parameter was not included on the command-line.
+     */
+    required?: boolean;
+    /**
+     * The name of an environment variable that the parameter value will be read from,
+     * if it was omitted from the command-line.  An error will be reported if the
+     * environment value cannot be parsed.
+     *
+     * @remarks
+     * The environment variable name must consist only of upper-case letters, numbers,
+     * and underscores. It may not start with a number.
+     *
+     * This feature cannot be used when {@link IBaseCommandLineDefinition.required} is true,
+     * because in that case the environmentVariable would never be used.
+     *
+     * Syntax notes for environment variable values:
+     *
+     * - Choice Parameter: The value must match one of the defined choices,
+     *   otherwise a validation error is reported.
+     *   An empty string causes the environment variable to be ignored.
+     *
+     * - Flag Parameter: The value must be `1` for true, or `0` for false,
+     *   otherwise a validation error is reported.
+     *   An empty string causes the environment variable to be ignored.
+     *
+     * - Integer Parameter: The value must be an integer number,
+     *   otherwise a validation error is reported.
+     *   An empty string causes the environment variable to be ignored.
+     *
+     * - String Parameter: Any value is accepted, including an empty string.
+     *
+     * - String List Parameter: If the string starts with `[` (ignoring whitespace)
+     *   then it will be parsed as a JSON array, whose elements must be strings,
+     *   numbers, or boolean values.
+     *   If the string does not start with `[`, then it behaves like an
+     *   ordinary String Parameter:  Any value is accepted, including an empty string.
+     */
+    environmentVariable?: string;
+    /**
+     * Specifies additional names for this parameter that are accepted but not displayed
+     * in the command line help.
+     *
+     * @remarks
+     * This option can be used in cases where a command-line parameter may have been renamed,
+     * but the developer doesn't want to break backwards compatibility with systems that may
+     * still be using the old name. Only the `parameterLongName` syntax is currently allowed.
+     */
+    undocumentedSynonyms?: string[];
+}
+/**
+ * The common base interface for parameter types that accept an argument.
+ *
+ * @remarks
+ * An argument is an accompanying command-line token, such as "123" in the
+ * example "--max-count 123".
+ * @public
+ */
+export interface IBaseCommandLineDefinitionWithArgument extends IBaseCommandLineDefinition {
+    /**
+     * The name of the argument, which will be shown in the command-line help.
+     *
+     * @remarks
+     * For example, if the parameter name is '--count" and the argument name is "NUMBER",
+     * then the command-line help would display "--count NUMBER".  The argument name must
+     * be comprised of upper-case letters, numbers, and underscores.  It should be kept short.
+     */
+    argumentName: string;
+    /**
+     * An optional callback that provides a list of custom choices for tab completion.
+     * @remarks
+     * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`
+     * is enabled.
+     */
+    completions?: () => Promise<string[]>;
+}
+/**
+ * For use with {@link CommandLineParameterProvider.defineChoiceParameter},
+ * this interface defines a command line parameter which is constrained to a list of possible
+ * options.
+ *
+ * @public
+ */
+export interface ICommandLineChoiceDefinition extends IBaseCommandLineDefinition {
+    /**
+     * A list of strings (which contain no spaces), of possible options which can be selected
+     */
+    alternatives: string[];
+    /**
+     * {@inheritDoc ICommandLineStringDefinition.defaultValue}
+     */
+    defaultValue?: string;
+    /**
+     * An optional callback that provides a list of custom choices for tab completion.
+     * @remarks
+     * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`
+     * is enabled.
+     */
+    completions?: () => Promise<string[]>;
+}
+/**
+ * For use with {@link CommandLineParameterProvider.defineChoiceListParameter},
+ * this interface defines a command line parameter which is constrained to a list of possible
+ * options. The parameter can be specified multiple times to build a list.
+ *
+ * @public
+ */
+export interface ICommandLineChoiceListDefinition extends IBaseCommandLineDefinition {
+    /**
+     * A list of strings (which contain no spaces), of possible options which can be selected
+     */
+    alternatives: string[];
+    /**
+     * An optional callback that provides a list of custom choices for tab completion.
+     * @remarks
+     * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`
+     * is enabled.
+     */
+    completions?: () => Promise<string[]>;
+}
+/**
+ * For use with {@link CommandLineParameterProvider.defineFlagParameter},
+ * this interface defines a command line parameter that is a boolean flag.
+ *
+ * @public
+ */
+export interface ICommandLineFlagDefinition extends IBaseCommandLineDefinition {
+}
+/**
+ * For use with {@link CommandLineParameterProvider.defineIntegerParameter},
+ * this interface defines a command line parameter whose argument is an integer value.
+ *
+ * @public
+ */
+export interface ICommandLineIntegerDefinition extends IBaseCommandLineDefinitionWithArgument {
+    /**
+     * {@inheritDoc ICommandLineStringDefinition.defaultValue}
+     */
+    defaultValue?: number;
+}
+/**
+ * For use with {@link CommandLineParameterProvider.defineIntegerListParameter},
+ * this interface defines a command line parameter whose argument is an integer value. The
+ * parameter can be specified multiple times to build a list.
+ *
+ * @public
+ */
+export interface ICommandLineIntegerListDefinition extends IBaseCommandLineDefinitionWithArgument {
+}
+/**
+ * For use with {@link CommandLineParameterProvider.defineStringParameter},
+ * this interface defines a command line parameter whose argument is a string value.
+ *
+ * @public
+ */
+export interface ICommandLineStringDefinition extends IBaseCommandLineDefinitionWithArgument {
+    /**
+     * The default value which will be used if the parameter is omitted from the command line.
+     *
+     * @remarks
+     * If a default value is specified, then {@link IBaseCommandLineDefinition.required}
+     * must not be true.  Instead, a custom error message should be used to report cases
+     * where a default value was not available.
+     */
+    defaultValue?: string;
+}
+/**
+ * For use with {@link CommandLineParameterProvider.defineStringListParameter},
+ * this interface defines a command line parameter whose argument is a single text string.
+ * The parameter can be specified multiple times to build a list.
+ *
+ * @public
+ */
+export interface ICommandLineStringListDefinition extends IBaseCommandLineDefinitionWithArgument {
+}
+/**
+ * For use with {@link CommandLineParameterProvider.defineCommandLineRemainder},
+ * this interface defines a rule that captures any remaining command line arguments after the recognized portion.
+ *
+ * @public
+ */
+export interface ICommandLineRemainderDefinition {
+    /**
+     * Documentation for how the remaining arguments will be used.  This will be shown when invoking
+     * the tool with "--help".
+     */
+    description: string;
+}
+//# sourceMappingURL=CommandLineDefinition.d.ts.map

package/lib/parameters/CommandLineDefinition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineDefinition.d.ts","sourceRoot":"","sources":["../../src/parameters/CommandLineDefinition.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;;;;;OAQG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;CACjC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sCAAuC,SAAQ,0BAA0B;IACxF;;;;;;;OAOG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACvC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,4BAA6B,SAAQ,0BAA0B;IAC9E;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACvC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gCAAiC,SAAQ,0BAA0B;IAClF;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA2B,SAAQ,0BAA0B;CAAG;AAEjF;;;;;GAKG;AACH,MAAM,WAAW,6BAA8B,SAAQ,sCAAsC;IAC3F;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAkC,SAAQ,sCAAsC;CAAG;AAEpG;;;;;GAKG;AACH,MAAM,WAAW,4BAA6B,SAAQ,sCAAsC;IAC1F;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gCAAiC,SAAQ,sCAAsC;CAAG;AAEnG;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/lib/parameters/CommandLineDefinition.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=CommandLineDefinition.js.map

package/lib/parameters/CommandLineDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineDefinition.js","sourceRoot":"","sources":["../../src/parameters/CommandLineDefinition.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\n/**\r\n * For use with CommandLineParser, this interface represents a generic command-line parameter\r\n *\r\n * @public\r\n */\r\nexport interface IBaseCommandLineDefinition {\r\n  /**\r\n   * The long name of the flag including double dashes, e.g. \"--do-something\"\r\n   */\r\n  parameterLongName: string;\r\n\r\n  /**\r\n   * An optional short name for the flag including the dash, e.g. \"-d\"\r\n   */\r\n  parameterShortName?: string;\r\n\r\n  /**\r\n   * Documentation for the parameter that will be shown when invoking the tool with \"--help\"\r\n   */\r\n  description: string;\r\n\r\n  /**\r\n   * If true, then an error occurs if the parameter was not included on the command-line.\r\n   */\r\n  required?: boolean;\r\n\r\n  /**\r\n   * The name of an environment variable that the parameter value will be read from,\r\n   * if it was omitted from the command-line.  An error will be reported if the\r\n   * environment value cannot be parsed.\r\n   *\r\n   * @remarks\r\n   * The environment variable name must consist only of upper-case letters, numbers,\r\n   * and underscores. It may not start with a number.\r\n   *\r\n   * This feature cannot be used when {@link IBaseCommandLineDefinition.required} is true,\r\n   * because in that case the environmentVariable would never be used.\r\n   *\r\n   * Syntax notes for environment variable values:\r\n   *\r\n   * - Choice Parameter: The value must match one of the defined choices,\r\n   *   otherwise a validation error is reported.\r\n   *   An empty string causes the environment variable to be ignored.\r\n   *\r\n   * - Flag Parameter: The value must be `1` for true, or `0` for false,\r\n   *   otherwise a validation error is reported.\r\n   *   An empty string causes the environment variable to be ignored.\r\n   *\r\n   * - Integer Parameter: The value must be an integer number,\r\n   *   otherwise a validation error is reported.\r\n   *   An empty string causes the environment variable to be ignored.\r\n   *\r\n   * - String Parameter: Any value is accepted, including an empty string.\r\n   *\r\n   * - String List Parameter: If the string starts with `[` (ignoring whitespace)\r\n   *   then it will be parsed as a JSON array, whose elements must be strings,\r\n   *   numbers, or boolean values.\r\n   *   If the string does not start with `[`, then it behaves like an\r\n   *   ordinary String Parameter:  Any value is accepted, including an empty string.\r\n   */\r\n  environmentVariable?: string;\r\n\r\n  /**\r\n   * Specifies additional names for this parameter that are accepted but not displayed\r\n   * in the command line help.\r\n   *\r\n   * @remarks\r\n   * This option can be used in cases where a command-line parameter may have been renamed,\r\n   * but the developer doesn't want to break backwards compatibility with systems that may\r\n   * still be using the old name. Only the `parameterLongName` syntax is currently allowed.\r\n   */\r\n  undocumentedSynonyms?: string[];\r\n}\r\n\r\n/**\r\n * The common base interface for parameter types that accept an argument.\r\n *\r\n * @remarks\r\n * An argument is an accompanying command-line token, such as \"123\" in the\r\n * example \"--max-count 123\".\r\n * @public\r\n */\r\nexport interface IBaseCommandLineDefinitionWithArgument extends IBaseCommandLineDefinition {\r\n  /**\r\n   * The name of the argument, which will be shown in the command-line help.\r\n   *\r\n   * @remarks\r\n   * For example, if the parameter name is '--count\" and the argument name is \"NUMBER\",\r\n   * then the command-line help would display \"--count NUMBER\".  The argument name must\r\n   * be comprised of upper-case letters, numbers, and underscores.  It should be kept short.\r\n   */\r\n  argumentName: string;\r\n\r\n  /**\r\n   * An optional callback that provides a list of custom choices for tab completion.\r\n   * @remarks\r\n   * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`\r\n   * is enabled.\r\n   */\r\n  completions?: () => Promise<string[]>;\r\n}\r\n\r\n/**\r\n * For use with {@link CommandLineParameterProvider.defineChoiceParameter},\r\n * this interface defines a command line parameter which is constrained to a list of possible\r\n * options.\r\n *\r\n * @public\r\n */\r\nexport interface ICommandLineChoiceDefinition extends IBaseCommandLineDefinition {\r\n  /**\r\n   * A list of strings (which contain no spaces), of possible options which can be selected\r\n   */\r\n  alternatives: string[];\r\n\r\n  /**\r\n   * {@inheritDoc ICommandLineStringDefinition.defaultValue}\r\n   */\r\n  defaultValue?: string;\r\n\r\n  /**\r\n   * An optional callback that provides a list of custom choices for tab completion.\r\n   * @remarks\r\n   * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`\r\n   * is enabled.\r\n   */\r\n  completions?: () => Promise<string[]>;\r\n}\r\n\r\n/**\r\n * For use with {@link CommandLineParameterProvider.defineChoiceListParameter},\r\n * this interface defines a command line parameter which is constrained to a list of possible\r\n * options. The parameter can be specified multiple times to build a list.\r\n *\r\n * @public\r\n */\r\nexport interface ICommandLineChoiceListDefinition extends IBaseCommandLineDefinition {\r\n  /**\r\n   * A list of strings (which contain no spaces), of possible options which can be selected\r\n   */\r\n  alternatives: string[];\r\n\r\n  /**\r\n   * An optional callback that provides a list of custom choices for tab completion.\r\n   * @remarks\r\n   * This option is only used when `ICommandLineParserOptions.enableTabCompletionAction`\r\n   * is enabled.\r\n   */\r\n  completions?: () => Promise<string[]>;\r\n}\r\n\r\n/**\r\n * For use with {@link CommandLineParameterProvider.defineFlagParameter},\r\n * this interface defines a command line parameter that is a boolean flag.\r\n *\r\n * @public\r\n */\r\nexport interface ICommandLineFlagDefinition extends IBaseCommandLineDefinition {}\r\n\r\n/**\r\n * For use with {@link CommandLineParameterProvider.defineIntegerParameter},\r\n * this interface defines a command line parameter whose argument is an integer value.\r\n *\r\n * @public\r\n */\r\nexport interface ICommandLineIntegerDefinition extends IBaseCommandLineDefinitionWithArgument {\r\n  /**\r\n   * {@inheritDoc ICommandLineStringDefinition.defaultValue}\r\n   */\r\n  defaultValue?: number;\r\n}\r\n\r\n/**\r\n * For use with {@link CommandLineParameterProvider.defineIntegerListParameter},\r\n * this interface defines a command line parameter whose argument is an integer value. The\r\n * parameter can be specified multiple times to build a list.\r\n *\r\n * @public\r\n */\r\nexport interface ICommandLineIntegerListDefinition extends IBaseCommandLineDefinitionWithArgument {}\r\n\r\n/**\r\n * For use with {@link CommandLineParameterProvider.defineStringParameter},\r\n * this interface defines a command line parameter whose argument is a string value.\r\n *\r\n * @public\r\n */\r\nexport interface ICommandLineStringDefinition extends IBaseCommandLineDefinitionWithArgument {\r\n  /**\r\n   * The default value which will be used if the parameter is omitted from the command line.\r\n   *\r\n   * @remarks\r\n   * If a default value is specified, then {@link IBaseCommandLineDefinition.required}\r\n   * must not be true.  Instead, a custom error message should be used to report cases\r\n   * where a default value was not available.\r\n   */\r\n  defaultValue?: string;\r\n}\r\n\r\n/**\r\n * For use with {@link CommandLineParameterProvider.defineStringListParameter},\r\n * this interface defines a command line parameter whose argument is a single text string.\r\n * The parameter can be specified multiple times to build a list.\r\n *\r\n * @public\r\n */\r\nexport interface ICommandLineStringListDefinition extends IBaseCommandLineDefinitionWithArgument {}\r\n\r\n/**\r\n * For use with {@link CommandLineParameterProvider.defineCommandLineRemainder},\r\n * this interface defines a rule that captures any remaining command line arguments after the recognized portion.\r\n *\r\n * @public\r\n */\r\nexport interface ICommandLineRemainderDefinition {\r\n  /**\r\n   * Documentation for how the remaining arguments will be used.  This will be shown when invoking\r\n   * the tool with \"--help\".\r\n   */\r\n  description: string;\r\n}\r\n"]}

package/lib/parameters/CommandLineFlagParameter.d.ts

@@ -0,0 +1,29 @@
+import { ICommandLineFlagDefinition } from './CommandLineDefinition';
+import { CommandLineParameter, CommandLineParameterKind } from './BaseClasses';
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineFlagParameter}.
+ * @public
+ */
+export declare class CommandLineFlagParameter extends CommandLineParameter {
+    private _value;
+    /** @internal */
+    constructor(definition: ICommandLineFlagDefinition);
+    /** {@inheritDoc CommandLineParameter.kind} */
+    get kind(): CommandLineParameterKind;
+    /**
+     * {@inheritDoc CommandLineParameter._setValue}
+     * @internal
+     */
+    _setValue(data: any): void;
+    /**
+     * Returns a boolean indicating whether the parameter was included in the command line.
+     *
+     * @remarks
+     * The return value will be false if the command-line has not been parsed yet,
+     * or if the flag was not used.
+     */
+    get value(): boolean;
+    /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
+    appendToArgList(argList: string[]): void;
+}
+//# sourceMappingURL=CommandLineFlagParameter.d.ts.map

package/lib/parameters/CommandLineFlagParameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineFlagParameter.d.ts","sourceRoot":"","sources":["../../src/parameters/CommandLineFlagParameter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAE/E;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,oBAAoB;IAChE,OAAO,CAAC,MAAM,CAAkB;IAEhC,gBAAgB;gBACG,UAAU,EAAE,0BAA0B;IAIzD,8CAA8C;IAC9C,IAAW,IAAI,IAAI,wBAAwB,CAE1C;IAED;;;OAGG;IAEI,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAkCjC;;;;;;OAMG;IACH,IAAW,KAAK,IAAI,OAAO,CAE1B;IAED,mEAAmE;IAC5D,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;CAKhD"}

package/lib/parameters/CommandLineFlagParameter.js

@@ -0,0 +1,72 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineFlagParameter = void 0;
+const BaseClasses_1 = require("./BaseClasses");
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineFlagParameter}.
+ * @public
+ */
+class CommandLineFlagParameter extends BaseClasses_1.CommandLineParameter {
+    /** @internal */
+    constructor(definition) {
+        super(definition);
+        this._value = false;
+    }
+    /** {@inheritDoc CommandLineParameter.kind} */
+    get kind() {
+        return BaseClasses_1.CommandLineParameterKind.Flag;
+    }
+    /**
+     * {@inheritDoc CommandLineParameter._setValue}
+     * @internal
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    _setValue(data) {
+        // abstract
+        if (data !== null && data !== undefined) {
+            if (typeof data !== 'boolean') {
+                this.reportInvalidData(data);
+            }
+            // If the flag is omitted, then argparse sets the data to "false" instead of "undefined".
+            // This design prevents a syntax such as "--flag=false", probably because argparse prefers "--no-flag".
+            // If we switch to a new CLI parser, we should try to add support for "--flag=false".
+            if (data) {
+                this._value = data;
+                return;
+            }
+        }
+        if (this.environmentVariable !== undefined) {
+            // Try reading the environment variable
+            const environmentValue = process.env[this.environmentVariable];
+            if (environmentValue !== undefined && environmentValue !== '') {
+                if (environmentValue !== '0' && environmentValue !== '1') {
+                    throw new Error(`Invalid value "${environmentValue}" for the environment variable` +
+                        ` ${this.environmentVariable}.  Valid choices are 0 or 1.`);
+                }
+                this._value = environmentValue === '1';
+                return;
+            }
+        }
+        this._value = false;
+    }
+    /**
+     * Returns a boolean indicating whether the parameter was included in the command line.
+     *
+     * @remarks
+     * The return value will be false if the command-line has not been parsed yet,
+     * or if the flag was not used.
+     */
+    get value() {
+        return this._value;
+    }
+    /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
+    appendToArgList(argList) {
+        if (this.value) {
+            argList.push(this.longName);
+        }
+    }
+}
+exports.CommandLineFlagParameter = CommandLineFlagParameter;
+//# sourceMappingURL=CommandLineFlagParameter.js.map

package/lib/parameters/CommandLineFlagParameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineFlagParameter.js","sourceRoot":"","sources":["../../src/parameters/CommandLineFlagParameter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,+CAA+E;AAE/E;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,kCAAoB;IAGhE,gBAAgB;IAChB,YAAmB,UAAsC;QACvD,KAAK,CAAC,UAAU,CAAC,CAAC;QAJZ,WAAM,GAAY,KAAK,CAAC;IAKhC,CAAC;IAED,8CAA8C;IAC9C,IAAW,IAAI;QACb,OAAO,sCAAwB,CAAC,IAAI,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,8DAA8D;IACvD,SAAS,CAAC,IAAS;QACxB,WAAW;QACX,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE;YACvC,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE;gBAC7B,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;aAC9B;YAED,yFAAyF;YACzF,uGAAuG;YACvG,qFAAqF;YACrF,IAAI,IAAI,EAAE;gBACR,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;gBACnB,OAAO;aACR;SACF;QAED,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE;YAC1C,uCAAuC;YACvC,MAAM,gBAAgB,GAAuB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnF,IAAI,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,KAAK,EAAE,EAAE;gBAC7D,IAAI,gBAAgB,KAAK,GAAG,IAAI,gBAAgB,KAAK,GAAG,EAAE;oBACxD,MAAM,IAAI,KAAK,CACb,kBAAkB,gBAAgB,gCAAgC;wBAChE,IAAI,IAAI,CAAC,mBAAmB,8BAA8B,CAC7D,CAAC;iBACH;gBACD,IAAI,CAAC,MAAM,GAAG,gBAAgB,KAAK,GAAG,CAAC;gBACvC,OAAO;aACR;SACF;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,mEAAmE;IAC5D,eAAe,CAAC,OAAiB;QACtC,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC7B;IACH,CAAC;CACF;AArED,4DAqEC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { ICommandLineFlagDefinition } from './CommandLineDefinition';\r\nimport { CommandLineParameter, CommandLineParameterKind } from './BaseClasses';\r\n\r\n/**\r\n * The data type returned by {@link CommandLineParameterProvider.defineFlagParameter}.\r\n * @public\r\n */\r\nexport class CommandLineFlagParameter extends CommandLineParameter {\r\n  private _value: boolean = false;\r\n\r\n  /** @internal */\r\n  public constructor(definition: ICommandLineFlagDefinition) {\r\n    super(definition);\r\n  }\r\n\r\n  /** {@inheritDoc CommandLineParameter.kind} */\r\n  public get kind(): CommandLineParameterKind {\r\n    return CommandLineParameterKind.Flag;\r\n  }\r\n\r\n  /**\r\n   * {@inheritDoc CommandLineParameter._setValue}\r\n   * @internal\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n  public _setValue(data: any): void {\r\n    // abstract\r\n    if (data !== null && data !== undefined) {\r\n      if (typeof data !== 'boolean') {\r\n        this.reportInvalidData(data);\r\n      }\r\n\r\n      // If the flag is omitted, then argparse sets the data to \"false\" instead of \"undefined\".\r\n      // This design prevents a syntax such as \"--flag=false\", probably because argparse prefers \"--no-flag\".\r\n      // If we switch to a new CLI parser, we should try to add support for \"--flag=false\".\r\n      if (data) {\r\n        this._value = data;\r\n        return;\r\n      }\r\n    }\r\n\r\n    if (this.environmentVariable !== undefined) {\r\n      // Try reading the environment variable\r\n      const environmentValue: string | undefined = process.env[this.environmentVariable];\r\n      if (environmentValue !== undefined && environmentValue !== '') {\r\n        if (environmentValue !== '0' && environmentValue !== '1') {\r\n          throw new Error(\r\n            `Invalid value \"${environmentValue}\" for the environment variable` +\r\n              ` ${this.environmentVariable}.  Valid choices are 0 or 1.`\r\n          );\r\n        }\r\n        this._value = environmentValue === '1';\r\n        return;\r\n      }\r\n    }\r\n\r\n    this._value = false;\r\n  }\r\n\r\n  /**\r\n   * Returns a boolean indicating whether the parameter was included in the command line.\r\n   *\r\n   * @remarks\r\n   * The return value will be false if the command-line has not been parsed yet,\r\n   * or if the flag was not used.\r\n   */\r\n  public get value(): boolean {\r\n    return this._value;\r\n  }\r\n\r\n  /** {@inheritDoc CommandLineParameter.appendToArgList} @override */\r\n  public appendToArgList(argList: string[]): void {\r\n    if (this.value) {\r\n      argList.push(this.longName);\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/parameters/CommandLineIntegerListParameter.d.ts

@@ -0,0 +1,29 @@
+import { ICommandLineIntegerListDefinition } from './CommandLineDefinition';
+import { CommandLineParameterWithArgument, CommandLineParameterKind } from './BaseClasses';
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineIntegerListParameter}.
+ * @public
+ */
+export declare class CommandLineIntegerListParameter extends CommandLineParameterWithArgument {
+    private _values;
+    /** @internal */
+    constructor(definition: ICommandLineIntegerListDefinition);
+    /** {@inheritDoc CommandLineParameter.kind} */
+    get kind(): CommandLineParameterKind;
+    /**
+     * {@inheritDoc CommandLineParameter._setValue}
+     * @internal
+     */
+    _setValue(data: any): void;
+    /**
+     * Returns the integer arguments for an integer list parameter that was parsed from the command line.
+     *
+     * @remarks
+     * The array will be empty if the command-line has not been parsed yet,
+     * or if the parameter was omitted and has no default value.
+     */
+    get values(): ReadonlyArray<number>;
+    /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
+    appendToArgList(argList: string[]): void;
+}
+//# sourceMappingURL=CommandLineIntegerListParameter.d.ts.map

package/lib/parameters/CommandLineIntegerListParameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineIntegerListParameter.d.ts","sourceRoot":"","sources":["../../src/parameters/CommandLineIntegerListParameter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iCAAiC,EAAE,MAAM,yBAAyB,CAAC;AAC5E,OAAO,EAAE,gCAAgC,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAG3F;;;GAGG;AACH,qBAAa,+BAAgC,SAAQ,gCAAgC;IACnF,OAAO,CAAC,OAAO,CAAgB;IAE/B,gBAAgB;gBACG,UAAU,EAAE,iCAAiC;IAIhE,8CAA8C;IAC9C,IAAW,IAAI,IAAI,wBAAwB,CAE1C;IAED;;;OAGG;IAEI,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAwCjC;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,aAAa,CAAC,MAAM,CAAC,CAEzC;IAED,mEAAmE;IAC5D,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;CAQhD"}

package/lib/parameters/CommandLineIntegerListParameter.js

@@ -0,0 +1,82 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineIntegerListParameter = void 0;
+const BaseClasses_1 = require("./BaseClasses");
+const EnvironmentVariableParser_1 = require("./EnvironmentVariableParser");
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineIntegerListParameter}.
+ * @public
+ */
+class CommandLineIntegerListParameter extends BaseClasses_1.CommandLineParameterWithArgument {
+    /** @internal */
+    constructor(definition) {
+        super(definition);
+        this._values = [];
+    }
+    /** {@inheritDoc CommandLineParameter.kind} */
+    get kind() {
+        return BaseClasses_1.CommandLineParameterKind.IntegerList;
+    }
+    /**
+     * {@inheritDoc CommandLineParameter._setValue}
+     * @internal
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    _setValue(data) {
+        // If argparse passed us a value, confirm it is valid
+        if (data !== null && data !== undefined) {
+            if (!Array.isArray(data)) {
+                this.reportInvalidData(data);
+            }
+            for (const arrayItem of data) {
+                if (typeof arrayItem !== 'number') {
+                    this.reportInvalidData(data);
+                }
+            }
+            this._values = data;
+            return;
+        }
+        // If an environment variable exists, attempt to parse it as a list
+        if (this.environmentVariable !== undefined) {
+            const values = EnvironmentVariableParser_1.EnvironmentVariableParser.parseAsList(this.environmentVariable);
+            if (values) {
+                const parsedValues = [];
+                for (const value of values) {
+                    const parsed = parseInt(value, 10);
+                    if (isNaN(parsed) || value.indexOf('.') >= 0) {
+                        throw new Error(`Invalid value "${value}" for the environment variable` +
+                            ` ${this.environmentVariable}.  It must be an integer value.`);
+                    }
+                    parsedValues.push(parsed);
+                }
+                this._values = parsedValues;
+                return;
+            }
+        }
+        // (No default value for integer lists)
+        this._values = [];
+    }
+    /**
+     * Returns the integer arguments for an integer list parameter that was parsed from the command line.
+     *
+     * @remarks
+     * The array will be empty if the command-line has not been parsed yet,
+     * or if the parameter was omitted and has no default value.
+     */
+    get values() {
+        return this._values;
+    }
+    /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
+    appendToArgList(argList) {
+        if (this.values.length > 0) {
+            for (const value of this.values) {
+                argList.push(this.longName);
+                argList.push(String(value));
+            }
+        }
+    }
+}
+exports.CommandLineIntegerListParameter = CommandLineIntegerListParameter;
+//# sourceMappingURL=CommandLineIntegerListParameter.js.map

package/lib/parameters/CommandLineIntegerListParameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineIntegerListParameter.js","sourceRoot":"","sources":["../../src/parameters/CommandLineIntegerListParameter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,+CAA2F;AAC3F,2EAAwE;AAExE;;;GAGG;AACH,MAAa,+BAAgC,SAAQ,8CAAgC;IAGnF,gBAAgB;IAChB,YAAmB,UAA6C;QAC9D,KAAK,CAAC,UAAU,CAAC,CAAC;QAJZ,YAAO,GAAa,EAAE,CAAC;IAK/B,CAAC;IAED,8CAA8C;IAC9C,IAAW,IAAI;QACb,OAAO,sCAAwB,CAAC,WAAW,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,8DAA8D;IACvD,SAAS,CAAC,IAAS;QACxB,qDAAqD;QACrD,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE;YACvC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBACxB,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;aAC9B;YACD,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE;gBAC5B,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;oBACjC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;iBAC9B;aACF;YACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,OAAO;SACR;QAED,mEAAmE;QACnE,IAAI,IAAI,CAAC,mBAAmB,KAAK,SAAS,EAAE;YAC1C,MAAM,MAAM,GAAyB,qDAAyB,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACrG,IAAI,MAAM,EAAE;gBACV,MAAM,YAAY,GAAa,EAAE,CAAC;gBAClC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;oBAC1B,MAAM,MAAM,GAAW,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBAC3C,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;wBAC5C,MAAM,IAAI,KAAK,CACb,kBAAkB,KAAK,gCAAgC;4BACrD,IAAI,IAAI,CAAC,mBAAmB,iCAAiC,CAChE,CAAC;qBACH;oBACD,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;iBAC3B;gBACD,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC;gBAC5B,OAAO;aACR;SACF;QAED,uCAAuC;QAEvC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,mEAAmE;IAC5D,eAAe,CAAC,OAAiB;QACtC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;gBAC/B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC5B,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;aAC7B;SACF;IACH,CAAC;CACF;AA9ED,0EA8EC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { ICommandLineIntegerListDefinition } from './CommandLineDefinition';\r\nimport { CommandLineParameterWithArgument, CommandLineParameterKind } from './BaseClasses';\r\nimport { EnvironmentVariableParser } from './EnvironmentVariableParser';\r\n\r\n/**\r\n * The data type returned by {@link CommandLineParameterProvider.defineIntegerListParameter}.\r\n * @public\r\n */\r\nexport class CommandLineIntegerListParameter extends CommandLineParameterWithArgument {\r\n  private _values: number[] = [];\r\n\r\n  /** @internal */\r\n  public constructor(definition: ICommandLineIntegerListDefinition) {\r\n    super(definition);\r\n  }\r\n\r\n  /** {@inheritDoc CommandLineParameter.kind} */\r\n  public get kind(): CommandLineParameterKind {\r\n    return CommandLineParameterKind.IntegerList;\r\n  }\r\n\r\n  /**\r\n   * {@inheritDoc CommandLineParameter._setValue}\r\n   * @internal\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n  public _setValue(data: any): void {\r\n    // If argparse passed us a value, confirm it is valid\r\n    if (data !== null && data !== undefined) {\r\n      if (!Array.isArray(data)) {\r\n        this.reportInvalidData(data);\r\n      }\r\n      for (const arrayItem of data) {\r\n        if (typeof arrayItem !== 'number') {\r\n          this.reportInvalidData(data);\r\n        }\r\n      }\r\n      this._values = data;\r\n      return;\r\n    }\r\n\r\n    // If an environment variable exists, attempt to parse it as a list\r\n    if (this.environmentVariable !== undefined) {\r\n      const values: string[] | undefined = EnvironmentVariableParser.parseAsList(this.environmentVariable);\r\n      if (values) {\r\n        const parsedValues: number[] = [];\r\n        for (const value of values) {\r\n          const parsed: number = parseInt(value, 10);\r\n          if (isNaN(parsed) || value.indexOf('.') >= 0) {\r\n            throw new Error(\r\n              `Invalid value \"${value}\" for the environment variable` +\r\n                ` ${this.environmentVariable}.  It must be an integer value.`\r\n            );\r\n          }\r\n          parsedValues.push(parsed);\r\n        }\r\n        this._values = parsedValues;\r\n        return;\r\n      }\r\n    }\r\n\r\n    // (No default value for integer lists)\r\n\r\n    this._values = [];\r\n  }\r\n\r\n  /**\r\n   * Returns the integer arguments for an integer list parameter that was parsed from the command line.\r\n   *\r\n   * @remarks\r\n   * The array will be empty if the command-line has not been parsed yet,\r\n   * or if the parameter was omitted and has no default value.\r\n   */\r\n  public get values(): ReadonlyArray<number> {\r\n    return this._values;\r\n  }\r\n\r\n  /** {@inheritDoc CommandLineParameter.appendToArgList} @override */\r\n  public appendToArgList(argList: string[]): void {\r\n    if (this.values.length > 0) {\r\n      for (const value of this.values) {\r\n        argList.push(this.longName);\r\n        argList.push(String(value));\r\n      }\r\n    }\r\n  }\r\n}\r\n"]}