You're Invited: Meet the Socket team at BSidesSF and RSAC - April 27 - May 1.RSVP →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@rushstack/ts-command-line

Package Overview
Dependencies
Maintainers
2
Versions
108
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@rushstack/ts-command-line - npm Package Compare versions

Comparing version

4.7.10
to
4.8.0

lib/parameters/CommandLineChoiceListParameter.d.ts
lib/parameters/CommandLineChoiceListParameter.d.ts.map
lib/parameters/CommandLineChoiceListParameter.js
lib/parameters/CommandLineChoiceListParameter.js.map
lib/parameters/CommandLineIntegerListParameter.d.ts
lib/parameters/CommandLineIntegerListParameter.d.ts.map
lib/parameters/CommandLineIntegerListParameter.js
lib/parameters/CommandLineIntegerListParameter.js.map
lib/parameters/EnvironmentVariableParser.d.ts
lib/parameters/EnvironmentVariableParser.d.ts.map
lib/parameters/EnvironmentVariableParser.js
lib/parameters/EnvironmentVariableParser.js.map

12

CHANGELOG.json

@@ -5,2 +5,14 @@ {

{
"version": "4.8.0",
"tag": "@rushstack/ts-command-line_v4.8.0",
"date": "Thu, 01 Jul 2021 15:08:27 GMT",
"comments": {
"minor": [
{
"comment": "Add ChoiceList and IntegerList parameter types"
}
]
}
},
{
"version": "4.7.10",

@@ -7,0 +19,0 @@ "tag": "@rushstack/ts-command-line_v4.7.10",

9

CHANGELOG.md
# Change Log - @rushstack/ts-command-line
This log was last generated on Mon, 12 Apr 2021 15:10:28 GMT and should not be manually modified.
This log was last generated on Thu, 01 Jul 2021 15:08:27 GMT and should not be manually modified.
## 4.8.0
Thu, 01 Jul 2021 15:08:27 GMT
### Minor changes
- Add ChoiceList and IntegerList parameter types
## 4.7.10

@@ -6,0 +13,0 @@ Mon, 12 Apr 2021 15:10:28 GMT

125

dist/ts-command-line.d.ts

@@ -47,2 +47,28 @@ /**

/**
* The data type returned by {@link CommandLineParameterProvider.defineChoiceListParameter}.
* @public
*/
export declare class CommandLineChoiceListParameter extends CommandLineParameter {
/** {@inheritDoc ICommandLineChoiceListDefinition.alternatives} */
readonly alternatives: ReadonlyArray<string>;
private _values;
/** {@inheritDoc ICommandLineChoiceListDefinition.completions} */
readonly completions: (() => Promise<string[]>) | undefined;
/* Excluded from this release type: __constructor */
/** {@inheritDoc CommandLineParameter.kind} */
get kind(): CommandLineParameterKind;
/* Excluded from this release type: _setValue */
/**
* 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(): ReadonlyArray<string>;
/** {@inheritDoc CommandLineParameter.appendToArgList} @override */
appendToArgList(argList: string[]): void;
}
/**
* The data type returned by {@link CommandLineParameterProvider.defineChoiceParameter}.

@@ -125,2 +151,24 @@ * @public

/**
* The data type returned by {@link CommandLineParameterProvider.defineIntegerListParameter}.
* @public
*/
export declare class CommandLineIntegerListParameter extends CommandLineParameterWithArgument {
private _values;
/* Excluded from this release type: __constructor */
/** {@inheritDoc CommandLineParameter.kind} */
get kind(): CommandLineParameterKind;
/* Excluded from this release type: _setValue */
/**
* 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;
}
/**
* The data type returned by {@link CommandLineParameterProvider.defineIntegerParameter}.

@@ -213,3 +261,7 @@ * @public

/** Indicates a CommandLineStringListParameter */
StringList = 4
StringList = 4,
/** Indicates a CommandLineChoiceListParameter */
ChoiceList = 5,
/** Indicates a CommandLineIntegerListParameter */
IntegerList = 6
}

@@ -256,2 +308,20 @@

/**
* Defines a command-line parameter whose value must be a string from a fixed set of
* allowable choices (similar to an enum). The parameter can be specified multiple times to
* build a list.
*
* @remarks
* Example of a choice list parameter:
* ```
* example-tool --allow-color red --allow-color green
* ```
*/
defineChoiceListParameter(definition: ICommandLineChoiceListDefinition): CommandLineChoiceListParameter;
/**
* Returns the CommandLineChoiceListParameter with the specified long name.
* @remarks
* This method throws an exception if the parameter is not defined.
*/
getChoiceListParameter(parameterLongName: string): CommandLineChoiceListParameter;
/**
* Defines a command-line switch whose boolean value is true if the switch is provided,

@@ -290,2 +360,19 @@ * and false otherwise.

/**
* Defines a command-line parameter whose argument is an integer. The parameter can be specified
* multiple times to build a list.
*
* @remarks
* Example usage of an integer list parameter:
* ```
* example-tool --avoid 4 --avoid 13
* ```
*/
defineIntegerListParameter(definition: ICommandLineIntegerListDefinition): CommandLineIntegerListParameter;
/**
* Returns the CommandLineIntegerParameter with the specified long name.
* @remarks
* This method throws an exception if the parameter is not defined.
*/
getIntegerListParameter(parameterLongName: string): CommandLineIntegerListParameter;
/**
* Defines a command-line parameter whose argument is a single text string.

@@ -650,4 +737,5 @@ *

/**
* For use with CommandLineParser, this interface represents a parameter which is constrained to
* a list of possible options
* For use with {@link CommandLineParameterProvider.defineChoiceParameter},
* this interface defines a command line parameter which is constrained to a list of possible
* options.
*

@@ -675,2 +763,23 @@ * @public

/**
* 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 declare 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},

@@ -697,2 +806,12 @@ * this interface defines a command line parameter that is a boolean flag.

/**
* 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 declare interface ICommandLineIntegerListDefinition extends IBaseCommandLineDefinitionWithArgument {
}
/* Excluded from this release type: _ICommandLineParserData */

@@ -699,0 +818,0 @@

2

dist/tsdoc-metadata.json

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.

"packageName": "@microsoft/api-extractor",
"packageVersion": "7.13.4"
"packageVersion": "7.16.1"
}
]
}

4

lib/index.d.ts

@@ -7,3 +7,3 @@ /**

export { CommandLineAction, ICommandLineActionOptions } from './providers/CommandLineAction';
export { IBaseCommandLineDefinition, IBaseCommandLineDefinitionWithArgument, ICommandLineFlagDefinition, ICommandLineStringDefinition, ICommandLineStringListDefinition, ICommandLineIntegerDefinition, ICommandLineChoiceDefinition, ICommandLineRemainderDefinition } from './parameters/CommandLineDefinition';
export { IBaseCommandLineDefinition, IBaseCommandLineDefinitionWithArgument, ICommandLineFlagDefinition, ICommandLineStringDefinition, ICommandLineStringListDefinition, ICommandLineIntegerDefinition, ICommandLineIntegerListDefinition, ICommandLineChoiceDefinition, ICommandLineChoiceListDefinition, ICommandLineRemainderDefinition } from './parameters/CommandLineDefinition';
export { CommandLineParameterKind, CommandLineParameter, CommandLineParameterWithArgument } from './parameters/BaseClasses';

@@ -14,3 +14,5 @@ export { CommandLineFlagParameter } from './parameters/CommandLineFlagParameter';

export { CommandLineIntegerParameter } from './parameters/CommandLineIntegerParameter';
export { CommandLineIntegerListParameter } from './parameters/CommandLineIntegerListParameter';
export { CommandLineChoiceParameter } from './parameters/CommandLineChoiceParameter';
export { CommandLineChoiceListParameter } from './parameters/CommandLineChoiceListParameter';
export { CommandLineRemainder } from './parameters/CommandLineRemainder';

@@ -17,0 +19,0 @@ export { CommandLineParameterProvider, ICommandLineParserData as _ICommandLineParserData } from './providers/CommandLineParameterProvider';

4

lib/index.js

@@ -24,4 +24,8 @@ "use strict";

Object.defineProperty(exports, "CommandLineIntegerParameter", { enumerable: true, get: function () { return CommandLineIntegerParameter_1.CommandLineIntegerParameter; } });
var CommandLineIntegerListParameter_1 = require("./parameters/CommandLineIntegerListParameter");
Object.defineProperty(exports, "CommandLineIntegerListParameter", { enumerable: true, get: function () { return CommandLineIntegerListParameter_1.CommandLineIntegerListParameter; } });
var CommandLineChoiceParameter_1 = require("./parameters/CommandLineChoiceParameter");
Object.defineProperty(exports, "CommandLineChoiceParameter", { enumerable: true, get: function () { return CommandLineChoiceParameter_1.CommandLineChoiceParameter; } });
var CommandLineChoiceListParameter_1 = require("./parameters/CommandLineChoiceListParameter");
Object.defineProperty(exports, "CommandLineChoiceListParameter", { enumerable: true, get: function () { return CommandLineChoiceListParameter_1.CommandLineChoiceListParameter; } });
var CommandLineRemainder_1 = require("./parameters/CommandLineRemainder");

@@ -28,0 +32,0 @@ Object.defineProperty(exports, "CommandLineRemainder", { enumerable: true, get: function () { return CommandLineRemainder_1.CommandLineRemainder; } });

6

lib/parameters/BaseClasses.d.ts

@@ -16,3 +16,7 @@ import { IBaseCommandLineDefinition, IBaseCommandLineDefinitionWithArgument } from './CommandLineDefinition';

/** Indicates a CommandLineStringListParameter */
StringList = 4
StringList = 4,
/** Indicates a CommandLineChoiceListParameter */
ChoiceList = 5,
/** Indicates a CommandLineIntegerListParameter */
IntegerList = 6
}

