Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump commander from 7.2.0 to 8.0.0 #198

Merged
merged 1 commit into from Jun 28, 2021

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented Jun 28, 2021

Bumps commander from 7.2.0 to 8.0.0.

Release notes

Sourced from commander's releases.

v8.0.0

Added

  • .argument(name, description) for adding command-arguments (#1490)
    • supports default value for optional command-arguments (#1508)
    • supports custom processing function (#1508)
  • .createArgument() factory method (#1497)
  • .addArgument() (#1490)
  • Argument supports .choices() (#1525)
  • .showHelpAfterError() to display full help or a custom message after an error (#1534)
  • .hook() with support for 'preAction' and 'postAction' callbacks (#1514)
  • client typing of .opts() return type using TypeScript generics (#1539)
  • the number of command-arguments is checked for programs without an action handler (#1502)
  • .getOptionValue() and .setOptionValue() (#1521)

Changed

  • refactor and simplify TypeScript declarations (with no default export) (#1520)
  • .parseAsync() is now declared as async (#1513)
  • Breaking: Help method .visibleArguments() returns array of Argument (#1490)
  • Breaking: Commander 8 requires Node.js 12 or higher (#1500)
  • Breaking: CommanderError code commander.invalidOptionArgument renamed commander.invalidArgument (#1508)
  • Breaking: TypeScript declaration for .addTextHelp() callback no longer allows result of undefined, now just string (#1516)
  • refactor index.tab into a file per class (#1522)
  • remove help suggestion from "unknown command" error message (see .showHelpAfteError()) (#1534)
  • Command property .arg initialised to empty array (was previously undefined) (#1529)
  • update dependencies

Deprecated

  • second parameter of cmd.description(desc, argDescriptions) for adding argument descriptions (#1490)
    • (use new .argument(name, description) instead)
  • InvalidOptionArgumentError (replaced by InvalidArgumentError) (#1508)

Removed

  • Breaking: TypeScript declaration for default export of global Command object (#1520)
    • (still available as named program export)

Migration Tips

If you have a simple program without an action handler, you will now get an error if there are missing command-arguments.

program
  .option('-d, --debug')
  .arguments('<file>');
program.parse();

... (truncated)

Changelog

Sourced from commander's changelog.

[8.0.0] (2021-06-25)

Added

  • .argument(name, description) for adding command-arguments (#1490)
    • supports default value for optional command-arguments (#1508)
    • supports custom processing function (#1508)
  • .createArgument() factory method (#1497)
  • .addArgument() (#1490)
  • Argument supports .choices() (#1525)
  • .showHelpAfterError() to display full help or a custom message after an error (#1534)
  • .hook() with support for 'preAction' and 'postAction' callbacks (#1514)
  • client typing of .opts() return type using TypeScript generics (#1539)
  • the number of command-arguments is checked for programs without an action handler (#1502)
  • .getOptionValue() and .setOptionValue() (#1521)

Changed

  • refactor and simplify TypeScript declarations (with no default export) (#1520)
  • .parseAsync() is now declared as async (#1513)
  • Breaking: Help method .visibleArguments() returns array of Argument (#1490)
  • Breaking: Commander 8 requires Node.js 12 or higher (#1500)
  • Breaking: CommanderError code commander.invalidOptionArgument renamed commander.invalidArgument (#1508)
  • Breaking: TypeScript declaration for .addTextHelp() callback no longer allows result of undefined, now just string (#1516)
  • refactor index.tab into a file per class (#1522)
  • remove help suggestion from "unknown command" error message (see .showHelpAfteError()) (#1534)
  • Command property .arg initialised to empty array (was previously undefined) (#1529)
  • update dependencies

Deprecated

  • second parameter of cmd.description(desc, argDescriptions) for adding argument descriptions (#1490)
    • (use new .argument(name, description) instead)
  • InvalidOptionArgumentError (replaced by InvalidArgumentError) (#1508)

Removed

  • Breaking: TypeScript declaration for default export of global Command object (#1520)
    • (still available as named program export)

Migration Tips

If you have a simple program without an action handler, you will now get an error if there are missing command-arguments.

program
  .option('-d, --debug')
  .arguments('<file>');
program.parse();
</tr></table> 

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [commander](https://github.com/tj/commander.js) from 7.2.0 to 8.0.0.
- [Release notes](https://github.com/tj/commander.js/releases)
- [Changelog](https://github.com/tj/commander.js/blob/master/CHANGELOG.md)
- [Commits](tj/commander.js@v7.2.0...v8.0.0)

---
updated-dependencies:
- dependency-name: commander
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies javascript labels Jun 28, 2021
@DavidAnson DavidAnson merged commit 596386e into master Jun 28, 2021
12 checks passed
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/commander-8.0.0 branch Jun 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies javascript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant