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

Bump com.github.ajalt.clikt:clikt from 3.5.4 to 4.2.0 #35

Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jul 31, 2023

Bumps com.github.ajalt.clikt:clikt from 3.5.4 to 4.2.0.

Release notes

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

4.2.0

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.

4.1.0

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)

4.0.0

Clikt 4.0 is a major release that uses the Mordant library for help formatting. If you aren't customizing help output, this upgrade will probably be source compatible.

Highlights

Here are some of the highlights of this release. See CHANGELOG.md for a detailed list of changes.

Colors and Markdown in help output

All help strings now support markdown, including tables and lists. On terminals that support it, help and error messages will be colored.

class Command : CliktCommand(
    help="""
    ## This command uses markdown for its help text
- You can use lists
- You can use **bold** and *italic* text
- You can even use [links](https://example.com) on terminals that support them



You
can
use
tables




and
they
will
be


formatted
nicely
for
you


&quot;&quot;&quot;.trimIndent()












)

</tr></table> 

... (truncated)

Changelog

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

4.2.0

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)

4.1.0

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)

4.0.0

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.

4.0.0-RC

Added

  • You can now use markdown in your help strings, including tables and lists. Clikt uses the Mordant library for rendering.
  • Help output and error messages now include colors by default. You can disable this or customize the styling by configuring the context.terminal
  • Added Option.varargValues() to create an option that accepts a variable number of values
  • Added Option.optionalValue() to create an option whose value is optional.
  • Added obj setter to context builder as an alternative to currentContext.obj
  • Added boolean() parameter type conversions.
  • Added uint() and ulong() parameter type conversions.
  • Added nullableFlag() parameter transformation.
  • Added CliktCommand.test extension for testing your commands and their output
  • Clikt will now report multiple errors if they occur via the new MultiUsageError exception, rather than just reporting the first error. (#367)
  • Added CliktCommand.allHelpParams(), which can be overridden to change which parameters are displayed in help output
  • Added Context.argumentFileReader which allows custom loading of argument files
  • Added Context.allowGroupedShortOptions which can disable parsing -abc as -a -b -c
  • Options named -? or /? are now supported

... (truncated)

Commits
  • a18431f Release version 4.2.0
  • 6ac1766 Fix lints and doc typos
  • 671c250 Add requireConfirmation to prompt
  • 41a6acc Update mordant to 2.1.0
  • e91f7a7 Add CliktCommand.terminal and deprecate CliktCommand.prompt
  • fe3ae86 Avoid a superfluous not-null assertion
  • 1086b7f Use maxBy instead of maxByOrNull to avoid a not-null assertion
  • 5df6364 Remove a bunch of unused import stataments
  • 9ec4a88 Fix error message when lazily referencing required options (#431)
  • 5067136 samples: Remove RequiresOptIn which is not required anymore (#427)
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually 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 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)

Bumps [com.github.ajalt.clikt:clikt](https://github.com/ajalt/clikt) from 3.5.4 to 4.2.0.
- [Release notes](https://github.com/ajalt/clikt/releases)
- [Changelog](https://github.com/ajalt/clikt/blob/master/CHANGELOG.md)
- [Commits](ajalt/clikt@3.5.4...4.2.0)

---
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 added dependencies Pull requests that update a dependency file java Pull requests that update Java code labels Jul 31, 2023
@ZacSweers ZacSweers merged commit ffec177 into main Aug 9, 2023
2 checks passed
@ZacSweers ZacSweers deleted the dependabot/gradle/com.github.ajalt.clikt-clikt-4.2.0 branch August 9, 2023 04:51
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.

1 participant