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

Update dependency com.github.ajalt.clikt:clikt to v5 #2547

Open
wants to merge 1 commit into
base: main
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 4.4.0 -> 5.0.1 age adoption passing confidence

Release Notes

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

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

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 enabled auto-merge (rebase) September 15, 2024 22:28
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch 10 times, most recently from 91596b2 to 143319f Compare September 24, 2024 15:41
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch 3 times, most recently from 2521409 to 2471931 Compare October 2, 2024 03:28
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch 6 times, most recently from d25368b to f12d65b Compare October 9, 2024 12:20
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch 6 times, most recently from 78ce7b3 to 580d864 Compare October 16, 2024 21:48
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch 4 times, most recently from a9d25a2 to 46be5eb Compare October 23, 2024 19:27
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch 5 times, most recently from e6a504f to e4ced5f Compare October 30, 2024 18:50
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch 4 times, most recently from 5f91d05 to b3f489c Compare November 7, 2024 12:50
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch 9 times, most recently from 125b082 to 1e45a62 Compare November 14, 2024 20:07
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch from 1e45a62 to 194c8da Compare November 15, 2024 06:58
@renovate renovate bot force-pushed the renovate/com.github.ajalt.clikt-clikt-5.x branch from 194c8da to 9cbacae Compare November 15, 2024 12:51
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.

0 participants