@rushstack/ts-command-line 4.9.1

package/lib/parameters/CommandLineIntegerParameter.d.ts

@@ -0,0 +1,36 @@
+import { ICommandLineIntegerDefinition } from './CommandLineDefinition';
+import { CommandLineParameterWithArgument, CommandLineParameterKind } from './BaseClasses';
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineIntegerParameter}.
+ * @public
+ */
+export declare class CommandLineIntegerParameter extends CommandLineParameterWithArgument {
+    /** {@inheritDoc ICommandLineStringDefinition.defaultValue} */
+    readonly defaultValue: number | undefined;
+    private _value;
+    /** @internal */
+    constructor(definition: ICommandLineIntegerDefinition);
+    /** {@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 an integer 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(): number | undefined;
+    /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
+    appendToArgList(argList: string[]): void;
+}
+//# sourceMappingURL=CommandLineIntegerParameter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineIntegerParameter.d.ts","sourceRoot":"","sources":["../../src/parameters/CommandLineIntegerParameter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,gCAAgC,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAE3F;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,gCAAgC;IAC/E,8DAA8D;IAC9D,SAAgB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjD,OAAO,CAAC,MAAM,CAAiC;IAE/C,gBAAgB;gBACG,UAAU,EAAE,6BAA6B;IAM5D,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/CommandLineIntegerParameter.js

@@ -0,0 +1,86 @@
+"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.CommandLineIntegerParameter = void 0;
+const BaseClasses_1 = require("./BaseClasses");
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineIntegerParameter}.
+ * @public
+ */
+class CommandLineIntegerParameter extends BaseClasses_1.CommandLineParameterWithArgument {
+    /** @internal */
+    constructor(definition) {
+        super(definition);
+        this._value = undefined;
+        this.defaultValue = definition.defaultValue;
+        this.validateDefaultValue(!!this.defaultValue);
+    }
+    /** {@inheritDoc CommandLineParameter.kind} */
+    get kind() {
+        return BaseClasses_1.CommandLineParameterKind.Integer;
+    }
+    /**
+     * {@inheritDoc CommandLineParameter._setValue}
+     * @internal
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    _setValue(data) {
+        // abstract
+        if (data !== null && data !== undefined) {
+            if (typeof data !== 'number') {
+                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 !== '') {
+                const parsed = parseInt(environmentValue, 10);
+                if (isNaN(parsed) || environmentValue.indexOf('.') >= 0) {
+                    throw new Error(`Invalid value "${environmentValue}" for the environment variable` +
+                        ` ${this.environmentVariable}.  It must be an integer value.`);
+                }
+                this._value = parsed;
+                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 an integer 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.toString());
+        }
+    }
+}
+exports.CommandLineIntegerParameter = CommandLineIntegerParameter;
+//# sourceMappingURL=CommandLineIntegerParameter.js.map

package/lib/parameters/CommandLineIntegerParameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineIntegerParameter.js","sourceRoot":"","sources":["../../src/parameters/CommandLineIntegerParameter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,+CAA2F;AAE3F;;;GAGG;AACH,MAAa,2BAA4B,SAAQ,8CAAgC;IAM/E,gBAAgB;IAChB,YAAmB,UAAyC;QAC1D,KAAK,CAAC,UAAU,CAAC,CAAC;QAJZ,WAAM,GAAuB,SAAS,CAAC;QAK7C,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC;IAED,8CAA8C;IAC9C,IAAW,IAAI;QACb,OAAO,sCAAwB,CAAC,OAAO,CAAC;IAC1C,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,MAAM,MAAM,GAAW,QAAQ,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;gBACtD,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;oBACvD,MAAM,IAAI,KAAK,CACb,kBAAkB,gBAAgB,gCAAgC;wBAChE,IAAI,IAAI,CAAC,mBAAmB,iCAAiC,CAChE,CAAC;iBACH;gBACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;gBACrB,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,wBAAwB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;SACvE;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,QAAQ,EAAE,CAAC,CAAC;SACrC;IACH,CAAC;CACF;AAvFD,kEAuFC","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 { ICommandLineIntegerDefinition } from './CommandLineDefinition';\r\nimport { CommandLineParameterWithArgument, CommandLineParameterKind } from './BaseClasses';\r\n\r\n/**\r\n * The data type returned by {@link CommandLineParameterProvider.defineIntegerParameter}.\r\n * @public\r\n */\r\nexport class CommandLineIntegerParameter extends CommandLineParameterWithArgument {\r\n  /** {@inheritDoc ICommandLineStringDefinition.defaultValue} */\r\n  public readonly defaultValue: number | undefined;\r\n\r\n  private _value: number | undefined = undefined;\r\n\r\n  /** @internal */\r\n  public constructor(definition: ICommandLineIntegerDefinition) {\r\n    super(definition);\r\n    this.defaultValue = definition.defaultValue;\r\n    this.validateDefaultValue(!!this.defaultValue);\r\n  }\r\n\r\n  /** {@inheritDoc CommandLineParameter.kind} */\r\n  public get kind(): CommandLineParameterKind {\r\n    return CommandLineParameterKind.Integer;\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 !== 'number') {\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        const parsed: number = parseInt(environmentValue, 10);\r\n        if (isNaN(parsed) || environmentValue.indexOf('.') >= 0) {\r\n          throw new Error(\r\n            `Invalid value \"${environmentValue}\" for the environment variable` +\r\n              ` ${this.environmentVariable}.  It must be an integer value.`\r\n          );\r\n        }\r\n        this._value = parsed;\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 an integer 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(): number | 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.toString());\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/parameters/CommandLineRemainder.d.ts

@@ -0,0 +1,28 @@
+import { ICommandLineRemainderDefinition } from './CommandLineDefinition';
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineCommandLineRemainder}.
+ * @public
+ */
+export declare class CommandLineRemainder {
+    private _values;
+    /** {@inheritDoc IBaseCommandLineDefinition.description} */
+    readonly description: string;
+    /** @internal */
+    constructor(definition: ICommandLineRemainderDefinition);
+    /**
+     * Returns any remaining command line arguments after the recognized portion
+     * that was parsed from the command line.
+     *
+     * @remarks
+     * The array will be empty if the command-line has not been parsed yet.
+     */
+    get values(): ReadonlyArray<string>;
+    /**
+     * {@inheritDoc CommandLineParameter._setValue}
+     * @internal
+     */
+    _setValue(data: any): void;
+    /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
+    appendToArgList(argList: string[]): void;
+}
+//# sourceMappingURL=CommandLineRemainder.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineRemainder.d.ts","sourceRoot":"","sources":["../../src/parameters/CommandLineRemainder.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,+BAA+B,EAAE,MAAM,yBAAyB,CAAC;AAE1E;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,OAAO,CAAgB;IAE/B,2DAA2D;IAC3D,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,gBAAgB;gBACG,UAAU,EAAE,+BAA+B;IAI9D;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,aAAa,CAAC,MAAM,CAAC,CAEzC;IAED;;;OAGG;IAEI,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IASjC,mEAAmE;IAC5D,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;CAOhD"}

package/lib/parameters/CommandLineRemainder.js

@@ -0,0 +1,48 @@
+"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.CommandLineRemainder = void 0;
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineCommandLineRemainder}.
+ * @public
+ */
+class CommandLineRemainder {
+    /** @internal */
+    constructor(definition) {
+        this._values = [];
+        this.description = definition.description;
+    }
+    /**
+     * Returns any remaining command line arguments after the recognized portion
+     * that was parsed from the command line.
+     *
+     * @remarks
+     * The array will be empty if the command-line has not been parsed yet.
+     */
+    get values() {
+        return this._values;
+    }
+    /**
+     * {@inheritDoc CommandLineParameter._setValue}
+     * @internal
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    _setValue(data) {
+        // abstract
+        if (!Array.isArray(data) || !data.every((x) => typeof x === 'string')) {
+            throw new Error(`Unexpected data object for remainder: ` + JSON.stringify(data));
+        }
+        this._values.push(...data);
+    }
+    /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
+    appendToArgList(argList) {
+        if (this.values.length > 0) {
+            for (const value of this.values) {
+                argList.push(value);
+            }
+        }
+    }
+}
+exports.CommandLineRemainder = CommandLineRemainder;
+//# sourceMappingURL=CommandLineRemainder.js.map

package/lib/parameters/CommandLineRemainder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineRemainder.js","sourceRoot":"","sources":["../../src/parameters/CommandLineRemainder.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAI3D;;;GAGG;AACH,MAAa,oBAAoB;IAM/B,gBAAgB;IAChB,YAAmB,UAA2C;QANtD,YAAO,GAAa,EAAE,CAAC;QAO7B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,8DAA8D;IACvD,SAAS,CAAC,IAAS;QACxB,WAAW;QACX,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAAE;YACrE,MAAM,IAAI,KAAK,CAAC,wCAAwC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;SAClF;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IAC7B,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,KAAK,CAAC,CAAC;aACrB;SACF;IACH,CAAC;CACF;AA5CD,oDA4CC","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 { ICommandLineRemainderDefinition } from './CommandLineDefinition';\r\n\r\n/**\r\n * The data type returned by {@link CommandLineParameterProvider.defineCommandLineRemainder}.\r\n * @public\r\n */\r\nexport class CommandLineRemainder {\r\n  private _values: string[] = [];\r\n\r\n  /** {@inheritDoc IBaseCommandLineDefinition.description} */\r\n  public readonly description: string;\r\n\r\n  /** @internal */\r\n  public constructor(definition: ICommandLineRemainderDefinition) {\r\n    this.description = definition.description;\r\n  }\r\n\r\n  /**\r\n   * Returns any remaining command line arguments after the recognized portion\r\n   * 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   */\r\n  public get values(): ReadonlyArray<string> {\r\n    return this._values;\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 (!Array.isArray(data) || !data.every((x) => typeof x === 'string')) {\r\n      throw new Error(`Unexpected data object for remainder: ` + JSON.stringify(data));\r\n    }\r\n\r\n    this._values.push(...data);\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(value);\r\n      }\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/parameters/CommandLineStringListParameter.d.ts

@@ -0,0 +1,29 @@
+import { ICommandLineStringListDefinition } from './CommandLineDefinition';
+import { CommandLineParameterWithArgument, CommandLineParameterKind } from './BaseClasses';
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineStringListParameter}.
+ * @public
+ */
+export declare class CommandLineStringListParameter extends CommandLineParameterWithArgument {
+    private _values;
+    /** @internal */
+    constructor(definition: ICommandLineStringListDefinition);
+    /** {@inheritDoc CommandLineParameter.kind} */
+    get kind(): CommandLineParameterKind;
+    /**
+     * {@inheritDoc CommandLineParameter._setValue}
+     * @internal
+     */
+    _setValue(data: any): void;
+    /**
+     * Returns the string arguments for a string 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<string>;
+    /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
+    appendToArgList(argList: string[]): void;
+}
+//# sourceMappingURL=CommandLineStringListParameter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineStringListParameter.d.ts","sourceRoot":"","sources":["../../src/parameters/CommandLineStringListParameter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gCAAgC,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,gCAAgC,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAG3F;;;GAGG;AACH,qBAAa,8BAA+B,SAAQ,gCAAgC;IAClF,OAAO,CAAC,OAAO,CAAgB;IAE/B,gBAAgB;gBACG,UAAU,EAAE,gCAAgC;IAI/D,8CAA8C;IAC9C,IAAW,IAAI,IAAI,wBAAwB,CAE1C;IAED;;;OAGG;IAEI,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IA6BjC;;;;;;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/CommandLineStringListParameter.js

@@ -0,0 +1,73 @@
+"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.CommandLineStringListParameter = void 0;
+const BaseClasses_1 = require("./BaseClasses");
+const EnvironmentVariableParser_1 = require("./EnvironmentVariableParser");
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineStringListParameter}.
+ * @public
+ */
+class CommandLineStringListParameter extends BaseClasses_1.CommandLineParameterWithArgument {
+    /** @internal */
+    constructor(definition) {
+        super(definition);
+        this._values = [];
+    }
+    /** {@inheritDoc CommandLineParameter.kind} */
+    get kind() {
+        return BaseClasses_1.CommandLineParameterKind.StringList;
+    }
+    /**
+     * {@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 !== 'string') {
+                    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) {
+                this._values = values;
+                return;
+            }
+        }
+        // (No default value for string lists)
+        this._values = [];
+    }
+    /**
+     * Returns the string arguments for a string 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(value);
+            }
+        }
+    }
+}
+exports.CommandLineStringListParameter = CommandLineStringListParameter;
+//# sourceMappingURL=CommandLineStringListParameter.js.map

package/lib/parameters/CommandLineStringListParameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineStringListParameter.js","sourceRoot":"","sources":["../../src/parameters/CommandLineStringListParameter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,+CAA2F;AAC3F,2EAAwE;AAExE;;;GAGG;AACH,MAAa,8BAA+B,SAAQ,8CAAgC;IAGlF,gBAAgB;IAChB,YAAmB,UAA4C;QAC7D,KAAK,CAAC,UAAU,CAAC,CAAC;QAJZ,YAAO,GAAa,EAAE,CAAC;IAK/B,CAAC;IAED,8CAA8C;IAC9C,IAAW,IAAI;QACb,OAAO,sCAAwB,CAAC,UAAU,CAAC;IAC7C,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,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;gBACtB,OAAO;aACR;SACF;QAED,sCAAsC;QAEtC,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,KAAK,CAAC,CAAC;aACrB;SACF;IACH,CAAC;CACF;AAnED,wEAmEC","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 { ICommandLineStringListDefinition } 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.defineStringListParameter}.\r\n * @public\r\n */\r\nexport class CommandLineStringListParameter extends CommandLineParameterWithArgument {\r\n  private _values: string[] = [];\r\n\r\n  /** @internal */\r\n  public constructor(definition: ICommandLineStringListDefinition) {\r\n    super(definition);\r\n  }\r\n\r\n  /** {@inheritDoc CommandLineParameter.kind} */\r\n  public get kind(): CommandLineParameterKind {\r\n    return CommandLineParameterKind.StringList;\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 !== 'string') {\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        this._values = values;\r\n        return;\r\n      }\r\n    }\r\n\r\n    // (No default value for string lists)\r\n\r\n    this._values = [];\r\n  }\r\n\r\n  /**\r\n   * Returns the string arguments for a string 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<string> {\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(value);\r\n      }\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/parameters/CommandLineStringParameter.d.ts

@@ -0,0 +1,36 @@
+import { ICommandLineStringDefinition } from './CommandLineDefinition';
+import { CommandLineParameterWithArgument, CommandLineParameterKind } from './BaseClasses';
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineStringParameter}.
+ * @public
+ */
+export declare class CommandLineStringParameter extends CommandLineParameterWithArgument {
+    /** {@inheritDoc ICommandLineStringDefinition.defaultValue} */
+    readonly defaultValue: string | undefined;
+    private _value;
+    /** @internal */
+    constructor(definition: ICommandLineStringDefinition);
+    /** {@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 string 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=CommandLineStringParameter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineStringParameter.d.ts","sourceRoot":"","sources":["../../src/parameters/CommandLineStringParameter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,gCAAgC,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AAE3F;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,gCAAgC;IAC9E,8DAA8D;IAC9D,SAAgB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjD,OAAO,CAAC,MAAM,CAAiC;IAE/C,gBAAgB;gBACG,UAAU,EAAE,4BAA4B;IAO3D,8CAA8C;IAC9C,IAAW,IAAI,IAAI,wBAAwB,CAE1C;IAED;;;OAGG;IAEI,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IA6BjC;;;OAGG;IACI,sBAAsB,CAAC,kBAAkB,EAAE,MAAM,EAAE,GAAG,IAAI;IAUjE;;;;;;OAMG;IACH,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED,mEAAmE;IAC5D,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;CAMhD"}

package/lib/parameters/CommandLineStringParameter.js

@@ -0,0 +1,85 @@
+"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.CommandLineStringParameter = void 0;
+const BaseClasses_1 = require("./BaseClasses");
+/**
+ * The data type returned by {@link CommandLineParameterProvider.defineStringParameter}.
+ * @public
+ */
+class CommandLineStringParameter extends BaseClasses_1.CommandLineParameterWithArgument {
+    /** @internal */
+    constructor(definition) {
+        super(definition);
+        this._value = undefined;
+        this.defaultValue = definition.defaultValue;
+        this.validateDefaultValue(!!this.defaultValue);
+    }
+    /** {@inheritDoc CommandLineParameter.kind} */
+    get kind() {
+        return BaseClasses_1.CommandLineParameterKind.String;
+    }
+    /**
+     * {@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) {
+                // NOTE: If the environment variable is defined as an empty string,
+                // here we will accept the empty string as our value.  (For number/flag we don't do that.)
+                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) {
+            if (this.defaultValue.length < 160) {
+                supplementaryNotes.push(`The default value is ${JSON.stringify(this.defaultValue)}.`);
+            }
+        }
+    }
+    /**
+     * Returns the argument value for a string 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.CommandLineStringParameter = CommandLineStringParameter;
+//# sourceMappingURL=CommandLineStringParameter.js.map

package/lib/parameters/CommandLineStringParameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLineStringParameter.js","sourceRoot":"","sources":["../../src/parameters/CommandLineStringParameter.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,+CAA2F;AAE3F;;;GAGG;AACH,MAAa,0BAA2B,SAAQ,8CAAgC;IAM9E,gBAAgB;IAChB,YAAmB,UAAwC;QACzD,KAAK,CAAC,UAAU,CAAC,CAAC;QAJZ,WAAM,GAAuB,SAAS,CAAC;QAM7C,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC;QAC5C,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACjD,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,EAAE;gBAClC,mEAAmE;gBACnE,0FAA0F;gBAC1F,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,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,GAAG,EAAE;gBAClC,kBAAkB,CAAC,IAAI,CAAC,wBAAwB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;aACvF;SACF;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;AArFD,gEAqFC","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 { ICommandLineStringDefinition } from './CommandLineDefinition';\r\nimport { CommandLineParameterWithArgument, CommandLineParameterKind } from './BaseClasses';\r\n\r\n/**\r\n * The data type returned by {@link CommandLineParameterProvider.defineStringParameter}.\r\n * @public\r\n */\r\nexport class CommandLineStringParameter extends CommandLineParameterWithArgument {\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  /** @internal */\r\n  public constructor(definition: ICommandLineStringDefinition) {\r\n    super(definition);\r\n\r\n    this.defaultValue = definition.defaultValue;\r\n    this.validateDefaultValue(!!this.defaultValue);\r\n  }\r\n\r\n  /** {@inheritDoc CommandLineParameter.kind} */\r\n  public get kind(): CommandLineParameterKind {\r\n    return CommandLineParameterKind.String;\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) {\r\n        // NOTE: If the environment variable is defined as an empty string,\r\n        // here we will accept the empty string as our value.  (For number/flag we don't do that.)\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      if (this.defaultValue.length < 160) {\r\n        supplementaryNotes.push(`The default value is ${JSON.stringify(this.defaultValue)}.`);\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Returns the argument value for a string 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/EnvironmentVariableParser.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Some parameter types can receive their values from an environment variable instead of
+ * a command line argument. This class provides some utility methods for parsing environment
+ * variable values.
+ * @internal
+ */
+export declare class EnvironmentVariableParser {
+    static parseAsList(envVarName: string): string[] | undefined;
+}
+//# sourceMappingURL=EnvironmentVariableParser.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EnvironmentVariableParser.d.ts","sourceRoot":"","sources":["../../src/parameters/EnvironmentVariableParser.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,qBAAa,yBAAyB;WACtB,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS;CA2CpE"}

package/lib/parameters/EnvironmentVariableParser.js

@@ -0,0 +1,51 @@
+"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.EnvironmentVariableParser = void 0;
+/**
+ * Some parameter types can receive their values from an environment variable instead of
+ * a command line argument. This class provides some utility methods for parsing environment
+ * variable values.
+ * @internal
+ */
+class EnvironmentVariableParser {
+    static parseAsList(envVarName) {
+        const environmentValue = process.env[envVarName];
+        if (environmentValue !== undefined) {
+            // NOTE: If the environment variable is defined as an empty string,
+            // here we will accept the empty string as our value.  (For number/flag we don't do that.)
+            if (environmentValue.trimLeft()[0] === '[') {
+                // Specifying multiple items in an environment variable is a somewhat rare case.  But environment
+                // variables are actually a pretty reliable way for a tool to avoid shell escaping problems
+                // when spawning another tool.  For this case, we need a reliable way to pass an array of strings
+                // that could contain any character.  For example, if we simply used ";" as the list delimiter,
+                // then what to do if a string contains that character?  We'd need to design an escaping mechanism.
+                // Since JSON is simple and standard and can escape every possible string, it's a better option
+                // than a custom delimiter.
+                try {
+                    const parsedJson = JSON.parse(environmentValue);
+                    if (!Array.isArray(parsedJson) ||
+                        !parsedJson.every((x) => typeof x === 'string' || typeof x === 'boolean' || typeof x === 'number')) {
+                        throw new Error(`The ${environmentValue} environment variable value must be a JSON ` +
+                            ` array containing only strings, numbers, and booleans.`);
+                    }
+                    return parsedJson.map((x) => x.toString());
+                }
+                catch (ex) {
+                    throw new Error(`The ${environmentValue} environment variable value looks like a JSON array` +
+                        ` but failed to parse: ` +
+                        ex.message);
+                }
+            }
+            else {
+                // As a shorthand, a single value may be specified without JSON encoding, as long as it does not
+                // start with the "[" character.
+                return [environmentValue];
+            }
+        }
+        return undefined;
+    }
+}
+exports.EnvironmentVariableParser = EnvironmentVariableParser;
+//# sourceMappingURL=EnvironmentVariableParser.js.map

package/lib/parameters/EnvironmentVariableParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvironmentVariableParser.js","sourceRoot":"","sources":["../../src/parameters/EnvironmentVariableParser.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D;;;;;GAKG;AACH,MAAa,yBAAyB;IAC7B,MAAM,CAAC,WAAW,CAAC,UAAkB;QAC1C,MAAM,gBAAgB,GAAuB,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAErE,IAAI,gBAAgB,KAAK,SAAS,EAAE;YAClC,mEAAmE;YACnE,0FAA0F;YAE1F,IAAI,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC1C,iGAAiG;gBACjG,2FAA2F;gBAC3F,iGAAiG;gBACjG,+FAA+F;gBAC/F,mGAAmG;gBACnG,+FAA+F;gBAC/F,2BAA2B;gBAC3B,IAAI;oBACF,MAAM,UAAU,GAAY,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;oBACzD,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;wBAC1B,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,QAAQ,CAAC,EAClG;wBACA,MAAM,IAAI,KAAK,CACb,OAAO,gBAAgB,6CAA6C;4BAClE,wDAAwD,CAC3D,CAAC;qBACH;oBACD,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;iBAC5C;gBAAC,OAAO,EAAE,EAAE;oBACX,MAAM,IAAI,KAAK,CACb,OAAO,gBAAgB,qDAAqD;wBAC1E,wBAAwB;wBACvB,EAAY,CAAC,OAAO,CACxB,CAAC;iBACH;aACF;iBAAM;gBACL,gGAAgG;gBAChG,gCAAgC;gBAChC,OAAO,CAAC,gBAAgB,CAAC,CAAC;aAC3B;SACF;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AA5CD,8DA4CC","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 * Some parameter types can receive their values from an environment variable instead of\r\n * a command line argument. This class provides some utility methods for parsing environment\r\n * variable values.\r\n * @internal\r\n */\r\nexport class EnvironmentVariableParser {\r\n  public static parseAsList(envVarName: string): string[] | undefined {\r\n    const environmentValue: string | undefined = process.env[envVarName];\r\n\r\n    if (environmentValue !== undefined) {\r\n      // NOTE: If the environment variable is defined as an empty string,\r\n      // here we will accept the empty string as our value.  (For number/flag we don't do that.)\r\n\r\n      if (environmentValue.trimLeft()[0] === '[') {\r\n        // Specifying multiple items in an environment variable is a somewhat rare case.  But environment\r\n        // variables are actually a pretty reliable way for a tool to avoid shell escaping problems\r\n        // when spawning another tool.  For this case, we need a reliable way to pass an array of strings\r\n        // that could contain any character.  For example, if we simply used \";\" as the list delimiter,\r\n        // then what to do if a string contains that character?  We'd need to design an escaping mechanism.\r\n        // Since JSON is simple and standard and can escape every possible string, it's a better option\r\n        // than a custom delimiter.\r\n        try {\r\n          const parsedJson: unknown = JSON.parse(environmentValue);\r\n          if (\r\n            !Array.isArray(parsedJson) ||\r\n            !parsedJson.every((x) => typeof x === 'string' || typeof x === 'boolean' || typeof x === 'number')\r\n          ) {\r\n            throw new Error(\r\n              `The ${environmentValue} environment variable value must be a JSON ` +\r\n                ` array containing only strings, numbers, and booleans.`\r\n            );\r\n          }\r\n          return parsedJson.map((x) => x.toString());\r\n        } catch (ex) {\r\n          throw new Error(\r\n            `The ${environmentValue} environment variable value looks like a JSON array` +\r\n              ` but failed to parse: ` +\r\n              (ex as Error).message\r\n          );\r\n        }\r\n      } else {\r\n        // As a shorthand, a single value may be specified without JSON encoding, as long as it does not\r\n        // start with the \"[\" character.\r\n        return [environmentValue];\r\n      }\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n}\r\n"]}

package/lib/providers/CommandLineAction.d.ts

@@ -0,0 +1,76 @@
+import * as argparse from 'argparse';
+import { CommandLineParameterProvider, ICommandLineParserData } from './CommandLineParameterProvider';
+/**
+ * Options for the CommandLineAction constructor.
+ * @public
+ */
+export interface ICommandLineActionOptions {
+    /**
+     * The name of the action.  For example, if the tool is called "example",
+     * then the "build" action might be invoked as: "example build -q --some-other-option"
+     */
+    actionName: string;
+    /**
+     * A quick summary that is shown on the main help page, which is displayed
+     * by the command "example --help"
+     */
+    summary: string;
+    /**
+     * A detailed description that is shown on the action help page, which is displayed
+     * by the command "example build --help", e.g. for actionName="build".
+     */
+    documentation: string;
+}
+/**
+ * Represents a sub-command that is part of the CommandLineParser command line.
+ * Applications should create subclasses of CommandLineAction corresponding to
+ * each action that they want to expose.
+ *
+ * The action name should be comprised of lower case words separated by hyphens
+ * or colons. The name should include an English verb (e.g. "deploy"). Use a
+ * hyphen to separate words (e.g. "upload-docs"). A group of related commands
+ * can be prefixed with a colon (e.g. "docs:generate", "docs:deploy",
+ * "docs:serve", etc).
+ *
+ * @public
+ */
+export declare abstract class CommandLineAction extends CommandLineParameterProvider {
+    private static _actionNameRegExp;
+    /** {@inheritDoc ICommandLineActionOptions.actionName} */
+    readonly actionName: string;
+    /** {@inheritDoc ICommandLineActionOptions.summary} */
+    readonly summary: string;
+    /** {@inheritDoc ICommandLineActionOptions.documentation} */
+    readonly documentation: string;
+    private _argumentParser;
+    constructor(options: ICommandLineActionOptions);
+    /**
+     * This is called internally by CommandLineParser.addAction()
+     * @internal
+     */
+    _buildParser(actionsSubParser: argparse.SubParser): void;
+    /**
+     * This is called internally by CommandLineParser.execute()
+     * @internal
+     */
+    _processParsedData(data: ICommandLineParserData): void;
+    /**
+     * Invoked by CommandLineParser.onExecute().
+     * @internal
+     */
+    _execute(): Promise<void>;
+    /**
+     * {@inheritDoc CommandLineParameterProvider._getArgumentParser}
+     * @internal
+     */
+    protected _getArgumentParser(): argparse.ArgumentParser;
+    /**
+     * {@inheritDoc CommandLineParameterProvider.onDefineParameters}
+     */
+    protected abstract onDefineParameters(): void;
+    /**
+     * Your subclass should implement this hook to perform the operation.
+     */
+    protected abstract onExecute(): Promise<void>;
+}
+//# sourceMappingURL=CommandLineAction.d.ts.map