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

refactor: Upgrade commander from 12.1.0 to 13.0.0 #9592

Conversation

parseplatformorg
Copy link
Contributor

snyk-top-banner

Snyk has created this PR to upgrade commander from 12.1.0 to 13.0.0.

ℹ️ 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 PR contains major version upgrade(s), and may be a breaking change.

  • The recommended version is 2 versions ahead of your current version.

  • The recommended version was released a month ago.

Release notes
Package name: commander
  • 13.0.0 - 2024-12-30

    Added

    • support multiple calls to .parse() with default settings (#2299)
    • add .saveStateBeforeParse() and .restoreStateBeforeParse() for use by subclasses (#2299)
    • style routines like styleTitle() to add color to help using .configureHelp() or Help subclass (#2251)
    • color related support in .configureOutput() for getOutHasColors(), getErrHasColors(), and stripColor() (#2251)
    • Help property for minWidthToWrap (#2251)
    • Help methods for displayWidth(), boxWrap(), preformatted() et al (#2251)

    Changed

    • Breaking: excess command-arguments cause an error by default, see migration tips (#2223)
    • Breaking: throw during Option construction for unsupported option flags, like multiple characters after single - (#2270)
    • Breaking: throw on multiple calls to .parse() if storeOptionsAsProperties: true (#2299)
    • TypeScript: include implicit this in parameters for action handler callback (#2197)

    Deleted

    • Breaking: Help.wrap() refactored into formatItem() and boxWrap() (#2251)

    Migration Tips

    Excess command-arguments

    It is now an error for the user to specify more command-arguments than are expected. (allowExcessArguments is now false by default.)

    Old code:

    program.option('-p, --port <number>', 'port number');
    program.action((options) => {
      console.log(program.args);
    });

    Now shows an error:

    $ node example.js a b c
    error: too many arguments. Expected 0 arguments but got 3.

    You can declare the expected arguments. The help will then be more accurate too. Note that declaring
    new arguments will change what is passed to the action handler.

    program.option('-p, --port <number>', 'port number');
    program.argument('[args...]', 'remote command and arguments'); // expecting zero or more arguments
    program.action((args, options) => {
      console.log(args);
    });

    Or you could suppress the error, useful for minimising changes in legacy code.

    program.option('-p, --port', 'port number');
    program.allowExcessArguments();
    program.action((options) => {
      console.log(program.args);
    });
  • 13.0.0-0 - 2024-12-06

    Added

    • style routines like styleTitle() to add color to help using .configureHelp() or Help subclass (#2251)
    • color related support in .configureOutput() for getOutHasColors(), getErrHasColors(), and stripColor() (#2251)
    • Help property for minWidthToWrap (#2251)
    • Help methods for displayWidth(), boxWrap(), preformatted() et al (#2251)

    Changed

    • Breaking: excess command-arguments cause an error by default, see migration tips (#2223)
    • Breaking: throw during Option construction for unsupported option flags, like multiple characters after single - (#2270)
    • TypeScript: include implicit this in parameters for action handler callback (#2197)

    Deleted

    • Breaking: Help.wrap() refactored into formatItem() and boxWrap() (#2251)

    Migration Tips

    Excess command-arguments

    It is now an error for the user to specify more command-arguments than are expected. (allowExcessArguments is now false by default.)

    Old code:

    program.option('-p, --port <number>', 'port number');
    program.action((options) => {
      console.log(program.args);
    });

    Now shows an error:

    $ node example.js a b c
    error: too many arguments. Expected 0 arguments but got 3.

    You can declare the expected arguments. The help will then be more accurate too. Note that declaring
    new arguments will change what is passed to the action handler.

    program.option('-p, --port <number>', 'port number');
    program.argument('[args...]', 'remote command and arguments'); // expecting zero or more arguments
    program.action((args, options) => {
      console.log(args);
    });

    Or you could suppress the error, useful for minimising changes in legacy code.

    program.option('-p, --port', 'port number');
    program.allowExcessArguments();
    program.action((options) => {
      console.log(program.args);
    });
  • 12.1.0 - 2024-05-18

    Added

    • auto-detect special node flags node --eval and node --print when call .parse() with no arguments (#2164)

    Changed

    • prefix require of Node.js core modules with node: (#2170)
    • format source files with Prettier (#2180)
    • switch from StandardJS to directly calling ESLint for linting (#2153)
    • extend security support for previous major version of Commander (#2150)

    Removed

    • removed unimplemented Option.fullDescription from TypeScript definition (#2191)
from commander GitHub release notes

Important

  • Warning: This PR contains a major version upgrade, and may be a breaking change.
  • Check the changes in this PR to ensure they won't cause issues with your project.
  • This PR was automatically created by Snyk using the credentials of a real user.

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:

Snyk has created this PR to upgrade commander from 12.1.0 to 13.0.0.

See this package in npm:
commander

See this project in Snyk:
https://app.snyk.io/org/acinader/project/fe36ba29-7b23-4655-9807-441cf85f2203?utm_source=github&utm_medium=referral&page=upgrade-pr
Copy link

I will reformat the title to use the proper commit message syntax.

@parse-github-assistant parse-github-assistant bot changed the title [Snyk] Upgrade commander from 12.1.0 to 13.0.0 refactor: Upgrade commander from 12.1.0 to 13.0.0 Feb 5, 2025
Copy link

Thanks for opening this pull request!

  • ❌ Please link an issue that describes the reason for this pull request, otherwise your pull request will be closed. Make sure to write it as Closes: #123 in the PR description, so I can recognize it.

@mtrezza mtrezza closed this Feb 5, 2025
@mtrezza mtrezza deleted the snyk-upgrade-e5e2c3e2063ccd792304b6998e8b3dd8 branch February 5, 2025 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants