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

Comparing version 4.6.10 to 4.7.0

CHANGELOG.json

@@ -5,2 +5,24 @@ {
     {
+      "version": "4.7.0",
+      "tag": "@rushstack/ts-command-line_v4.7.0",
+      "date": "Wed, 30 Sep 2020 06:53:53 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Update README.md"
+          }
+        ],
+        "minor": [
+          {
+            "comment": "Upgrade compiler; the API now requires TypeScript 3.9 or newer"
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/eslint-config\" to `2.1.2`"
+          }
+        ]
+      }
+    },
+    {
       "version": "4.6.10",
@@ -7,0 +29,0 @@ "tag": "@rushstack/ts-command-line_v4.6.10",

CHANGELOG.md

 # Change Log - @rushstack/ts-command-line
 
-This log was last generated on Tue, 22 Sep 2020 05:45:57 GMT and should not be manually modified.
+This log was last generated on Wed, 30 Sep 2020 06:53:53 GMT and should not be manually modified.
 
+## 4.7.0
+Wed, 30 Sep 2020 06:53:53 GMT
+
+### Minor changes
+
+- Upgrade compiler; the API now requires TypeScript 3.9 or newer
+
+### Patches
+
+- Update README.md
+
 ## 4.6.10
@@ -6,0 +17,0 @@ Tue, 22 Sep 2020 05:45:57 GMT

dist/ts-command-line.d.ts

@@ -60,3 +60,3 @@ /**
     /** {@inheritDoc CommandLineParameter.kind} */
-    readonly kind: CommandLineParameterKind;
+    get kind(): CommandLineParameterKind;
     /* Excluded from this release type: _setValue */
@@ -71,3 +71,3 @@ /* Excluded from this release type: _getSupplementaryNotes */
      */
-    readonly value: string | undefined;
+    get value(): string | undefined;
     /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
@@ -97,3 +97,3 @@ appendToArgList(argList: string[]): void;
     /** {@inheritDoc CommandLineParameter.kind} */
-    readonly kind: CommandLineParameterKind;
+    get kind(): CommandLineParameterKind;
     /* Excluded from this release type: _setValue */
@@ -107,3 +107,3 @@ /**
      */
-    readonly value: boolean;
+    get value(): boolean;
     /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
@@ -137,3 +137,3 @@ appendToArgList(argList: string[]): void;
     /** {@inheritDoc CommandLineParameter.kind} */
-    readonly kind: CommandLineParameterKind;
+    get kind(): CommandLineParameterKind;
     /* Excluded from this release type: _setValue */
@@ -148,3 +148,3 @@ /* Excluded from this release type: _getSupplementaryNotes */
      */
-    readonly value: number | undefined;
+    get value(): number | undefined;
     /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
@@ -181,3 +181,3 @@ appendToArgList(argList: string[]): void;
      */
-    abstract readonly kind: CommandLineParameterKind;
+    abstract get kind(): CommandLineParameterKind;
     /**
@@ -236,3 +236,3 @@ * Append the parsed values to the provided string array.
      */
-    readonly parameters: ReadonlyArray<CommandLineParameter>;
+    get parameters(): ReadonlyArray<CommandLineParameter>;
     /**
@@ -242,3 +242,3 @@ * If {@link CommandLineParameterProvider.defineCommandLineRemainder} was called,
      */
-    readonly remainder: CommandLineRemainder | undefined;
+    get remainder(): CommandLineRemainder | undefined;
     /**
@@ -404,3 +404,3 @@ * Defines a command-line parameter whose value must be a string from a fixed set of
      */
-    readonly actions: ReadonlyArray<CommandLineAction>;
+    get actions(): ReadonlyArray<CommandLineAction>;
     /**
@@ -468,3 +468,3 @@ * Defines a new action that can be used with the CommandLineParser instance.
      */
-    readonly values: ReadonlyArray<string>;
+    get values(): ReadonlyArray<string>;
     /* Excluded from this release type: _setValue */
@@ -483,3 +483,3 @@ /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
     /** {@inheritDoc CommandLineParameter.kind} */
-    readonly kind: CommandLineParameterKind;
+    get kind(): CommandLineParameterKind;
     /* Excluded from this release type: _setValue */
@@ -493,3 +493,3 @@ /**
      */
-    readonly values: ReadonlyArray<string>;
+    get values(): ReadonlyArray<string>;
     /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
@@ -509,3 +509,3 @@ appendToArgList(argList: string[]): void;
     /** {@inheritDoc CommandLineParameter.kind} */
-    readonly kind: CommandLineParameterKind;
+    get kind(): CommandLineParameterKind;
     /* Excluded from this release type: _setValue */
@@ -520,3 +520,3 @@ /* Excluded from this release type: _getSupplementaryNotes */
      */
-    readonly value: string | undefined;
+    get value(): string | undefined;
     /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
@@ -523,0 +523,0 @@ appendToArgList(argList: string[]): void;

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.9.11"
+      "packageVersion": "7.9.22"
     }
   ]
 }

lib/CommandLineHelper.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineHelper = void 0;
 /**
@@ -7,0 +8,0 @@ * Helpers for working with the ts-command-line API.

lib/index.js

@@ -11,29 +11,29 @@ "use strict";
 var CommandLineAction_1 = require("./providers/CommandLineAction");
-exports.CommandLineAction = CommandLineAction_1.CommandLineAction;
+Object.defineProperty(exports, "CommandLineAction", { enumerable: true, get: function () { return CommandLineAction_1.CommandLineAction; } });
 var BaseClasses_1 = require("./parameters/BaseClasses");
-exports.CommandLineParameterKind = BaseClasses_1.CommandLineParameterKind;
-exports.CommandLineParameter = BaseClasses_1.CommandLineParameter;
-exports.CommandLineParameterWithArgument = BaseClasses_1.CommandLineParameterWithArgument;
+Object.defineProperty(exports, "CommandLineParameterKind", { enumerable: true, get: function () { return BaseClasses_1.CommandLineParameterKind; } });
+Object.defineProperty(exports, "CommandLineParameter", { enumerable: true, get: function () { return BaseClasses_1.CommandLineParameter; } });
+Object.defineProperty(exports, "CommandLineParameterWithArgument", { enumerable: true, get: function () { return BaseClasses_1.CommandLineParameterWithArgument; } });
 var CommandLineFlagParameter_1 = require("./parameters/CommandLineFlagParameter");
-exports.CommandLineFlagParameter = CommandLineFlagParameter_1.CommandLineFlagParameter;
+Object.defineProperty(exports, "CommandLineFlagParameter", { enumerable: true, get: function () { return CommandLineFlagParameter_1.CommandLineFlagParameter; } });
 var CommandLineStringParameter_1 = require("./parameters/CommandLineStringParameter");
-exports.CommandLineStringParameter = CommandLineStringParameter_1.CommandLineStringParameter;
+Object.defineProperty(exports, "CommandLineStringParameter", { enumerable: true, get: function () { return CommandLineStringParameter_1.CommandLineStringParameter; } });
 var CommandLineStringListParameter_1 = require("./parameters/CommandLineStringListParameter");
-exports.CommandLineStringListParameter = CommandLineStringListParameter_1.CommandLineStringListParameter;
+Object.defineProperty(exports, "CommandLineStringListParameter", { enumerable: true, get: function () { return CommandLineStringListParameter_1.CommandLineStringListParameter; } });
 var CommandLineIntegerParameter_1 = require("./parameters/CommandLineIntegerParameter");
-exports.CommandLineIntegerParameter = CommandLineIntegerParameter_1.CommandLineIntegerParameter;
+Object.defineProperty(exports, "CommandLineIntegerParameter", { enumerable: true, get: function () { return CommandLineIntegerParameter_1.CommandLineIntegerParameter; } });
 var CommandLineChoiceParameter_1 = require("./parameters/CommandLineChoiceParameter");
-exports.CommandLineChoiceParameter = CommandLineChoiceParameter_1.CommandLineChoiceParameter;
+Object.defineProperty(exports, "CommandLineChoiceParameter", { enumerable: true, get: function () { return CommandLineChoiceParameter_1.CommandLineChoiceParameter; } });
 var CommandLineRemainder_1 = require("./parameters/CommandLineRemainder");
-exports.CommandLineRemainder = CommandLineRemainder_1.CommandLineRemainder;
+Object.defineProperty(exports, "CommandLineRemainder", { enumerable: true, get: function () { return CommandLineRemainder_1.CommandLineRemainder; } });
 var CommandLineParameterProvider_1 = require("./providers/CommandLineParameterProvider");
-exports.CommandLineParameterProvider = CommandLineParameterProvider_1.CommandLineParameterProvider;
+Object.defineProperty(exports, "CommandLineParameterProvider", { enumerable: true, get: function () { return CommandLineParameterProvider_1.CommandLineParameterProvider; } });
 var CommandLineParser_1 = require("./providers/CommandLineParser");
-exports.CommandLineParser = CommandLineParser_1.CommandLineParser;
+Object.defineProperty(exports, "CommandLineParser", { enumerable: true, get: function () { return CommandLineParser_1.CommandLineParser; } });
 var DynamicCommandLineAction_1 = require("./providers/DynamicCommandLineAction");
-exports.DynamicCommandLineAction = DynamicCommandLineAction_1.DynamicCommandLineAction;
+Object.defineProperty(exports, "DynamicCommandLineAction", { enumerable: true, get: function () { return DynamicCommandLineAction_1.DynamicCommandLineAction; } });
 var DynamicCommandLineParser_1 = require("./providers/DynamicCommandLineParser");
-exports.DynamicCommandLineParser = DynamicCommandLineParser_1.DynamicCommandLineParser;
+Object.defineProperty(exports, "DynamicCommandLineParser", { enumerable: true, get: function () { return DynamicCommandLineParser_1.DynamicCommandLineParser; } });
 var CommandLineHelper_1 = require("./CommandLineHelper");
-exports.CommandLineHelper = CommandLineHelper_1.CommandLineHelper;
+Object.defineProperty(exports, "CommandLineHelper", { enumerable: true, get: function () { return CommandLineHelper_1.CommandLineHelper; } });
 //# sourceMappingURL=index.js.map

lib/parameters/BaseClasses.d.ts

@@ -58,3 +58,3 @@ import { IBaseCommandLineDefinition, IBaseCommandLineDefinitionWithArgument } from './CommandLineDefinition';
      */
