mozilla / qbrt

CLI to a Gecko desktop app runtime
Apache License 2.0
391 stars 31 forks source link

Update command-line-args to the latest version 🚀 #138

Closed greenkeeper[bot] closed 6 years ago

greenkeeper[bot] commented 6 years ago

Version 5.0.0 of command-line-args was just published.

Dependency command-line-args
Current Version 4.0.7
Type dependency

The version 5.0.0 is not covered by your current version range.

If you don’t accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.

It might be worth looking into these changes and trying to get this project onto the latest version of command-line-args.

If you have a solid test suite and good coverage, a passing build is a strong indicator that you can take advantage of these changes directly by merging the proposed change into your project. If the build fails or you don’t have such unconditional trust in your tests, this branch is a great starting point for you to work on the update.


Release Notes v5.0.0

Breaking changes from v4.0.7

  • Unknown values now throw an exception (UNKNOWN_VALUE) by default in the same way unknown options do. Command-line-args is now strict by default - all options and values must be accounted for in the option definitions.
    • An example of an unknown value is the arg 5 in the command --verbose 5 where verbose is defined as a Boolean.
    • "Strict by default" behaviour can be disabled using either partial or stopAtFIrstUnknown parse options.
  • The multiple error names (NAME_MISSING, INVALID_TYPE etc) thrown by commandLineArgs in the case of an invalid definition have been consolidated to just one error name: INVALID_DEFINITIONS. Given broken option definitions are a programmer error they'd never be handled anyway, making the various names pointless.

New documentation

Wiki introduced.

New parse features

  • stopAtFirstUnknown
  • camelCase
  • the UNKNOWN_OPTION exception now has a optionName property containing the unknown option name, e.g. --one
  • the UNKNOWN_VALUE exception has a value property containing the unknown value, e.g. 5

New option definition features

Bug fixes

  • #67 unknown "--option=value notation" value consumed as defaultOption
  • #68 unknown --option=value arg split when defaultOption set

Upgrade notes

No API changes were introduced in v5.0.0 - it is backward-compatible. If you're comfortable with the new version throwing exceptions on unknown values, you are safe to upgrade without code change.

Commits

The new version differs by 40 commits.

There are 40 commits in total.

See the full diff

FAQ and help There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those don’t help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new).

Your Greenkeeper bot :palm_tree:

greenkeeper[bot] commented 6 years ago

Version 5.0.1 just got published.

Update to this version instead 🚀

Commits

The new version differs by 5 commits.

See the full diff

greenkeeper[bot] commented 6 years ago

Version 5.0.2 just got published.

Update to this version instead 🚀

Commits

The new version differs by 8 commits.

See the full diff