search

nodeshift / faas-js-runtime

A function invocation framework for Node.js and TypeScript
Apache License 2.0
15 stars 19 forks source link

[Snyk] Upgrade commander from 11.0.0 to 12.0.0 #343

Closed lholmquist closed 5 months ago

lholmquist commented 9 months ago

This PR was automatically created by Snyk using the credentials of a real user.


Snyk has created this PR to upgrade commander from 11.0.0 to 12.0.0.

:information_source: 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 **4 versions** ahead of your current version. - The recommended version was released **a month ago**, on 2024-02-03.
Release notes
Package name: commander
  • 12.0.0 - 2024-02-03

    Added

    • .addHelpOption() as another way of configuring built-in help option (#2006)
    • .helpCommand() for configuring built-in help command (#2087)

    Fixed

    • Breaking: use non-zero exit code when spawned executable subcommand terminates due to a signal (#2023)
    • Breaking: check passThroughOptions constraints when using .addCommand and throw if parent command does not have .enablePositionalOptions() enabled (#1937)

    Changed

    • Breaking: Commander 12 requires Node.js v18 or higher (#2027)
    • Breaking: throw an error if add an option with a flag which is already in use (#2055)
    • Breaking: throw an error if add a command with name or alias which is already in use (#2059)
    • Breaking: throw error when calling .storeOptionsAsProperties() after setting an option value (#1928)
    • replace non-standard JSDoc of @ api private with documented @ private (#1949)
    • .addHelpCommand() now takes a Command (passing string or boolean still works as before but deprecated) (#2087)
    • refactor internal implementation of built-in help option (#2006)
    • refactor internal implementation of built-in help command (#2087)

    Deprecated

    • .addHelpCommand() passing string or boolean (use .helpCommand() or pass a Command) (#2087)

    Removed

    • Breaking: removed default export of a global Command instance from CommonJS (use the named program export instead) (#2017)

    Migration Tips

    global program

    If you are using the deprecated default import of the global Command object, you need to switch to using a named import (or create a new Command).

    // const program = require('commander');
const { program } = require('commander');

    option and command clashes

    A couple of configuration problems now throw an error, which will pick up issues in existing programs:

    • adding an option which uses the same flag as a previous option
    • adding a command which uses the same name or alias as a previous command
  • 12.0.0-1 - 2024-01-19

    Added

    • .addHelpOption() as another way of configuring built-in help option (#2006)
    • .helpCommand() for configuring built-in help command (#2087)

    Changed

    • .addHelpCommand() now takes a Command (passing string or boolean still works as before but deprecated) (#2087)
    • refactor internal implementation of built-in help option (#2006)
    • refactor internal implementation of built-in help command (#2087)

    Deprecated

    • .addHelpCommand() passing string or boolean (use .helpCommand() or pass a Command) (#2087)
  • 12.0.0-0 - 2023-11-11

    Fixed

    • Breaking: use non-zero exit code when spawned executable subcommand terminates due to a signal (#2023)
    • Breaking: check passThroughOptions constraints when using .addCommand and throw if parent command does not have .enablePositionalOptions() enabled (#1937)

    Changed

    • Breaking: Commander 12 requires Node.js v18 or higher (#2027)
    • Breaking: throw an error if add an option with a flag which is already in use (#2055)
    • Breaking: throw an error if add a command with name or alias which is already in use (#2059)
    • Breaking: throw error when calling .storeOptionsAsProperties() after setting an option value (#1928)
    • replace non-standard JSDoc of @ api private with documented @ private (#1949)

    Removed

    • Breaking: removed default export of a global Command instance from CommonJS (use the named program export instead) (#2017)

    Migration Tips

    global program

    If you are using the deprecated default import of the global Command object, you need to switch to using a named import (or create a new Command).

    // const program = require('commander');
const { program } = require('commander');

    option and command clashes

    A couple of configuration problems now throw an error, which will pick up issues in existing programs:

    • adding an option which uses the same flag as a previous option
    • adding a command which uses the same name or alias as a previous command
  • 11.1.0 - 2023-10-13

    Fixed

    • TypeScript: update OptionValueSource to allow any string, to match supported use of custom sources (#1983)
    • TypeScript: add that Command.version() can also be used as getter (#1982)
    • TypeScript: add null return type to Commands.executableDir(), for when not configured (#1965)
    • subcommands with an executable handler and only a short help flag are now handled correctly by the parent's help command (#1930)

    Added

    • registeredArguments property on Command with the array of defined Argument (like Command.options for Option) (#2010)
    • TypeScript declarations for Option properties: envVar, presetArg (#2019)
    • TypeScript declarations for Argument properties: argChoices, defaultValue, defaultValueDescription (#2019)
    • example file which shows how to configure help to display any custom usage in the list of subcommands (#1896)

    Changed

    • (developer) refactor TypeScript configs for multiple use-cases, and enable checks in JavaScript files in supporting editors (#1969)

    Deprecated

    • Command._args was private anyway, but now available as registeredArguments (#2010)
  • 11.0.0 - 2023-06-16

    Fixed

    • help command works when help option is disabled (#1864)

    Changed

    • leading and trailing spaces are now ignored by the .arguments() method (#1874)
    • refine "types" exports for ESM to follow TypeScript guidelines (#1886)
    • Breaking: Commander 11 requires Node.js v16 or higher
from commander GitHub release notes
Commit messages
Package name: commander
  • 83c3f4e Bump version to 12.0.0
  • e3192a1 Merge pull request #2140 from tj/release/12.x
  • 608eaf0 Update CHANGELOG for v12 (#2133)
  • 3f44d29 Update dependencies preparing for release (#2132)
  • 4d832b2 Merge remote-tracking branch 'origin/develop' into release/12.x
  • b53109b Add links in CHANGELOG
  • 90f3c8a 12.0.0-1
  • eed665d Add 12.0.0-1 changes to CHANGELOG
  • 09244af Refactor help option implementation to hold actual Option (#2006)
  • ff08a02 Refactor help command implementation to hold actual Command (#2087)
  • b0f789f Bump eslint from 8.54.0 to 8.56.0 (#2107)
  • 8cc042d Bump @ types/jest from 29.5.8 to 29.5.11 (#2102)
  • 1a41d3c Bump typescript from 5.2.2 to 5.3.3 (#2100)
  • f686b2e Bump @ typescript-eslint/eslint-plugin from 6.10.0 to 6.18.0 (#2117)
  • 47f740c Bump github/codeql-action from 2 to 3 (#2108)
  • 32c05a8 Improve JSDoc (#2103)
  • 12a8b47 Rework exitOverride description (#2098)
  • d8a0938 Bump @ typescript-eslint/parser from 6.10.0 to 6.13.1 (#2091)
  • 158c3c7 Bump eslint-config-standard-with-typescript from 39.1.1 to 40.0.0 (#2083)
  • 02ba904 Bump eslint from 8.53.0 to 8.54.0 (#2082)
  • 066e381 Add Removed section to Deprecated (#2078)
  • 9821f3a Update url per npm advice (#2077)
  • 8eed8c2 Bump eslint-plugin-n from 16.2.0 to 16.3.1 (#2075)
  • 47a48c9 Bump @ typescript-eslint/parser from 6.9.1 to 6.10.0 (#2073)
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](https://app.snyk.io/org/nodeshift-agg/project/53f94480-e7ae-41d2-985c-270fae345664?utm_source=github&utm_medium=referral&page=upgrade-pr) 🛠 [Adjust upgrade PR settings](https://app.snyk.io/org/nodeshift-agg/project/53f94480-e7ae-41d2-985c-270fae345664/settings/integration?utm_source=github&utm_medium=referral&page=upgrade-pr) 🔕 [Ignore this dependency or unsubscribe from future upgrade PRs](https://app.snyk.io/org/nodeshift-agg/project/53f94480-e7ae-41d2-985c-270fae345664/settings/integration?pkg=commander&utm_source=github&utm_medium=referral&page=upgrade-pr#auto-dep-upgrades)
codecov-commenter commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 89.54%. Comparing base (882fba2) to head (9328d96).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #343 +/- ## ======================================= Coverage 89.54% 89.54% ======================================= Files 10 10 Lines 306 306 ======================================= Hits 274 274 Misses 32 32 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.