-    abstract readonly kind: CommandLineParameterKind;
+    abstract get kind(): CommandLineParameterKind;
     /**
@@ -61,0 +61,0 @@ * Append the parsed values to the provided string array.

lib/parameters/BaseClasses.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineParameterWithArgument = exports.CommandLineParameter = exports.CommandLineParameterKind = void 0;
 /**
@@ -104,2 +105,3 @@ * Identifies the kind of a CommandLineParameter.
 }
+exports.CommandLineParameter = CommandLineParameter;
 // Example: "--do-something"
@@ -114,3 +116,2 @@ CommandLineParameter._longNameRegExp = /^-(-[a-z0-9]+)+$/;
 CommandLineParameter._environmentVariableRegExp = /^[A-Z_][A-Z0-9_]*$/;
-exports.CommandLineParameter = CommandLineParameter;
 /**
@@ -143,5 +144,5 @@ * The common base class for parameters types that receive an argument.
 }
+exports.CommandLineParameterWithArgument = CommandLineParameterWithArgument;
 // Matches the first character that *isn't* part of a valid upper-case argument name such as "URL_2"
 CommandLineParameterWithArgument._invalidArgumentNameRegExp = /[^A-Z_0-9]/;
-exports.CommandLineParameterWithArgument = CommandLineParameterWithArgument;
 //# sourceMappingURL=BaseClasses.js.map

lib/parameters/CommandLineChoiceParameter.d.ts

@@ -18,3 +18,3 @@ import { ICommandLineChoiceDefinition } from './CommandLineDefinition';
     /** {@inheritDoc CommandLineParameter.kind} */
-    readonly kind: CommandLineParameterKind;
+    get kind(): CommandLineParameterKind;
     /**
@@ -37,3 +37,3 @@ * {@inheritDoc CommandLineParameter._setValue}
      */
-    readonly value: string | undefined;
+    get value(): string | undefined;
     /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
@@ -40,0 +40,0 @@ appendToArgList(argList: string[]): void;

lib/parameters/CommandLineChoiceParameter.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineChoiceParameter = void 0;
 const BaseClasses_1 = require("./BaseClasses");
@@ -7,0 +8,0 @@ /**

lib/parameters/CommandLineFlagParameter.d.ts

@@ -12,3 +12,3 @@ import { ICommandLineFlagDefinition } from './CommandLineDefinition';
     /** {@inheritDoc CommandLineParameter.kind} */
-    readonly kind: CommandLineParameterKind;
+    get kind(): CommandLineParameterKind;
     /**
@@ -26,3 +26,3 @@ * {@inheritDoc CommandLineParameter._setValue}
      */
-    readonly value: boolean;
+    get value(): boolean;
     /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
@@ -29,0 +29,0 @@ appendToArgList(argList: string[]): void;

lib/parameters/CommandLineFlagParameter.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineFlagParameter = void 0;
 const BaseClasses_1 = require("./BaseClasses");
@@ -7,0 +8,0 @@ /**

lib/parameters/CommandLineIntegerParameter.d.ts

@@ -14,3 +14,3 @@ import { ICommandLineIntegerDefinition } from './CommandLineDefinition';
     /** {@inheritDoc CommandLineParameter.kind} */
-    readonly kind: CommandLineParameterKind;
+    get kind(): CommandLineParameterKind;
     /**
@@ -33,3 +33,3 @@ * {@inheritDoc CommandLineParameter._setValue}
      */
-    readonly value: number | undefined;
+    get value(): number | undefined;
     /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
@@ -36,0 +36,0 @@ appendToArgList(argList: string[]): void;

lib/parameters/CommandLineIntegerParameter.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineIntegerParameter = void 0;
 const BaseClasses_1 = require("./BaseClasses");
@@ -7,0 +8,0 @@ /**

lib/parameters/CommandLineRemainder.d.ts

@@ -19,3 +19,3 @@ import { ICommandLineRemainderDefinition } from './CommandLineDefinition';
      */
-    readonly values: ReadonlyArray<string>;
+    get values(): ReadonlyArray<string>;
     /**
@@ -22,0 +22,0 @@ * {@inheritDoc CommandLineParameter._setValue}

lib/parameters/CommandLineRemainder.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineRemainder = void 0;
 /**
@@ -7,0 +8,0 @@ * The data type returned by {@link CommandLineParameterProvider.defineCommandLineRemainder}.

lib/parameters/CommandLineStringListParameter.d.ts

@@ -12,3 +12,3 @@ import { ICommandLineStringListDefinition } from './CommandLineDefinition';
     /** {@inheritDoc CommandLineParameter.kind} */
-    readonly kind: CommandLineParameterKind;
+    get kind(): CommandLineParameterKind;
     /**
@@ -26,3 +26,3 @@ * {@inheritDoc CommandLineParameter._setValue}
      */
-    readonly values: ReadonlyArray<string>;
+    get values(): ReadonlyArray<string>;
     /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
@@ -29,0 +29,0 @@ appendToArgList(argList: string[]): void;

lib/parameters/CommandLineStringListParameter.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineStringListParameter = void 0;
 const BaseClasses_1 = require("./BaseClasses");
@@ -7,0 +8,0 @@ /**

lib/parameters/CommandLineStringParameter.d.ts

@@ -14,3 +14,3 @@ import { ICommandLineStringDefinition } from './CommandLineDefinition';
     /** {@inheritDoc CommandLineParameter.kind} */
-    readonly kind: CommandLineParameterKind;
+    get kind(): CommandLineParameterKind;
     /**
@@ -33,3 +33,3 @@ * {@inheritDoc CommandLineParameter._setValue}
      */
-    readonly value: string | undefined;
+    get value(): string | undefined;
     /** {@inheritDoc CommandLineParameter.appendToArgList} @override */
@@ -36,0 +36,0 @@ appendToArgList(argList: string[]): void;

lib/parameters/CommandLineStringParameter.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineStringParameter = void 0;
 const BaseClasses_1 = require("./BaseClasses");
@@ -7,0 +8,0 @@ /**

lib/providers/CommandLineAction.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineAction = void 0;
 const CommandLineParameterProvider_1 = require("./CommandLineParameterProvider");
@@ -70,5 +71,5 @@ /**
 }
+exports.CommandLineAction = CommandLineAction;
 // Example: "do-something"
 CommandLineAction._actionNameRegExp = /^[a-z][a-z0-9]*([-:][a-z0-9]+)*$/;
-exports.CommandLineAction = CommandLineAction;
 //# sourceMappingURL=CommandLineAction.js.map

lib/providers/CommandLineParameterProvider.d.ts

@@ -34,3 +34,3 @@ import * as argparse from 'argparse';
      */
-    readonly parameters: ReadonlyArray<CommandLineParameter>;
+    get parameters(): ReadonlyArray<CommandLineParameter>;
     /**
@@ -40,3 +40,3 @@ * If {@link CommandLineParameterProvider.defineCommandLineRemainder} was called,
      */
