Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
commander
Advanced tools
commander - npm Package Compare versions
Comparing version 6.0.0-0 to 6.0.0
124
CHANGELOG.md
@@ -9,4 +9,5 @@ # Changelog | ||
| <!-- markdownlint-disable MD024 --> | ||
| <!-- markdownlint-disable MD004 --> | ||
| ## [6.0.0-0] (2020-06-20) | ||
| ## [6.0.0] (2020-07-21) | ||
@@ -19,2 +20,10 @@ ### Added | ||
| ### Fixed | ||
| - Options which contain -no- in the middle of the option flag should not be treated as negatable. ([#1301]) | ||
| ## [6.0.0-0] (2020-06-20) | ||
| (Released in 6.0.0) | ||
| ## [5.1.0] (2020-04-25) | ||
@@ -211,91 +220,5 @@ | ||
| ## [2.20.1] (2019-09-29) | ||
| ### Fixed | ||
| * Improve tracking of executable subcommands. | ||
| ### Changed | ||
| * update development dependencies | ||
| ## [3.0.2] (2019-09-27) | ||
| ### Fixed | ||
| * Improve tracking of executable subcommands. | ||
| ### Changed | ||
| * update development dependencies | ||
| ## [3.0.1] (2019-08-30) | ||
| ### Added | ||
| * .name and .usage to README ([#1010]) | ||
| * Table of Contents to README ([#1010]) | ||
| * TypeScript definition for `executableFile` in CommandOptions ([#1028]) | ||
| ### Changed | ||
| * consistently use `const` rather than `var` in README ([#1026]) | ||
| ### Fixed | ||
| * help for sub commands with custom executableFile ([#1018]) | ||
| ## [3.0.0] / 2019-08-08 | ||
| * Add option to specify executable file name ([#999]) | ||
| * e.g. `.command('clone', 'clone description', { executableFile: 'myClone' })` | ||
| * Change docs for `.command` to contrast action handler vs git-style executable. ([#938] [#990]) | ||
| * **Breaking** Change TypeScript to use overloaded function for `.command`. ([#938] [#990]) | ||
| * Change to use straight quotes around strings in error messages (like 'this' instead of `this') ([#915]) | ||
| * Add TypeScript "reference types" for node ([#974]) | ||
| * Add support for hyphen as an option argument in subcommands ([#697]) | ||
| * Add support for a short option flag and its value to be concatenated for action handler subcommands ([#599]) | ||
| * e.g. `-p 80` can also be supplied as `-p80` | ||
| * Add executable arguments to spawn in win32, for git-style executables ([#611]) | ||
| * e.g. `node --harmony myCommand.js clone` | ||
| * Add parent command as prefix of subcommand in help ([#980]) | ||
| * Add optional custom description to `.version` ([#963]) | ||
| * e.g. `program.version('0.0.1', '-v, --vers', 'output the current version')` | ||
| * Add `.helpOption(flags, description)` routine to customise help flags and description ([#963]) | ||
| * e.g. `.helpOption('-e, --HELP', 'read more information')` | ||
| * Fix behavior of --no-* options ([#795]) | ||
| * can now define both `--foo` and `--no-foo` | ||
| * **Breaking** custom event listeners: `--no-foo` on cli now emits `option:no-foo` (previously `option:foo`) | ||
| * **Breaking** default value: defining `--no-foo` after defining `--foo` leaves the default value unchanged (previously set it to false) | ||
| * allow boolean default value, such as from environment ([#987]) | ||
| * Increment inspector port for spawned subcommands ([#991]) | ||
| * e.g. `node --inspect myCommand.js clone` | ||
| ### Migration Tips | ||
| The custom event for a negated option like `--no-foo` is `option:no-foo` (previously `option:foo`). | ||
| ```js | ||
| program | ||
| .option('--no-foo') | ||
| .on('option:no-foo', () => { | ||
| console.log('removing foo'); | ||
| }); | ||
| ``` | ||
| When using TypeScript, adding a command does not allow an explicit `undefined` for an unwanted executable description (e.g | ||
| for a command with an action handler). | ||
| ```js | ||
| program | ||
| .command('action1', undefined, { noHelp: true }) // No longer valid | ||
| .command('action2', { noHelp: true }) // Correct | ||
| ``` | ||
| ## 3.0.0-0 Prerelease / 2019-07-28 | ||
| (Released as 3.0.0) | ||
| ## Older versions | ||
| * [3.x](./changelogs/CHANGELOG-3.md) | ||
| * [2.x](./changelogs/CHANGELOG-2.md) | ||
@@ -310,30 +233,12 @@ * [1.x](./changelogs/CHANGELOG-1.md) | ||
| [#531]: https://github.com/tj/commander.js/issues/531 | ||
| [#599]: https://github.com/tj/commander.js/issues/599 | ||
| [#611]: https://github.com/tj/commander.js/issues/611 | ||
| [#645]: https://github.com/tj/commander.js/issues/645 | ||
| [#697]: https://github.com/tj/commander.js/issues/697 | ||
| [#742]: https://github.com/tj/commander.js/issues/742 | ||
| [#764]: https://github.com/tj/commander.js/issues/764 | ||
| [#795]: https://github.com/tj/commander.js/issues/795 | ||
| [#802]: https://github.com/tj/commander.js/issues/802 | ||
| [#806]: https://github.com/tj/commander.js/issues/806 | ||
| [#809]: https://github.com/tj/commander.js/issues/809 | ||
| [#915]: https://github.com/tj/commander.js/issues/915 | ||
| [#938]: https://github.com/tj/commander.js/issues/938 | ||
| [#948]: https://github.com/tj/commander.js/issues/948 | ||
| [#962]: https://github.com/tj/commander.js/issues/962 | ||
| [#963]: https://github.com/tj/commander.js/issues/963 | ||
| [#974]: https://github.com/tj/commander.js/issues/974 | ||
| [#980]: https://github.com/tj/commander.js/issues/980 | ||
| [#987]: https://github.com/tj/commander.js/issues/987 | ||
| [#990]: https://github.com/tj/commander.js/issues/990 | ||
| [#991]: https://github.com/tj/commander.js/issues/991 | ||
| [#993]: https://github.com/tj/commander.js/issues/993 | ||
| [#995]: https://github.com/tj/commander.js/issues/995 | ||
| [#999]: https://github.com/tj/commander.js/issues/999 | ||
| [#1010]: https://github.com/tj/commander.js/pull/1010 | ||
| [#1018]: https://github.com/tj/commander.js/pull/1018 | ||
| [#1026]: https://github.com/tj/commander.js/pull/1026 | ||
| [#1027]: https://github.com/tj/commander.js/pull/1027 | ||
| [#1028]: https://github.com/tj/commander.js/pull/1028 | ||
| [#1032]: https://github.com/tj/commander.js/issues/1032 | ||
@@ -382,4 +287,7 @@ [#1035]: https://github.com/tj/commander.js/pull/1035 | ||
| [#1275]: https://github.com/tj/commander.js/pull/1275 | ||
| [#1301]: https://github.com/tj/commander.js/issues/1301 | ||
| [Unreleased]: https://github.com/tj/commander.js/compare/master...develop | ||
| [6.0.0]: https://github.com/tj/commander.js/compare/v5.1.0..v6.0.0 | ||
| [6.0.0-0]: https://github.com/tj/commander.js/compare/v5.1.0..v6.0.0-0 | ||
| [5.1.0]: https://github.com/tj/commander.js/compare/v5.0.0..v5.1.0 | ||
@@ -398,5 +306,1 @@ [5.0.0]: https://github.com/tj/commander.js/compare/v4.1.1..v5.0.0 | ||
| [4.0.0-0]: https://github.com/tj/commander.js/compare/v3.0.2...v4.0.0-0 | ||
| [3.0.2]: https://github.com/tj/commander.js/compare/v3.0.1...v3.0.2 | ||
| [3.0.1]: https://github.com/tj/commander.js/compare/v3.0.0...v3.0.1 | ||
| [3.0.0]: https://github.com/tj/commander.js/compare/v2.20.1...v3.0.0 | ||
| [2.20.1]: https://github.com/tj/commander.js/compare/v2.20.0...v2.20.1 |
| { | ||
| "name": "commander", | ||
| "version": "6.0.0-0", | ||
| "version": "6.0.0", | ||
| "description": "the complete solution for node.js command-line programs", | ||
@@ -34,11 +34,11 @@ "keywords": [ | ||
| "devDependencies": { | ||
| "@types/jest": "^25.2.1", | ||
| "@types/node": "^12.12.38", | ||
| "@typescript-eslint/eslint-plugin": "^2.31.0", | ||
| "@types/jest": "^26.0.5", | ||
| "@types/node": "^14.0.23", | ||
| "@typescript-eslint/eslint-plugin": "^2.34.0", | ||
| "eslint": "^6.8.0", | ||
| "eslint-config-standard-with-typescript": "^16.0.0", | ||
| "eslint-plugin-jest": "^23.10.0", | ||
| "jest": "^26.0.1", | ||
| "standard": "^14.3.3", | ||
| "typescript": "^3.7.5" | ||
| "eslint-plugin-jest": "^23.18.0", | ||
| "jest": "^26.1.0", | ||
| "standard": "^14.3.4", | ||
| "typescript": "^3.9.7" | ||
| }, | ||
@@ -45,0 +45,0 @@ "typings": "typings/index.d.ts", |
@@ -41,2 +41,3 @@ # Commander.js | ||
| - [createCommand()](#createcommand) | ||
| - [Import into ECMAScript Module](#import-into-ecmascript-module) | ||
| - [Node options such as `--harmony`](#node-options-such-as---harmony) | ||
@@ -684,2 +685,13 @@ - [Debugging stand-alone executable subcommands](#debugging-stand-alone-executable-subcommands) | ||
| ### Import into ECMAScript Module | ||
| Commander is currently a CommonJS package, and the default export can be imported into an ES Module: | ||
| ```js | ||
| // index.mjs | ||
| import commander from 'commander'; | ||
| const program = commander.program; | ||
| const newCommand = new commander.Command(); | ||
| ``` | ||
| ### Node options such as `--harmony` | ||
@@ -764,3 +776,3 @@ | ||
| Commander 5.x is fully supported on Long Term Support versions of Node, and is likely to work with Node 6 but not tested. | ||
| The current version of Commander is fully supported on Long Term Support versions of Node, and is likely to work with Node 6 but not tested. | ||
| (For versions of Node below Node 6, use Commander 3.x or 2.x.) | ||
@@ -767,0 +779,0 @@ |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Number of low quality alerts
- decreased by-50%
1
- Number of lines in readme file
- increased by1.55%
784
Worsened metrics
- Total package byte prevSize
- decreased by-3.04%
108036
No dependency changes