fix(deps): update dependency com.github.ajalt.clikt:clikt to v5 #236
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:
3.5.4
->5.0.1
Release Notes
ajalt/clikt (com.github.ajalt.clikt:clikt)
v5.0.1
Compare Source
Added
Changed
v5.0.0
Compare Source
Added
iosArm64
andiosX64
targets.NoSuchArgument
exception that is thrown when too many arguments were given on the command line. Previously, a less specificUsageError
was thrown instead.CommandLineParser.tokenize
that splits a string into argv tokens.CommandLineParser
that provides functions for parsing and finalizing commands manually for more control.Context.invokedSubcommands
that contains all subcommands of the current command that are going to be invoked whenallowMultipleSubcommands
istrue
.SuspendingCliktCommand
that has asuspend fun run
method, allowing you to use coroutines in your commands.ChainedCliktCommand
that allows you to return a value from yourrun
method and pass it to the next command in the chain.Context.data
as an alternative toobj
that allows you to store more than one object in the context.Context.echoer
to customize howecho
messages are printed.CompletionGenerator
to manually generate completions for a command.Context.exitProcess
which you can use to prevent the process from exiting during tests.CliktCommand.test
to control the terminal interactivity. (#517)associate{}
,associateBy{}
, andassociateWith{}
transforms for options that allow you to convert the keys and values of the map. (#529)limit
andignoreCase
parameters tooption().split()
. (#541)--help
on subcommands when parents have required parameters.Changed
In a subcommand with and an
argument()
withmultiple()
oroptional()
, the behavior is now the same regardless of the value ofallowMultipleSubcommands
: if a token matches a subcommand name, it's now treated as a subcommand rather than a positional argument.Due to changes to the internal parsing algorithm, the exact details of error messages when multiple usage errors occur have changed in some cases.
Breaking Change: Moved the following parameters from
CliktCommand
's constructor; override the corresponding properties instead:help
fun help
epilog
fun helpEpilog
invokeWithoutSubcommand
val invokeWithoutSubcommand
printHelpOnEmptyArgs
val printHelpOnEmptyArgs
helpTags
val helpTags
autoCompleteEnvvar
val autoCompleteEnvvar
allowMultipleSubcommands
val allowMultipleSubcommands
treatUnknownOptionsAsArgs
val treatUnknownOptionsAsArgs
hidden
val hiddenFromHelp
The following methods on
CliktCommand
have been renamed:commandHelp
->help
,commandHelpEpilog
->epilog
. The old names are deprecated.Breaking Change:
CliktCommand.main
andCliktCommand.parse
are now extension functions rather than methods.Breaking Change:
Context.obj
andContext.terminal
, andOptionTransformContext.terminal
are now extension functions rather than properties.Breaking Change: The
RenderedSection
andDefinitionRow
classes have moved toAbstractHelpFormatter
.Markdown support in the help formatter is no longer included by default. To enable it, include the
:clikt-markdown
dependency and callyourCommand.installMordantMarkdown()
before parsing.Updated Kotlin to 2.0.0
Fixed
allowMultipleSubcommands=true
and a subcommand has excess arguments followed by another subcommand.printHelpOnEmptyArgs=true
will no longer print help if an option has a value from an environment variable or value source. (#382)Deprecated
Context.originalArgv
. It will now always return an empty list. If your commands need an argv, you can pass it to them before you run them, or set in on the newContext.data
map.Context.expandArgumentFiles
. UseContext.argumentFileReader
instead.Context
fields to be more consistent. The old names are deprecated.Context.envvarReader
Context.readEnvvar
Context.correctionSuggestor
Context.suggestTypoCorrection
Context.argumentFileReader
Context.readArgumentFile
Context.tokenTransformer
Context.transformToken
Removed
MordantHelpFormatter.graphemeLength
TermUi
v4.4.0
Compare Source
Added
linuxArm64
andwasmJs
targets.v4.3.0
Compare Source
Added
limit
parameter tooption().counted()
to limit the number of times the option can be used. You can either clamp the value to the limit, or throw an error if the limit is exceeded. (#483)Context.registerClosable
andContext.callOnClose
to allow you to register cleanup actions that will be called when the command exits. (#395)Fixed
unrecognized modifier 'i'
that happened on tab-completion when using sub command aliases. Thanks to @hick209 for the contribution. (#500)complete:13: command not found: compdef
. Thanks to @hick209 for the contribution. (#499)v4.2.2
Compare Source
Changed
defaultLazy
and other finalization blocks. They can also freely reference each other, including though chains of references. (#473)v4.2.1
Compare Source
Added
toString
implementations to options and arguments. (#434)CliktCommand.test
overload that takes a vararg ofString
s as the command line arguments. Thanks to @sschuberth for the contribution (#451)Fixed
v4.2.0
Compare Source
Added
requireConfirmation
parameter tooption().prompt()
(#426)CliktCommand.terminal
extension for accessing the terminal from a command.includeSystemEnvvars
,ansiLevel
,width
, andheight
parameters to allCliktCommand.test
overloads.Deprecated
CliktCommand.prompt
, useCliktCommand.terminal.prompt
orPrompt
instead.CliktCommand.confirm
, useYesNoPrompt
instead.Fixed
defaultLazy
option referenced arequired
option. (#430)v4.1.0
Compare Source
Added
MordantHelpFormatter.renderAttachedOptionValue
that you can override to change how option values are shown, e.g. if you want option to show as--option <value>
instead of--option=<value>
. (#416)option().optionalValueLazy{}
, which work likeoptionalValue()
but the default value is computed lazily. (#381)Changed
PrintMessage
,PrintHelpMessage
andPrintCompletionMessage
now default to exiting with a status code 0, which is the behavior they had in 3.x. (#419)v4.0.0
Compare Source
Added
Context.errorEncountered
which is true if parsing has continued after an error was encountered.option().help{""}
andargument().help{""}
extensions that set the parameter's help text lazily, with access to the current context so that you can add colors.Changed
Option.optionHelp
andArgument.argumentHelp
,CliktCommand.commandHelp
, andCliktCommand.commandHelpEpilog
are now methods that take the context as an argument, and thehelp
parameter tocopy
is now ahelpGetter
lambda.CliktCommand.shortHelp
now takes the context as an argument.message
method onTransformContext
interfaces is now an extension.Deprecated
CliktCommand.commandHelp
andcommandHelpEpilog
properties in favor of the methods with the same name.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 is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.