@@ -19,0 +23,0 @@ /**

4

lib/parameters/BaseClasses.js

@@ -22,2 +22,6 @@ "use strict";

CommandLineParameterKind[CommandLineParameterKind["StringList"] = 4] = "StringList";
/** Indicates a CommandLineChoiceListParameter */
CommandLineParameterKind[CommandLineParameterKind["ChoiceList"] = 5] = "ChoiceList";
/** Indicates a CommandLineIntegerListParameter */
CommandLineParameterKind[CommandLineParameterKind["IntegerList"] = 6] = "IntegerList";
})(CommandLineParameterKind = exports.CommandLineParameterKind || (exports.CommandLineParameterKind = {}));

@@ -24,0 +28,0 @@ /**

34

lib/parameters/CommandLineDefinition.d.ts

@@ -96,4 +96,5 @@ /**

/**
* For use with CommandLineParser, this interface represents a parameter which is constrained to
* a list of possible options
* For use with {@link CommandLineParameterProvider.defineChoiceParameter},
* this interface defines a command line parameter which is constrained to a list of possible
* options.
*

@@ -120,2 +121,22 @@ * @public

/**
* 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},

@@ -141,2 +162,11 @@ * this interface defines a command line parameter that is a boolean flag.

/**
* 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},

@@ -143,0 +173,0 @@ * this interface defines a command line parameter whose argument is a string value.

40

lib/parameters/CommandLineStringListParameter.js

@@ -7,2 +7,3 @@ "use strict";

const BaseClasses_1 = require("./BaseClasses");
const EnvironmentVariableParser_1 = require("./EnvironmentVariableParser");
/**

@@ -28,3 +29,3 @@ * The data type returned by {@link CommandLineParameterProvider.defineStringListParameter}.

_setValue(data) {
// abstract
// If argparse passed us a value, confirm it is valid
if (data !== null && data !== undefined) {

@@ -42,36 +43,7 @@ if (!Array.isArray(data)) {

}
// If an environment variable exists, attempt to parse it as a list
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.)
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.`);
}
this._values = 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.
this._values = [environmentValue];
}
const values = EnvironmentVariableParser_1.EnvironmentVariableParser.parseAsList(this.environmentVariable);
if (values) {
this._values = values;
return;

@@ -78,0 +50,0 @@ }

43

lib/providers/CommandLineParameterProvider.d.ts
import * as argparse from 'argparse';
import { ICommandLineFlagDefinition, ICommandLineStringDefinition, ICommandLineStringListDefinition, ICommandLineIntegerDefinition, ICommandLineChoiceDefinition, ICommandLineRemainderDefinition } from '../parameters/CommandLineDefinition';
import { ICommandLineChoiceDefinition, ICommandLineChoiceListDefinition, ICommandLineIntegerDefinition, ICommandLineIntegerListDefinition, ICommandLineFlagDefinition, ICommandLineStringDefinition, ICommandLineStringListDefinition, ICommandLineRemainderDefinition } from '../parameters/CommandLineDefinition';
import { CommandLineParameter } from '../parameters/BaseClasses';
import { CommandLineChoiceParameter } from '../parameters/CommandLineChoiceParameter';
import { CommandLineChoiceListParameter } from '../parameters/CommandLineChoiceListParameter';
import { CommandLineIntegerParameter } from '../parameters/CommandLineIntegerParameter';
import { CommandLineIntegerListParameter } from '../parameters/CommandLineIntegerListParameter';
import { CommandLineFlagParameter } from '../parameters/CommandLineFlagParameter';
import { CommandLineStringParameter } from '../parameters/CommandLineStringParameter';
import { CommandLineStringListParameter } from '../parameters/CommandLineStringListParameter';
import { CommandLineIntegerParameter } from '../parameters/CommandLineIntegerParameter';
import { CommandLineChoiceParameter } from '../parameters/CommandLineChoiceParameter';
import { CommandLineRemainder } from '../parameters/CommandLineRemainder';

@@ -58,2 +60,20 @@ /**

/**
* Defines a command-line parameter whose value must be a string from a fixed set of
* allowable choices (similar to an enum). The parameter can be specified multiple times to
* build a list.
*
* @remarks
* Example of a choice list parameter:
* ```
* example-tool --allow-color red --allow-color green
* ```
*/
defineChoiceListParameter(definition: ICommandLineChoiceListDefinition): CommandLineChoiceListParameter;
/**
* Returns the CommandLineChoiceListParameter with the specified long name.
* @remarks
* This method throws an exception if the parameter is not defined.
*/
getChoiceListParameter(parameterLongName: string): CommandLineChoiceListParameter;
/**
* Defines a command-line switch whose boolean value is true if the switch is provided,

@@ -92,2 +112,19 @@ * and false otherwise.

/**
* Defines a command-line parameter whose argument is an integer. The parameter can be specified
* multiple times to build a list.
*
* @remarks
* Example usage of an integer list parameter:
* ```
* example-tool --avoid 4 --avoid 13
* ```
*/
defineIntegerListParameter(definition: ICommandLineIntegerListDefinition): CommandLineIntegerListParameter;
/**
* Returns the CommandLineIntegerParameter with the specified long name.
* @remarks
* This method throws an exception if the parameter is not defined.
*/
getIntegerListParameter(parameterLongName: string): CommandLineIntegerListParameter;
/**
* Defines a command-line parameter whose argument is a single text string.

@@ -94,0 +131,0 @@ *

66

lib/providers/CommandLineParameterProvider.js

@@ -27,7 +27,9 @@ "use strict";

const BaseClasses_1 = require("../parameters/BaseClasses");
const CommandLineChoiceParameter_1 = require("../parameters/CommandLineChoiceParameter");
const CommandLineChoiceListParameter_1 = require("../parameters/CommandLineChoiceListParameter");
const CommandLineIntegerParameter_1 = require("../parameters/CommandLineIntegerParameter");
const CommandLineIntegerListParameter_1 = require("../parameters/CommandLineIntegerListParameter");
const CommandLineFlagParameter_1 = require("../parameters/CommandLineFlagParameter");
const CommandLineStringParameter_1 = require("../parameters/CommandLineStringParameter");
const CommandLineStringListParameter_1 = require("../parameters/CommandLineStringListParameter");
const CommandLineIntegerParameter_1 = require("../parameters/CommandLineIntegerParameter");
const CommandLineChoiceParameter_1 = require("../parameters/CommandLineChoiceParameter");
const CommandLineRemainder_1 = require("../parameters/CommandLineRemainder");

@@ -84,2 +86,26 @@ /**

/**
* Defines a command-line parameter whose value must be a string from a fixed set of
* allowable choices (similar to an enum). The parameter can be specified multiple times to
* build a list.
*
* @remarks
* Example of a choice list parameter:
* ```
* example-tool --allow-color red --allow-color green
* ```
*/
defineChoiceListParameter(definition) {
const parameter = new CommandLineChoiceListParameter_1.CommandLineChoiceListParameter(definition);
this._defineParameter(parameter);
return parameter;
}
/**
* Returns the CommandLineChoiceListParameter with the specified long name.
* @remarks
* This method throws an exception if the parameter is not defined.
*/
getChoiceListParameter(parameterLongName) {
return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.ChoiceList);
}
/**
* Defines a command-line switch whose boolean value is true if the switch is provided,

@@ -130,2 +156,25 @@ * and false otherwise.

/**
* Defines a command-line parameter whose argument is an integer. The parameter can be specified
* multiple times to build a list.
*
* @remarks
* Example usage of an integer list parameter:
* ```
* example-tool --avoid 4 --avoid 13
* ```
*/
defineIntegerListParameter(definition) {
const parameter = new CommandLineIntegerListParameter_1.CommandLineIntegerListParameter(definition);
this._defineParameter(parameter);
return parameter;
}
/**
* Returns the CommandLineIntegerParameter with the specified long name.
* @remarks
* This method throws an exception if the parameter is not defined.
*/
getIntegerListParameter(parameterLongName) {
return this._getParameter(parameterLongName, BaseClasses_1.CommandLineParameterKind.IntegerList);
}
/**
* Defines a command-line parameter whose argument is a single text string.

@@ -265,6 +314,13 @@ *

switch (parameter.kind) {
case BaseClasses_1.CommandLineParameterKind.Choice:
case BaseClasses_1.CommandLineParameterKind.Choice: {
const choiceParameter = parameter;
argparseOptions.choices = choiceParameter.alternatives;
break;
}
case BaseClasses_1.CommandLineParameterKind.ChoiceList: {
const choiceParameter = parameter;
argparseOptions.choices = choiceParameter.alternatives;
argparseOptions.action = 'append';
break;
}
case BaseClasses_1.CommandLineParameterKind.Flag:

@@ -276,2 +332,6 @@ argparseOptions.action = 'storeTrue';

break;
case BaseClasses_1.CommandLineParameterKind.IntegerList:
argparseOptions.type = 'int';
argparseOptions.action = 'append';
break;
case BaseClasses_1.CommandLineParameterKind.String:

@@ -278,0 +338,0 @@ break;

12

package.json
{
"name": "@rushstack/ts-command-line",
"version": "4.7.10",
"version": "4.8.0",
"description": "An object-oriented command-line parser for TypeScript",

@@ -11,5 +11,2 @@ "repository": {

"typings": "dist/ts-command-line.d.ts",
"scripts": {
"build": "heft test --clean"
},
"license": "MIT",

@@ -24,7 +21,10 @@ "dependencies": {

"@rushstack/eslint-config": "2.3.4",
"@rushstack/heft": "0.28.0",
"@rushstack/heft-node-rig": "1.0.8",
"@rushstack/heft": "0.32.0",
"@rushstack/heft-node-rig": "1.0.31",
"@types/heft-jest": "1.0.1",
"@types/node": "10.17.13"
},
"scripts": {
"build": "heft test --clean"
}
}
lib/index.d.ts.map

Sorry, the diff of this file is not supported yet

lib/index.js.map

Sorry, the diff of this file is not supported yet

lib/parameters/BaseClasses.d.ts.map

Sorry, the diff of this file is not supported yet

lib/parameters/BaseClasses.js.map

Sorry, the diff of this file is not supported yet

lib/parameters/CommandLineDefinition.d.ts.map

Sorry, the diff of this file is not supported yet

lib/parameters/CommandLineDefinition.js.map

Sorry, the diff of this file is not supported yet

lib/parameters/CommandLineStringListParameter.d.ts.map

Sorry, the diff of this file is not supported yet

lib/parameters/CommandLineStringListParameter.js.map

Sorry, the diff of this file is not supported yet

lib/providers/CommandLineParameterProvider.d.ts.map

Sorry, the diff of this file is not supported yet

lib/providers/CommandLineParameterProvider.js.map

Sorry, the diff of this file is not supported yet