Skip to content

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 7, 2024

Bumps com.github.ajalt.clikt:clikt from 4.4.0 to 5.0.1.

Release notes

Sourced from com.github.ajalt.clikt:clikt's releases.

5.0.1

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)

5.0.0

This release splits the package into separate modules to help produce smaller binaries. Parsing and running commands are now separated, which allows for custom run types. This release includes the SuspendingCliktCommand and the ChainedCliktCommand, and it's easy to define your own.

See the migration guide for details on upgrading to Clikt 5.0.

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.

... (truncated)

Changelog

Sourced from com.github.ajalt.clikt:clikt's changelog.

5.0.1

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)

5.0.0

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

... (truncated)

Commits

Dependabot compatibility score

You can trigger a rebase of this PR by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

@dependabot dependabot bot added dependencies Pull requests that update a dependency file java Pull requests that update Java code labels Oct 7, 2024
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from fc9eb77 to 3cc6bfc Compare October 7, 2024 03:38
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 3cc6bfc to 1e289dc Compare October 7, 2024 03:42
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 1e289dc to 8b6a4ed Compare October 7, 2024 03:46
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 8b6a4ed to 7ebfe75 Compare October 8, 2024 03:43
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 7ebfe75 to ce59c4b Compare October 8, 2024 03:46
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from ce59c4b to 9e8ec50 Compare October 8, 2024 03:50
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 9e8ec50 to 8bb7eb3 Compare October 9, 2024 03:23
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 8bb7eb3 to 52da9ea Compare October 9, 2024 03:27
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 52da9ea to 5181274 Compare October 9, 2024 03:30
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 5181274 to 416ea01 Compare October 10, 2024 03:57
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 416ea01 to 2fa73d0 Compare October 10, 2024 04:01
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 2fa73d0 to 5ca7d55 Compare October 11, 2024 03:26
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 5ca7d55 to 540d6e9 Compare October 11, 2024 03:28
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 230e8bf to fc56590 Compare October 28, 2024 03:43
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from fc56590 to 0bd5a2a Compare October 28, 2024 03:47
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 0bd5a2a to 879655f Compare October 29, 2024 03:28
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 879655f to ea5434b Compare October 29, 2024 03:32
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from ea5434b to 2bb6270 Compare October 30, 2024 03:30
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 2bb6270 to 44cdf29 Compare October 30, 2024 03:34
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 44cdf29 to 8326c91 Compare October 31, 2024 04:02
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 8326c91 to 222263f Compare October 31, 2024 04:06
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 222263f to 9719e11 Compare November 1, 2024 03:43
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 9719e11 to 8b05e9e Compare November 1, 2024 03:47
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from 8b05e9e to ff57a90 Compare November 4, 2024 03:35
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from ff57a90 to eeb8258 Compare November 4, 2024 03:39
Bumps [com.github.ajalt.clikt:clikt](https://github.com/ajalt/clikt) from 4.4.0 to 5.0.1.
- [Release notes](https://github.com/ajalt/clikt/releases)
- [Changelog](https://github.com/ajalt/clikt/blob/master/CHANGELOG.md)
- [Commits](ajalt/clikt@4.4.0...5.0.1)

---
updated-dependencies:
- dependency-name: com.github.ajalt.clikt:clikt
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch from eeb8258 to c2e0df4 Compare November 5, 2024 03:46
Copy link
Contributor Author

dependabot bot commented on behalf of github Dec 2, 2024

Superseded by #552.

@dependabot dependabot bot closed this Dec 2, 2024
@dependabot dependabot bot deleted the dependabot/gradle/com.github.ajalt.clikt-clikt-5.0.1 branch December 2, 2024 03:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file java Pull requests that update Java code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants