Conversation
Codecov ReportBase: 100.00% // Head: 100.00% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## master #332 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 131 131
=========================================
Hits 131 131 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
~7.2.0->~9.4.0Release Notes
tj/commander.js
v9.4.1Compare Source
Fixed
.setOptionValue()now also clears option source ([#1795])impliedtoOptionValueSourcefor option values set by using.implies()([#1794])undefinedto return type of.getOptionValueSource()([#1794])Changed
v9.4.0Compare Source
Added
preSubcommandhook called before direct subcommands ([#1763])Fixed
InvalidOptionArgumentErrorin esm ([#1756])Changed
v9.3.0Compare Source
Added
.summary()for a short summary to use instead of description when listing subcommands in help ([#1726])Option.implies()to set other option values when the option is specified ([#1724])Fixed
string[]to.options()default value parameter type for use with variadic options ([#1721])Deprecated
-ws) ([#1718])v9.2.0Compare Source
Added
Fixed
Changed
String.prototype.substr([#1706])v9.1.0Compare Source
Added
.conflicts()to set conflicting options which can not be specified together ([#1678])v9.0.0Compare Source
Added
.executableDir()for custom search for subcommands ([#1571])Optionto.option()or.requiredOption()([#1655])error()for generating errors from client code just like Commander generated errors, with support for.configureOutput(),.exitOverride(), and.showHelpAfterError()([#1675]).optsWithGlobals()to return merged local and global options ([#1671])Changed
showSuggestionAfterErroris now on by default ([#1657])executableFile([#1571])executableFile([#1571]).choices()[(#1667)].parse(),.parseAsync(),.aliases()[(#1669)]Fixed
Removed
require.main.filenamewhen script not known from arguments passed to.parse()(can supply details using.name(), and.executableDir()orexecutableFile) ([#1571])v8.3.0Compare Source
Added
.getOptionValueSource()and.setOptionValueWithSource(), where expected values for source are one of 'default', 'env', 'config', 'cli' ([#1613])Deprecated
.command('*'), use default command instead ([#1612])on('command:*'), use.showSuggestionAfterError()instead ([#1612])v8.2.0Compare Source
Added
.showSuggestionAfterError()to show suggestions after unknown command or unknown option ([#1590])Optionsupport for values from environment variables using.env()([#1587])Changed
Removed
OptionmethodargumentRejectedv8.1.0Compare Source
Added
.copyInheritedSettings()([#1557])Argumentmethods for.argRequired()and.argOptional()([#1567])v8.0.0Compare Source
Added
.argument(name, description)for adding command-arguments ([#1490]).createArgument()factory method ([#1497]).addArgument()([#1490])Argumentsupports.choices()([#1525]).showHelpAfterError()to display full help or a custom message after an error ([#1534]).hook()with support for'preAction'and'postAction'callbacks ([#1514]).opts()return type using TypeScript generics ([#1539]).getOptionValue()and.setOptionValue()([#1521])Changed
.parseAsync()is now declared asasync([#1513])Helpmethod.visibleArguments()returns array ofArgument([#1490])CommanderErrorcodecommander.invalidOptionArgumentrenamedcommander.invalidArgument([#1508]).addTextHelp()callback no longer allows result ofundefined, now juststring([#1516])index.tabinto a file per class ([#1522]).showHelpAfteError()) ([#1534])Commandproperty.arginitialised to empty array (was previously undefined) ([#1529])Deprecated
cmd.description(desc, argDescriptions)for adding argument descriptions ([#1490]).argument(name, description)instead)InvalidOptionArgumentError(replaced byInvalidArgumentError) ([#1508])Removed
Commandobject ([#1520])programexport)Migration Tips
If you have a simple program without an action handler, you will now get an error if
there are missing command-arguments.
$ 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:
Or, you might choose to show the help after any user error:
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.