-    readonly remainder: CommandLineRemainder | undefined;
+    get remainder(): CommandLineRemainder | undefined;
     /**
@@ -43,0 +43,0 @@ * Defines a command-line parameter whose value must be a string from a fixed set of

lib/providers/CommandLineParameterProvider.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineParameterProvider = void 0;
 const argparse = require("argparse");
@@ -262,3 +263,3 @@ const BaseClasses_1 = require("../parameters/BaseClasses");
         if (parameter.undocumentedSynonyms && parameter.undocumentedSynonyms.length > 0) {
-            argumentParser.addArgument(parameter.undocumentedSynonyms, Object.assign({}, argparseOptions, { help: argparse.Const.SUPPRESS }));
+            argumentParser.addArgument(parameter.undocumentedSynonyms, Object.assign(Object.assign({}, argparseOptions), { help: argparse.Const.SUPPRESS }));
         }
@@ -269,4 +270,4 @@ this._parameters.push(parameter);
 }
+exports.CommandLineParameterProvider = CommandLineParameterProvider;
 CommandLineParameterProvider._keyCounter = 0;
-exports.CommandLineParameterProvider = CommandLineParameterProvider;
 //# sourceMappingURL=CommandLineParameterProvider.js.map

lib/providers/CommandLineParser.d.ts

@@ -50,3 +50,3 @@ import * as argparse from 'argparse';
      */
-    readonly actions: ReadonlyArray<CommandLineAction>;
+    get actions(): ReadonlyArray<CommandLineAction>;
     /**
@@ -53,0 +53,0 @@ * Defines a new action that can be used with the CommandLineParser instance.

lib/providers/CommandLineParser.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandLineParser = void 0;
 const colors = require("colors");
@@ -7,0 +8,0 @@ const CommandLineParameterProvider_1 = require("./CommandLineParameterProvider");

lib/providers/CommandLineParserExitError.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomArgumentParser = exports.CommandLineParserExitError = void 0;
 const argparse = require("argparse");
@@ -7,0 +8,0 @@ class CommandLineParserExitError extends Error {

lib/providers/DynamicCommandLineAction.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicCommandLineAction = void 0;
 const CommandLineAction_1 = require("./CommandLineAction");
@@ -7,0 +8,0 @@ /**

lib/providers/DynamicCommandLineParser.js

@@ -5,2 +5,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicCommandLineParser = void 0;
 const CommandLineParser_1 = require("./CommandLineParser");
@@ -7,0 +8,0 @@ /**

lib/providers/TabCompletionAction.js

@@ -29,2 +29,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TabCompleteAction = void 0;
 const string_argv_1 = require("string-argv");
@@ -31,0 +32,0 @@ const BaseClasses_1 = require("../parameters/BaseClasses");

package.json

 {
 	"name": "@rushstack/ts-command-line",
-	"version": "4.6.10",
+	"version": "4.7.0",
 	"description": "An object-oriented command-line parser for TypeScript",
@@ -22,4 +22,4 @@ "repository": {
 	"devDependencies": {
-		"@microsoft/rush-stack-compiler-3.5": "0.8.10",
-		"@rushstack/eslint-config": "2.1.1",
+		"@microsoft/rush-stack-compiler-3.9": "0.4.21",
+		"@rushstack/eslint-config": "2.1.2",
 		"@rushstack/heft": "0.8.0",
@@ -26,0 +26,0 @@ "@types/heft-jest": "1.0.1",

README.md

@@ -238,6 +238,8 @@ # ts-command-line
 
-### Further reading
+## Links
 
-The [API reference](https://rushstack.io/pages/api/ts-command-line/) has
-complete documentation for the library.
+- [CHANGELOG.md](
+  https://github.com/microsoft/rushstack/blob/master/libraries/ts-command-line/CHANGELOG.md) - Find
+  out what's new in the latest version
+- [API Reference](https://rushstack.io/pages/api/ts-command-line/)
 
@@ -249,1 +251,3 @@ Here are some real world GitHub projects that illustrate different use cases for **ts-command-line**:
 - [@microsoft/api-documenter](https://www.npmjs.com/package/@microsoft/api-documenter)
+
+`@rushstack/ts-command-line` is part of the [Rush Stack](https://rushstack.io/) family of projects.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

315464

increased by0.93%

Lines of code

4268

increased by0.87%

Number of lines in readme file

252

increased by1.61%

No dependency changes