Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(deps): update dependency com.github.ajalt.clikt:clikt to v5 #715

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Sep 15, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
com.github.ajalt.clikt:clikt 3.5.4 -> 5.0.2 age adoption passing confidence

Warning

Some dependencies could not be looked up. Check the Dependency Dashboard for more information.


Release Notes

ajalt/clikt (com.github.ajalt.clikt:clikt)

v5.0.2

Compare Source

Changed
  • Update Kotlin to 2.1.0

v5.0.1

Compare Source

Added
  • Added completion commands for suspending and chained commands. (#​553)
  • Added no-op suspending commands. (#​554)
Changed
  • Unknown option errors and missing argument errors that occur at the same time will now both be reported. (#​553)

v5.0.0

Compare Source

Added
  • Publish iosArm64 and iosX64 targets.
  • Added NoSuchArgument exception that is thrown when too many arguments were given on the command line. Previously, a less specific UsageError was thrown instead.
  • Added CommandLineParser.tokenize that splits a string into argv tokens.
  • Added CommandLineParser that provides functions for parsing and finalizing commands manually for more control.
  • Added Context.invokedSubcommands that contains all subcommands of the current command that are going to be invoked when allowMultipleSubcommands is true.
  • Added SuspendingCliktCommand that has a suspend fun run method, allowing you to use coroutines in your commands.
  • Added ChainedCliktCommand that allows you to return a value from your run method and pass it to the next command in the chain.
  • Added Context.data as an alternative to obj that allows you to store more than one object in the context.
  • Added Context.echoer to customize how echo messages are printed.
  • Added CompletionGenerator to manually generate completions for a command.
  • Added Context.exitProcess which you can use to prevent the process from exiting during tests.
  • Added core module that supports watchOS, tvOS, and wasmWasi targets and has no dependencies.
  • Added more options to CliktCommand.test to control the terminal interactivity. (#​517)
  • Added associate{}, associateBy{}, and associateWith{} transforms for options that allow you to convert the keys and values of the map. (#​529)
  • Added support for aliasing options to other options. (#​535)
  • Added limit and ignoreCase parameters to option().split(). (#​541)
  • Support calling --help on subcommands when parents have required parameters.
Changed
  • In a subcommand with and an argument() with multiple() or optional(), the behavior is now the same regardless of the value of allowMultipleSubcommands: 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:

    removed parameter replacement property
    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 and CliktCommand.parse are now extension functions rather than methods.

  • Breaking Change: Context.obj and Context.terminal, and OptionTransformContext.terminal are now extension functions rather than properties.

  • Breaking Change: The RenderedSection and DefinitionRow classes have moved to AbstractHelpFormatter.

  • Markdown support in the help formatter is no longer included by default. To enable it, include the :clikt-markdown dependency and call yourCommand.installMordantMarkdown() before parsing.

  • Updated Kotlin to 2.0.0

Fixed
  • Fixed excess arguments not being reported when allowMultipleSubcommands=true and a subcommand has excess arguments followed by another subcommand.
  • Commands with printHelpOnEmptyArgs=true will no longer print help if an option has a value from an environment variable or value source. (#​382)
Deprecated
  • 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 new Context.data map.
  • Deprecated Context.expandArgumentFiles. Use Context.argumentFileReader instead.
  • Renamed the following Context fields to be more consistent. The old names are deprecated.
old name new name
Context.envvarReader Context.readEnvvar
Context.correctionSuggestor Context.suggestTypoCorrection
Context.argumentFileReader Context.readArgumentFile
Context.tokenTransformer Context.transformToken
Removed
  • Removed previously deprecated experimental annotations.
  • Removed MordantHelpFormatter.graphemeLength
  • Removed TermUi

v4.4.0

Compare Source

Added
  • Publish linuxArm64 and wasmJs targets.

v4.3.0

Compare Source

Added
  • Added limit parameter to option().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)
  • Added Context.registerClosable and Context.callOnClose to allow you to register cleanup actions that will be called when the command exits. (#​395)
Fixed
  • Fixed unrecognized modifier 'i' that happened on tab-completion when using sub command aliases. Thanks to @​hick209 for the contribution. (#​500)
  • Make sure auto complete script works on zsh, fixing the error complete:13: command not found: compdef. Thanks to @​hick209 for the contribution. (#​499)

v4.2.2

Compare Source

Changed
  • Options and arguments can now reference option groups in their defaultLazy and other finalization blocks. They can also freely reference each other, including though chains of references. (#​473)
  • Updated Kotlin to 1.9.21 (#​472)

v4.2.1

Compare Source

Added
  • Added toString implementations to options and arguments. (#​434)
  • Added CliktCommand.test overload that takes a vararg of Strings as the command line arguments. Thanks to @​sschuberth for the contribution (#​451)
Fixed
  • Update Mordant dependency to fix crashes on native targets and GraalVM (#​447)

v4.2.0

Compare Source

Added
  • Added requireConfirmation parameter to option().prompt() (#​426)
  • Added CliktCommand.terminal extension for accessing the terminal from a command.
  • Added includeSystemEnvvars, ansiLevel, width, and height parameters to all CliktCommand.test overloads.
Deprecated
  • Deprecated CliktCommand.prompt, use CliktCommand.terminal.prompt or Prompt instead.
  • Deprecated CliktCommand.confirm, use YesNoPrompt instead.
Fixed
  • Fixed incorrect error message when a defaultLazy option referenced a required option. (#​430)

v4.1.0

Compare Source

Added
  • 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)
  • Added option().optionalValueLazy{}, which work like optionalValue() but the default value is computed lazily. (#​381)
Changed
  • Updated Kotlin to 1.9.0
  • PrintMessage, PrintHelpMessage and PrintCompletionMessage 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
  • Added Context.errorEncountered which is true if parsing has continued after an error was encountered.
  • option().help{""} and argument().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 and Argument.argumentHelp, CliktCommand.commandHelp, and CliktCommand.commandHelpEpilog are now methods that take the context as an argument, and the help parameter to copy is now a helpGetter lambda. CliktCommand.shortHelp now takes the context as an argument.
  • The message method on TransformContext interfaces is now an extension.
Deprecated
  • Deprecated CliktCommand.commandHelp and commandHelpEpilog 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: Enabled.

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.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch from 7a81278 to 98b6717 Compare October 5, 2024 16:34
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch from 98b6717 to 36c20d7 Compare November 5, 2024 08:28
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch from 36c20d7 to 447c02c Compare November 14, 2024 09:25
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch from 447c02c to 81bcb9a Compare December 1, 2024 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant