Skip to content

[Snyk] Upgrade commander from 2.11.0 to 8.0.0 #4

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Snyk] Upgrade commander from 2.11.0 to 8.0.0 #4

wants to merge 1 commit into from

Conversation

@snyk-bot
Copy link

Snyk has created this PR to upgrade commander from 2.11.0 to 8.0.0.

merge advice
ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.

Warning: This is a major version upgrade, and may be a breaking change.

  • The recommended version is 48 versions ahead of your current version.
  • The recommended version was released a month ago, on 2021-06-25.
Release notes
Package name: commander
  • 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();
    $ node trivial.js 
error: missing required argument 'file'

    If you want to show the help in this situation, you could check the arguments before parsing:

    if (process.argv.length === 2)
  program.help();
program.parse();

    Or, you might choose to show the help after any user error:

    program.showHelpAfterError();
  • 8.0.0-2 - 2021-06-06

    Added

    • .showHelpAfterError() to display full help or a custom message after an error (#1534)
    • custom argument processing function also called without action handler (only with action handler in v8.0.0-0) (#1529)

    Changed

    • remove help suggestion from "unknown command" error message (see .showHelpAfteError()) (#1534)
    • Command property .arg initialised to empty array (was previously undefined) (#1529)
  • 8.0.0-1 - 2021-05-31

    Added

    • .addArgument() (#1490)
    • Argument supports .choices() (#1525)
    • client typing of .opts() return type using TypeScript generics (#1539)

    Changed

    • refactor index.tab into a file per class (#1522)
    • update dependencies
  • 8.0.0-0 - 2021-05-22

    Added

    • .getOptionValue() and .setOptionValue() (#1521)
    • .hook() with support for 'preAction' and 'postAction' callbacks (#1514)
    • .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)
    • the number of command-arguments is checked for programs without an action handler (#1502)

    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)

    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)
  • 7.2.0 - 2021-03-21
    Read more
  • 7.1.0 - 2021-02-15
    Read more
  • 7.0.0 - 2021-01-15
    Read more
  • 7.0.0-2 - 2020-12-14
    Read more
  • 7.0.0-1 - 2020-11-21
    Read more
  • 7.0.0-0 - 2020-10-25
  • 6.2.1 - 2020-12-14

    Fixed

    • some tests failed if directory path included a space (1390)
  • 6.2.0 - 2020-10-25
  • 6.1.0 - 2020-08-28
  • 6.0.0 - 2020-07-19
  • 6.0.0-0 - 2020-06-20
  • 5.1.0 - 2020-04-25
  • 5.0.0 - 2020-03-14
  • 5.0.0-4 - 2020-03-03
  • 5.0.0-3 - 2020-02-20
  • 5.0.0-2 - 2020-02-11
  • 5.0.0-1 - 2020-02-08
  • 5.0.0-0 - 2020-02-01
  • 4.1.1 - 2020-02-03
  • 4.1.0 - 2020-01-06
  • 4.0.1 - 2019-11-11
  • 4.0.0 - 2019-11-01
  • 4.0.0-1 - 2019-10-08
  • 4.0.0-0 - 2019-10-01
  • 3.0.2 - 2019-09-26
  • 3.0.1 - 2019-08-30
  • 3.0.0 - 2019-08-09
  • 3.0.0-0 - 2019-07-27
  • 2.20.3 - 2019-10-11
  • 2.20.1 - 2019-09-28
  • 2.20.0 - 2019-04-03
  • 2.19.0 - 2018-10-08
  • 2.18.0 - 2018-09-07
  • 2.17.1 - 2018-08-07
  • 2.17.0 - 2018-08-04
  • 2.16.0 - 2018-06-29
  • 2.15.1 - 2018-03-20
  • 2.15.0 - 2018-03-08
  • 2.14.1 - 2018-02-07
  • 2.14.0 - 2018-02-06
  • 2.13.0 - 2018-01-11
  • 2.12.2 - 2017-11-28
  • 2.12.1 - 2017-11-23
  • 2.12.0 - 2017-11-22
  • 2.11.0 - 2017-07-03
from commander GitHub release notes
Commit messages
Package name: commander

Compare

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

🧐 View latest project report

🛠 Adjust upgrade PR settings

🔕 Ignore this dependency or unsubscribe from future upgrade PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@snyk-bot