65 行
2.5 KiB
JavaScript
65 行
2.5 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';
|
||
|
|
/**
|
||
|
|
* The data type returned by {@link CommandLineParameterProvider.defineFlagParameter}.
|
||
|
|
* @public
|
||
|
|
*/
|
||
|
|
export class CommandLineFlagParameter extends CommandLineParameterBase {
|
||
|
|
/** @internal */
|
||
|
|
constructor(definition) {
|
||
|
|
super(definition);
|
||
|
|
this._value = false;
|
||
|
|
/** {@inheritDoc CommandLineParameterBase.kind} */
|
||
|
|
this.kind = CommandLineParameterKind.Flag;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* {@inheritDoc CommandLineParameterBase._setValue}
|
||
|
|
* @internal
|
||
|
|
*/
|
||
|
|
_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 CommandLineParameterBase.appendToArgList} @override */
|
||
|
|
appendToArgList(argList) {
|
||
|
|
if (this.value) {
|
||
|
|
argList.push(this.longName);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
//# sourceMappingURL=CommandLineFlagParameter.js.map
|
