79 行
3.1 KiB
JavaScript
79 行
3.1 KiB
JavaScript
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
||
|
|
// See LICENSE in the project root for license information.
|
||
|
|
import { CommandLineParameterBase, CommandLineParameterKind } from './BaseClasses';
|
||
|
|
import { EnvironmentVariableParser } from './EnvironmentVariableParser';
|
||
|
|
/**
|
||
|
|
* The data type returned by {@link CommandLineParameterProvider.defineChoiceListParameter}.
|
||
|
|
* @public
|
||
|
|
*/
|
||
|
|
export class CommandLineChoiceListParameter extends CommandLineParameterBase {
|
||
|
|
/** @internal */
|
||
|
|
constructor(definition) {
|
||
|
|
super(definition);
|
||
|
|
this._values = [];
|
||
|
|
/** {@inheritDoc CommandLineParameterBase.kind} */
|
||
|
|
this.kind = CommandLineParameterKind.ChoiceList;
|
||
|
|
const { alternatives, completions } = definition;
|
||
|
|
const alternativesSet = alternatives instanceof Set ? alternatives : new Set(alternatives);
|
||
|
|
if (alternativesSet.size < 1) {
|
||
|
|
throw new Error(`When defining a choice list parameter, the alternatives list must contain at least one value.`);
|
||
|
|
}
|
||
|
|
this.alternatives = alternativesSet;
|
||
|
|
this.completions = completions;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* {@inheritDoc CommandLineParameterBase._setValue}
|
||
|
|
* @internal
|
||
|
|
*/
|
||
|
|
_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 (this.environmentVariable !== undefined) {
|
||
|
|
const values = EnvironmentVariableParser.parseAsList(this.environmentVariable);
|
||
|
|
if (values) {
|
||
|
|
for (const value of values) {
|
||
|
|
if (!this.alternatives.has(value)) {
|
||
|
|
const choices = '"' + Array.from(this.alternatives).join('", "') + '"';
|
||
|
|
throw new Error(`Invalid value "${value}" for the environment variable` +
|
||
|
|
` ${this.environmentVariable}. Valid choices are: ${choices}`);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
this._values = values;
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
// (No default value for choice lists)
|
||
|
|
this._values = [];
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Returns the string arguments for a choice 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 CommandLineParameterBase.appendToArgList} @override */
|
||
|
|
appendToArgList(argList) {
|
||
|
|
if (this.values.length > 0) {
|
||
|
|
for (const value of this.values) {
|
||
|
|
argList.push(this.longName);
|
||
|
|
argList.push(value);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
//# sourceMappingURL=CommandLineChoiceListParameter.js.map
|
