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:
^2.1.0
->^2.5.0
2.5.1
^3.11.5
->^3.11.6
^0.7.0
->^0.7.2
^1.3.5
->^3.2.0
^4.1.0
->^5.4.1
^0.6.1
->^0.6.5
^4.1.1
->^13.1.0
^0.7.0
->^1.5.3
^2.2.5
->^2.3.0
^4.0.4
->^8.1.1
Release Notes
parcel-bundler/watcher (@parcel/watcher)
v2.5.0
Compare Source
Added
--build-from-source
flag to optionally build from source instead of using prebuilt packages. Can be used in conjunction with--no-optional
to prevent installing platform-specific dependencies.Fixed
open()
calls onstat()
failures on macOS to prevent security dialogs (#186)v2.4.1
Compare Source
v2.4.0
Compare Source
Adds support for CommonJS (along with existing support for ESM) in
@parcel/watcher-wasm
.v2.3.0
Compare Source
Features
@parcel/watcher-wasm
package instead of@parcel/watcher
in these cases. Note that this is much less efficient than using native OS-specific APIs, so keep using the native packages where possible.@parcel/watcher
from multiple Node.js worker threadsv2.2.0
Compare Source
This release migrates to a new method of distribution. Rather than including binaries for all operating systems and architectures inside the
@parcel/watcher
package, there are now individual packages per platform (e.g.@parcel/watcher-darwin-x64
). Each of these is an optional dependency of the main watcher package. This way, npm and other package managers will install only the binary for the platform you are running on. This reduces bandwidth and disk space.This also enabled us to add pre-compiled binaries for more platforms, meaning you don't need to have a C++ compiler to install the watcher. This should help with some minimal Docker environments especially. The architectures with prebuilds available now include:
sindresorhus/ora (@types/ora)
v3.2.0
Compare Source
2768e75
v3.1.0
Compare Source
ora
is running (#95)2aee2da
indent
option (#96)24ebe3b
v3.0.0
Breaking changes:
enabled
option toisEnabled
sindresorhus/ora@fc5c660iEnabled
sindresorhus/ora@d1f8d85Fixes:
chalk/chalk (chalk)
v5.4.1
Compare Source
navigator
not definedReferenceError
(#642)4ebb62d
v5.4.0
Compare Source
CIRCLECI
environments to return level 3 color supportf838120
v5.3.0
Compare Source
sideEffects
field to package.json5aafc0a
29b8569
v5.2.0
Compare Source
7443e9f
7443e9f
7443e9f
7443e9f
v5.1.2
Compare Source
a34bcf6
v5.1.1
Compare Source
6e0df05
v5.1.0
Compare Source
d7d7571
v5.0.1
Compare Source
main
field to package.json for backwards compatibility with some developer tools85f7e96
v5.0.0
Compare Source
Breaking
fa16f4e
chalk.Instance
→Chalk
chalk.supportsColor
→supportsColor
chalk.stderr
→chalkStderr
chalk.stderr.supportsColor
→supportsColorStderr
.keyword()
,.hsl()
,.hsv()
,.hwb()
, and.ansi()
coloring methods (#433)4cf2e40
color-convert
package.chalk-template
(#524)c987c61
Improvements
04fdbd6
overline
style (#433)4cf2e40
0fba91b
cli-table/cli-table3 (cli-table3)
v0.6.5
Compare Source
What's Changed
New Contributors
Full Changelog: cli-table/cli-table3@v0.6.4...v0.6.5
v0.6.4
Compare Source
What's Changed
New Contributors
Full Changelog: cli-table/cli-table3@v0.6.3...v0.6.4
v0.6.3
Compare Source
🚀 Enhancement
v0.6.2
Compare Source
🚀 Enhancement
🐛 Bug Fix
📝 Documentation
🏠 Internal
tj/commander.js (commander)
v13.1.0
Compare Source
Added
.option('--ws, --workspace')
([#2312])v13.0.0
Compare Source
Added
.parse()
with default settings ([#2299]).saveStateBeforeParse()
and.restoreStateBeforeParse()
for use by subclasses ([#2299])styleTitle()
to add color to help using.configureHelp()
or Help subclass ([#2251]).configureOutput()
forgetOutHasColors()
,getErrHasColors()
, andstripColor()
([#2251])minWidthToWrap
([#2251])displayWidth()
,boxWrap()
,preformatted()
et al ([#2251])Changed
-
([#2270]).parse()
ifstoreOptionsAsProperties: true
([#2299])this
in parameters for action handler callback ([#2197])Deleted
Help.wrap()
refactored intoformatItem()
andboxWrap()
([#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:
Now shows an error:
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.
Or you could suppress the error, useful for minimising changes in legacy code.
Stricter option flag parsing
Commander now throws an error for option flag combinations that are not supported.
In particular, a short flag with multiple characters is now an error.
A short option has a single character:
Or from Commander 13.1 you can have an extra long flag instead of a short flag to allow a more memorable shortcut for the full name:
v12.1.0
Compare Source
Added
node --eval
andnode --print
when call.parse()
with no arguments ([#2164])Changed
node:
([#2170])Removed
v12.0.0
Compare Source
Added
.addHelpOption()
as another way of configuring built-in help option ([#2006]).helpCommand()
for configuring built-in help command ([#2087])Fixed
passThroughOptions
constraints when using.addCommand
and throw if parent command does not have.enablePositionalOptions()
enabled ([#1937])Changed
.storeOptionsAsProperties()
after setting an option value ([#1928])@api private
with documented@private
([#1949]).addHelpCommand()
now takes a Command (passing string or boolean still works as before but deprecated) ([#2087])Deprecated
.addHelpCommand()
passing string or boolean (use.helpCommand()
or pass a Command) ([#2087])Removed
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
).option and command clashes
A couple of configuration problems now throw an error, which will pick up issues in existing programs:
v11.1.0
Compare Source
Fixed
OptionValueSource
to allow any string, to match supported use of custom sources ([#1983])Command.version()
can also be used as getter ([#1982])Commands.executableDir()
, for when not configured ([#1965])Added
registeredArguments
property onCommand
with the array of definedArgument
(likeCommand.options
forOption
) ([#2010])envVar
,presetArg
([#2019])argChoices
,defaultValue
,defaultValueDescription
([#2019])Changed
Deprecated
Command._args
was private anyway, but now available asregisteredArguments
([#2010])v11.0.0
Compare Source
Fixed
Changed
v10.0.1
Compare Source
Added
Fixed
Option.optionFlags
property from TypeScript definition ([#1844])Changed
.implies()
([#1854])v10.0.0
Compare Source
Added
Changed
v9.5.0
Compare Source
Added
.getOptionValueSourceWithGlobals()
([#1832])showGlobalOptions
for.configureHelp{}
andHelp
([#1828])v9.4.1
Compare Source
Fixed
.setOptionValue()
now also clears option source ([#1795])implied
toOptionValueSource
for option values set by using.implies()
([#1794])undefined
to return type of.getOptionValueSource()
([#1794])Changed
v9.4.0
Compare Source
Added
preSubcommand
hook called before direct subcommands ([#1763])Fixed
InvalidOptionArgumentError
in esm ([#1756])Changed
v9.3.0
Compare 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.0
Compare Source
Added
Fixed
Changed
String.prototype.substr
([#1706])v9.1.0
Compare Source
Added
.conflicts()
to set conflicting options which can not be specified together ([#1678])v9.0.0
Compare Source
Added
.executableDir()
for custom search for subcommands ([#1571])Option
to.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
showSuggestionAfterError
is now on by default ([#1657])executableFile
([#1571])executableFile
([#1571]).choices()
([#1667]).parse()
,.parseAsync()
,.aliases()
([#1669])Fixed
Removed
require.main.filename
when script not known from arguments passed to.parse()
(can supply details using.name()
, and.executableDir()
orexecutableFile
) ([#1571])v8.3.0
Compare 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.0
Compare Source
Added
.showSuggestionAfterError()
to show suggestions after unknown command or unknown option ([#1590])Option
support for values from environment variables using.env()
([#1587])Changed
Removed
Option
methodargumentRejected
v8.1.0
Compare Source
Added
.copyInheritedSettings()
([#1557])Argument
methods for.argRequired()
and.argOptional()
([#1567])v8.0.0
Compare Source
Added
.argument(name, description)
for adding command-arguments ([#1490]).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]).opts()
return type using TypeScript generics ([#1539]).getOptionValue()
and.setOptionValue()
([#1521])Changed
.parseAsync()
is now declared asasync
([#1513])Help
method.visibleArguments()
returns array ofArgument
([#1490])CommanderError
codecommander.invalidOptionArgument
renamedcommander.invalidArgument
([#1508]).addTextHelp()
callback no longer allows result ofundefined
, now juststring
([#1516])index.tab
into a file per class ([#1522]).showHelpAfterError()
) ([#1534])Command
property.arg
initialised 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
Command
object ([#1520])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.
$ 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:
v7.2.0
Compare Source
Added
parent
property onCommand
([#1475]).attributeName()
onOption
([#1483])Changed
v7.1.0
Compare Source
Added
.cjs
to list of expected script file extensions ([#1449])Fixed
process.mainModule
([#1448])command('*')
and call when command line includes options ([#1464])on('command:*', ...)
and call when command line includes unknown options ([#1464])Changed
v7.0.0
Compare Source
Added
.enablePositionalOptions()
to let program and subcommand reuse same option ([#1427]).passThroughOptions()
to pass options through to other programs without needing--
([#1427]).allowExcessArguments(false)
to show an error message if there are too many command-arguments on command line for the action handler ([#1409]).configureOutput()
to modify use of stdout and stderr or customise display of errors ([#1387]).addHelpText()
to add text before or after the built-in help, for just current command or also for all subcommands ([#1296]).createOption()
to support subclassing of automatically created options (like.createCommand()
) ([#1380])Changed
program.opts()
.storeOptionsAsProperties()
.help()
and.outputHelp()
(removed from README) ([#1296])process.stderr.write()
instead ofconsole.error()
.on('--help')
(removed from README) ([#1296])Fixed
Deleted
.passCommandToAction()
([#1409]).allowExcessArguments(false)
Migration Tips
The biggest change is the parsed option values. Previously the options were stored by default as properties on the command object, and now the options are stored separately.
If you wish to restore the old behaviour and get running quickly you can call
.storeOptionsAsProperties()
.To allow you to move to the new code patterns incrementally, the action handler will be passed the command twice,
to match the new "options" and "command" parameters (see below).
program options
Use the
.opts()
method to access the options. This is available on any command but is used most with the program.action handler
The action handler gets passed a parameter for each command-argument you declared. Previously by default the next parameter was the command object with the options as properties. Now the next two parameters are instead the options and the command. If you
only accessed the options there may be no code changes required.
If you already set
.storeOptionsAsProperties(false)
you may still need to adjust your code.v6.2.1
Compare Source
Fixed
v6.2.0
Compare Source
Added
.description()
to describe command arguments ([#1353])Fixed
Changed
v6.1.0
Compare Source
Added
.combineFlagAndOptionalValue(false)
to ease upgrade path from older versions of Commander ([#1326]).helpOption(false)
([#1325])argumentDescription
to.description()
([#1323])Changed
Fixed
v6.0.0
Compare Source
Added
-n
accessed asopts().n
(previously uppercase)Fixed
v5.1.0
Compare Source
Added
addCommand()
forhidden
andisDefault
([#1232])Fixed
helpOption
([#1248])Changed
arguments
to improve auto-generated help in editors ([#1235]).command()
configurationnoHelp
tohidden
(but not remove old support) ([#1232])v5.0.0
Compare Source
Added
.addCommand()
for adding a separately configured command ([#764] [#1149]).addHelpCommand()
([#1149])-a -b -p 80
can be written as-abp80
) ([#1145]).parseOption()
includes short flag and long flag expansions ([#1145]).helpInformation()
returns help text as a string, previously a private routine ([#1169]).parse()
implicitly usesprocess.argv
if arguments not specified ([#1172]).parse()
arguments "from", if not following node conventions ([#512] [#1172])commands
property ofCommand
([#1184])program
property ([#1195])createCommand
factory method to simplify subclassing ([#1191])Fixed
command:*
for executable subcommands ([#809] [#1149])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.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Renovate Bot.