@rushstack/ts-command-line 4.9.1

package/CHANGELOG.md

@@ -0,0 +1,704 @@
+# Change Log - @rushstack/ts-command-line
+
+This log was last generated on Thu, 23 Sep 2021 00:10:41 GMT and should not be manually modified.
+
+## 4.9.1
+Thu, 23 Sep 2021 00:10:41 GMT
+
+### Patches
+
+- Upgrade the `@types/node` dependency to version to version 12.
+
+## 4.9.0
+Fri, 20 Aug 2021 15:08:10 GMT
+
+### Minor changes
+
+- Add getParameterStringMap to CommandLineParameterProvider, to easily query parameter usage for telemetry
+
+## 4.8.1
+Mon, 12 Jul 2021 23:08:26 GMT
+
+_Version update only_
+
+## 4.8.0
+Thu, 01 Jul 2021 15:08:27 GMT
+
+### Minor changes
+
+- Add ChoiceList and IntegerList parameter types
+
+## 4.7.10
+Mon, 12 Apr 2021 15:10:28 GMT
+
+_Version update only_
+
+## 4.7.9
+Tue, 06 Apr 2021 15:14:22 GMT
+
+_Version update only_
+
+## 4.7.8
+Thu, 10 Dec 2020 23:25:49 GMT
+
+_Version update only_
+
+## 4.7.7
+Wed, 11 Nov 2020 01:08:59 GMT
+
+_Version update only_
+
+## 4.7.6
+Fri, 30 Oct 2020 06:38:39 GMT
+
+_Version update only_
+
+## 4.7.5
+Fri, 30 Oct 2020 00:10:14 GMT
+
+_Version update only_
+
+## 4.7.4
+Wed, 28 Oct 2020 01:18:03 GMT
+
+_Version update only_
+
+## 4.7.3
+Tue, 06 Oct 2020 00:24:06 GMT
+
+_Version update only_
+
+## 4.7.2
+Mon, 05 Oct 2020 22:36:57 GMT
+
+_Version update only_
+
+## 4.7.1
+Wed, 30 Sep 2020 18:39:17 GMT
+
+### Patches
+
+- Update to build with @rushstack/heft-node-rig
+
+## 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
+Tue, 22 Sep 2020 05:45:57 GMT
+
+_Version update only_
+
+## 4.6.9
+Tue, 22 Sep 2020 01:45:31 GMT
+
+_Version update only_
+
+## 4.6.8
+Tue, 22 Sep 2020 00:08:53 GMT
+
+_Version update only_
+
+## 4.6.7
+Sat, 19 Sep 2020 04:37:27 GMT
+
+_Version update only_
+
+## 4.6.6
+Sat, 19 Sep 2020 03:33:07 GMT
+
+_Version update only_
+
+## 4.6.5
+Fri, 18 Sep 2020 22:57:24 GMT
+
+_Version update only_
+
+## 4.6.4
+Thu, 27 Aug 2020 11:27:06 GMT
+
+_Version update only_
+
+## 4.6.3
+Mon, 24 Aug 2020 07:35:20 GMT
+
+_Version update only_
+
+## 4.6.2
+Sat, 22 Aug 2020 05:55:43 GMT
+
+_Version update only_
+
+## 4.6.1
+Fri, 21 Aug 2020 01:21:17 GMT
+
+### Patches
+
+- Fix an issue where usage of a parameter specified undocumentedSynonyms yielded invalid data.
+
+## 4.6.0
+Thu, 20 Aug 2020 15:13:52 GMT
+
+### Minor changes
+
+- Add a feature for specifying "undocumented synonyms" for parameters.
+
+## 4.5.0
+Tue, 18 Aug 2020 23:59:42 GMT
+
+### Minor changes
+
+- Add support for shell tab completion.
+
+## 4.4.8
+Mon, 17 Aug 2020 04:53:23 GMT
+
+_Version update only_
+
+## 4.4.7
+Wed, 12 Aug 2020 00:10:05 GMT
+
+### Patches
+
+- Updated project to build with Heft
+
+## 4.4.6
+Fri, 03 Jul 2020 05:46:41 GMT
+
+### Patches
+
+- Improve formatting of errors reported by CommandLineParser.execute()
+
+## 4.4.5
+Thu, 25 Jun 2020 06:43:35 GMT
+
+_Version update only_
+
+## 4.4.4
+Wed, 24 Jun 2020 09:50:48 GMT
+
+_Version update only_
+
+## 4.4.3
+Wed, 24 Jun 2020 09:04:28 GMT
+
+_Version update only_
+
+## 4.4.2
+Mon, 01 Jun 2020 08:34:17 GMT
+
+### Patches
+
+- Fix a typo in the supplementary notes for parameters with environment variable mappings
+
+## 4.4.1
+Wed, 27 May 2020 05:15:10 GMT
+
+_Version update only_
+
+## 4.4.0
+Fri, 15 May 2020 08:10:59 GMT
+
+### Minor changes
+
+- Add a new feature defineCommandLineRemainder() which allows additional unvalidated CLI arguments, e.g. to pass along to another tool
+- Add the ability for an environment variable to specify multiple values for CommandLineStringListParameter, encoded as a JSON array
+- Fix some bugs that prevented a CommandLineParser from being defined without any actions
+
+### Patches
+
+- Fix a bug with environmentVariable mapping for CommandLineFlagParameter
+- Use API Extractor to trim internal APIs from the .d.ts rollup
+- Improve the README.md and API documentation
+
+## 4.3.14
+Wed, 08 Apr 2020 04:07:33 GMT
+
+_Version update only_
+
+## 4.3.13
+Sat, 28 Mar 2020 00:37:16 GMT
+
+_Version update only_
+
+## 4.3.12
+Wed, 18 Mar 2020 15:07:47 GMT
+
+### Patches
+
+- Upgrade cyclic dependencies
+
+## 4.3.11
+Tue, 17 Mar 2020 23:55:58 GMT
+
+### Patches
+
+- PACKAGE NAME CHANGE: The NPM scope was changed from `@microsoft/ts-command-line` to `@rushstack/ts-command-line`
+
+## 4.3.10
+Tue, 21 Jan 2020 21:56:14 GMT
+
+_Version update only_
+
+## 4.3.9
+Sun, 19 Jan 2020 02:26:52 GMT
+
+### Patches
+
+- Upgrade Node typings to Node 10
+
+## 4.3.8
+Fri, 17 Jan 2020 01:08:23 GMT
+
+_Version update only_
+
+## 4.3.7
+Thu, 09 Jan 2020 06:44:13 GMT
+
+_Version update only_
+
+## 4.3.6
+Wed, 08 Jan 2020 00:11:31 GMT
+
+_Version update only_
+
+## 4.3.5
+Mon, 11 Nov 2019 16:07:56 GMT
+
+_Version update only_
+
+## 4.3.4
+Tue, 22 Oct 2019 06:24:44 GMT
+
+_Version update only_
+
+## 4.3.3
+Fri, 18 Oct 2019 15:15:00 GMT
+
+### Patches
+
+- Fix Choice parameter error when only one alternative value is provided
+
+## 4.3.2
+Sun, 29 Sep 2019 23:56:29 GMT
+
+### Patches
+
+- Update repository URL
+
+## 4.3.1
+Tue, 24 Sep 2019 02:58:49 GMT
+
+### Patches
+
+- Add back a missing dependency.
+
+## 4.3.0
+Mon, 23 Sep 2019 15:14:55 GMT
+
+### Minor changes
+
+- Remove unnecessary dependencies on @types/argparse and @types/node
+
+## 4.2.8
+Tue, 10 Sep 2019 22:32:23 GMT
+
+### Patches
+
+- Update documentation
+
+## 4.2.7
+Mon, 12 Aug 2019 15:15:14 GMT
+
+### Patches
+
+- fix for #1443 allow rush command to use numbers
+
+## 4.2.6
+Wed, 12 Jun 2019 19:12:33 GMT
+
+### Patches
+
+- Update Readme.
+
+## 4.2.5
+Mon, 27 May 2019 04:13:44 GMT
+
+### Patches
+
+- Fix a broken link in the README.md (GitHub issue #1285)
+
+## 4.2.4
+Mon, 06 May 2019 20:46:21 GMT
+
+### Patches
+
+- Allow colons in command line action names
+
+## 4.2.3
+Fri, 07 Dec 2018 17:04:56 GMT
+
+### Patches
+
+- Updated to use the new InternalError class for reporting software defects
+
+## 4.2.2
+Thu, 06 Sep 2018 01:25:26 GMT
+
+### Patches
+
+- Update "repository" field in package.json
+
+## 4.2.1
+Thu, 23 Aug 2018 18:18:53 GMT
+
+### Patches
+
+- Republish all packages in web-build-tools to resolve GitHub issue #782
+
+## 4.2.0
+Fri, 08 Jun 2018 08:43:52 GMT
+
+### Minor changes
+
+- Add CommandLineChoiceParameter.appendToArgList() and CommandLineParser.tryGetAction()
+
+## 4.1.0
+Fri, 27 Apr 2018 03:04:32 GMT
+
+### Minor changes
+
+- Add "defaultValue", "environmentVariable", and "required" features for command-line parameters
+
+## 4.0.0
+Thu, 19 Apr 2018 21:25:56 GMT
+
+### Breaking changes
+
+- Rename "CommandLineOptionParameter" to "CommandLineChoiceParameter" (API change)
+- Rename "ICommandLineChoiceDefinition.options" to "alternatives" (API change)
+- Add DynamicCommandLineAction, DynamicCommandLineParser, and other APIs to support defining and reading command-line parameters at runtime
+- Rename "actionVerb" to "actionName" (API change)
+- Replace "CommandLineAction.options" with more concise top-level properties (API change)
+
+## 3.1.1
+Fri, 23 Mar 2018 00:34:53 GMT
+
+### Patches
+
+- Upgrade colors to version ~1.2.1
+
+## 3.1.0
+Thu, 15 Mar 2018 20:00:50 GMT
+
+### Minor changes
+
+- Add default error handler so the caller to CommandLineParser.execute() is not expected to handle promise rejections
+- Add a new API "CommandLineParser.executeWithoutErrorHandling()"
+
+## 3.0.7
+Mon, 12 Mar 2018 20:36:19 GMT
+
+### Patches
+
+- Locked down some "@types/" dependency versions to avoid upgrade conflicts
+
+## 3.0.6
+Fri, 02 Mar 2018 01:13:59 GMT
+
+_Version update only_
+
+## 3.0.5
+Tue, 27 Feb 2018 22:05:57 GMT
+
+_Version update only_
+
+## 3.0.4
+Wed, 21 Feb 2018 22:04:19 GMT
+
+_Version update only_
+
+## 3.0.3
+Wed, 21 Feb 2018 03:13:28 GMT
+
+_Version update only_
+
+## 3.0.2
+Sat, 17 Feb 2018 02:53:49 GMT
+
+_Version update only_
+
+## 3.0.1
+Fri, 16 Feb 2018 22:05:23 GMT
+
+_Version update only_
+
+## 3.0.0
+Fri, 16 Feb 2018 17:05:11 GMT
+
+### Breaking changes
+
+- Change all CommandLineActions to have an asychronous API that returns a promise.
+
+## 2.3.10
+Wed, 07 Feb 2018 17:05:11 GMT
+
+_Version update only_
+
+## 2.3.9
+Fri, 26 Jan 2018 22:05:30 GMT
+
+_Version update only_
+
+## 2.3.8
+Fri, 26 Jan 2018 17:53:38 GMT
+
+### Patches
+
+- Force a patch bump in case the previous version was an empty package
+
+## 2.3.7
+Fri, 26 Jan 2018 00:36:51 GMT
+
+_Version update only_
+
+## 2.3.6
+Tue, 23 Jan 2018 17:05:28 GMT
+
+_Version update only_
+
+## 2.3.5
+Thu, 18 Jan 2018 03:23:46 GMT
+
+### Patches
+
+- Enable package typings generated by api-extractor
+
+## 2.3.4
+Thu, 18 Jan 2018 00:48:06 GMT
+
+_Version update only_
+
+## 2.3.3
+Wed, 17 Jan 2018 10:49:31 GMT
+
+_Version update only_
+
+## 2.3.2
+Fri, 12 Jan 2018 03:35:22 GMT
+
+_Version update only_
+
+## 2.3.1
+Thu, 11 Jan 2018 22:31:51 GMT
+
+_Version update only_
+
+## 2.3.0
+Wed, 10 Jan 2018 20:40:01 GMT
+
+### Minor changes
+
+- Upgrade to Node 8
+
+## 2.2.14
+Tue, 09 Jan 2018 17:05:51 GMT
+
+### Patches
+
+- Get web-build-tools building with pnpm
+
+## 2.2.13
+Sun, 07 Jan 2018 05:12:08 GMT
+
+_Version update only_
+
+## 2.2.12
+Fri, 05 Jan 2018 20:26:45 GMT
+
+_Version update only_
+
+## 2.2.11
+Fri, 05 Jan 2018 00:48:42 GMT
+
+_Version update only_
+
+## 2.2.10
+Fri, 22 Dec 2017 17:04:46 GMT
+
+_Version update only_
+
+## 2.2.9
+Tue, 12 Dec 2017 03:33:27 GMT
+
+_Version update only_
+
+## 2.2.8
+Thu, 30 Nov 2017 23:59:09 GMT
+
+_Version update only_
+
+## 2.2.7
+Thu, 30 Nov 2017 23:12:21 GMT
+
+_Version update only_
+
+## 2.2.6
+Wed, 29 Nov 2017 17:05:37 GMT
+
+_Version update only_
+
+## 2.2.5
+Tue, 28 Nov 2017 23:43:55 GMT
+
+_Version update only_
+
+## 2.2.4
+Mon, 13 Nov 2017 17:04:50 GMT
+
+_Version update only_
+
+## 2.2.3
+Mon, 06 Nov 2017 17:04:18 GMT
+
+_Version update only_
+
+## 2.2.2
+Thu, 02 Nov 2017 16:05:24 GMT
+
+### Patches
+
+- lock the reference version between web build tools projects
+
+## 2.2.1
+Wed, 01 Nov 2017 21:06:08 GMT
+
+### Patches
+
+- Upgrade cyclic dependencies
+
+## 2.2.0
+Tue, 31 Oct 2017 21:04:04 GMT
+
+### Minor changes
+
+- Add ability to specify default value for enum options.
+
+## 2.1.4
+Tue, 31 Oct 2017 16:04:55 GMT
+
+_Version update only_
+
+## 2.1.3
+Wed, 25 Oct 2017 20:03:59 GMT
+
+_Version update only_
+
+## 2.1.2
+Tue, 24 Oct 2017 18:17:12 GMT
+
+_Version update only_
+
+## 2.1.1
+Mon, 23 Oct 2017 21:53:12 GMT
+
+### Patches
+
+- Updated cyclic dependencies
+
+## 2.1.0
+Fri, 22 Sep 2017 01:04:02 GMT
+
+### Minor changes
+
+- Upgrade to es6
+
+## 2.0.7
+Fri, 08 Sep 2017 01:28:04 GMT
+
+### Patches
+
+- Deprecate @types/es6-coll ections in favor of built-in typescript typings 'es2015.collection' a nd 'es2015.iterable'
+
+## 2.0.6
+Thu, 31 Aug 2017 18:41:18 GMT
+
+_Version update only_
+
+## 2.0.5
+Wed, 30 Aug 2017 01:04:34 GMT
+
+_Version update only_
+
+## 2.0.4
+Tue, 22 Aug 2017 13:04:22 GMT
+
+_Version update only_
+
+## 2.0.3
+Tue, 25 Jul 2017 20:03:31 GMT
+
+### Patches
+
+- Upgrade to TypeScript 2.4
+
+## 2.0.2
+Fri, 23 Jun 2017 20:05:07 GMT
+
+### Patches
+
+- Initial open source release of this library
+
+## 2.0.1
+Thu, 25 May 2017 21:09:42 GMT
+
+### Patches
+
+- Dependency version change
+
+## 2.0.0
+Fri, 17 Feb 2017 23:09:23 GMT
+
+### Breaking changes
+
+- General availability
+
+### Minor changes
+
+- Added a "option" parameter, which can limit the input to a list of possible strings.
+- Added the ability to give custom names to keys in the help menu.
+
+### Patches
+
+- Locked version numbers for @types packages
+- Updated .npmignore
+
+## 1.1.1
+Tue, 06 Dec 2016 20:44:26 GMT
+
+### Patches
+
+- Changes for RC0 release.
+
+## 1.2.0
+
+_Version update only_
+
+## 1.1.0
+
+### Minor changes
+
+- Introduces a new command line argument type for a list of strings
+- Introduces a new command line argument type for integers
+
+## 1.0.1
+
+_Initial release_
+

package/LICENSE

@@ -0,0 +1,24 @@
+@rushstack/ts-command-line
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.