Bump com.github.ajalt.clikt:clikt from 3.5.4 to 4.0.0

[dependabot]

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

Release notes

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

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


""".trimIndent()












)

$ ./command --help
Usage: command [<options>]
───── This command uses markdown for its help text ─────
• You can use lists
• You can use bold and italic text
• You can even use links on terminals that support them
┌───────────┬────────┬──────┬────────┐
│ You       │ can    │ use  │ tables │
╞═══════════╪════════╪══════╪════════╡
│ and       │ they   │ will │ be     │
├───────────┼────────┼──────┼────────┤
│ formatted │ nicely │ for  │ you    │
└───────────┴────────┴──────┴────────┘

There are new lazy extensions for setting paramter help that you can use to add color to parameter help text:

... (truncated)

Changelog

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

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
• Added option(eager=true) to create an eager option that takes values
• Added option(acceptsUnattachedValue=false) to force the option to only accept values like --option=1 and not --option 1
• Added CliktCommand.test() that captures the output of a command and does not exit the process.

Removed

• Removed CliktConsole. Mordant is now used for all input and output. If you were defining a custom console, instead define a mordant TerminalInterface and set it on your context's Terminal.
• Removed TermUi.echo, TermUi.prompt, and TermUi.confirm. Use the equivalent methods on your CliktCommand, or use mordant's prompts directly.
• Removed legacy JS publications. Now only the JS/IR artifacts are published.
• Removed CliktHelpFormatter. Use MordantHelpFormatter instead.

Changed

• prompt and confirm are now implemented with mordant's prompt functionality, and the method parameters have changed to match mordant's
• When using treatUnknownOptionsAsArgs, grouped short options like -abc will be treated as an argument rather than reporting an error as long as they don't match any short options in the command. (#340)
• Clikt no longer automatically calls trimIndent on strings passed to help. Call trimIndent or trimMargin yourself if necessary.
• Context.Builder.helpOptionNames now accepts any iterable rather than just a set.
• CliktCommand.echo and prompt are now public. (#407)
• Internally, all options are implemented transformations on OptionWithValues, rather than using separate classes for each option type.
• Some Localization strings have changed, removed Localization.aborted(), added Localization.argumentsMetavar()
• Context.Builder.helpFormatter is now a lambda that takes the current context as an argument
• Exceptions have been reworked so that all exceptions thrown by Clikt are subclasses of CliktError.
• CliktError now includes statusCode and printError properties.
• The constructor of UsageError and its subclasses no longer takes a context parameter. The context is now inferred automatically.

... (truncated)

Commits

• a28953a Release version 4.0.0
• 59b4603 Update changelog
• ff1602a Update Mordant to 2.0.0
• a4f8c78 update docs
• 282d184 Add lazy help setters
• 824391c Use new eager options to implement completionOption
• 79618ec Update docs
• 71f5bd8 Update docs
• 7946bf2 Update docs on gradle
• 6da82f0 Add MordandHelpFormatter.renderSectionTitle
• Additional commits viewable in compare view

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)

[dependabot]

Superseded by #32.