clikt changelog

Changelog History

Page 1

• v3.5.0 Changes

  ➕ Added

  • ➕ Added hidden parameter to CliktCommand, which will prevent the command from being displayed as a subcommand in help output (#353)
  • 🍎 Publish artifacts for the macosArm64 target. Note that this target is not tested on CI. (#352)

  🔄 Changed

  • 0️⃣ Default values for arguments will now be included in help output when showDefaultValues=true is set on your help formatter (#357)

  🛠 Fixed

  • 🛠 Fix flags and other options with defaults not being usable in mutuallyExclusiveOptions (#349)
  • 🛠 Fix CompletionCommand generating completion for itself (#355)

• v3.4.2 Changes

  🗄 Deprecated

  • TermUi.echo, TermUi.prompt, and TermUi.confirm. Use the equivalent methods on CliktCommand instead. (#344)

• v3.4.1 Changes

  ➕ Added

  • Publish JS artifacts with new IR compiler, in addition to the legacy format

  🔄 Changed

  • ⚡️ Updated Kotlin to 1.6.20

• v3.4.0 Changes

  🔄 Changed

  • unique() now works with any option with a list type, not just multiple() options (#332)
  • ⚡️ Updated Kotlin to 1.6.10

  🛠 Fixed

  • 🛠 Fixed co-occurring option groups returning null when all options in the group are defined in environment variables (#330)

• v3.3.0 Changes

  ➕ Added

  • ➕ Added default parameter to argument().multiple() (#305)
  • 💻 Context.originalArgv that allows you to read the command line arguments from within a command's run (#290)
  • context { envarReader = {...} } to set a custom function to read from environment variables (#299)

  🔄 Changed

  • 0️⃣ defaultLazy values can now reference other parameters, as long the referenced parameters do not also reference other parameters
  • 🏗 You can now call CliktCommand.context multiple times on the same command, and all builder blocks will be applied
  • Validate values entered to a prompt option, and show another prompt if the validation fails (#288)
  • ⚡️ Updated kotlin to 1.5.31

  🛠 Fixed

  • Report error when excess arguments are given to a command with allowMultipleSubcommands=true (#303)

• v3.2.0 Changes

  2021-05-14

  ➕ Added

  • 0️⃣ InputStream.isCliktParameterDefaultStdin and OutputStream.isCliktParameterDefaultStdout to check if the streams returned from inputStream/outputStream options are proxying stdin/stdout (#272)

  🔄 Changed

  • 👉 Make parameters of mutuallyExclusiveOptions covariant to allow validation without explicit type annotations. (#265)
  • ⚡️ Updated kotlin to 1.5.0

  🛠 Fixed

  • Reading from an option or argument property on a command that hasn't been invoked will now always throw an IllegalStateException

• v3.1.0 Changes

  December 12, 2020

  2020-12-12

  ➕ Added

  • ➕ Added required() and defaultLazy() for nullable flag options like switch(). (#240)
  • ➕ Added support for generating autocomplete scripts for Fish shells (#189)
  • ➕ Added CompletionCommand and CliktCommand.completionOption() that will print an autocomplete script when invoked, as an alternative to using environment variables.

  🔄 Changed

  • ⚡️ Updated Kotlin to 1.4.21
  • @argfiles now allow line breaks in quoted values, which are included in the value verbatim. You can now end lines with \ to concatenate them with the following line. (#248)

• v3.0.1 Changes

  September 03, 2020

  2020-09-03

  🗄 Deprecated

  • 🗄 Deprecated calling echo with err or lineSeparator but no message.

• v3.0.0 Changes

  September 02, 2020

  2020-09-02

  ➕ Added

  • 💻 Clikt's JS target now supports both NodeJS and Browsers. (#198)
  • 0️⃣ Default values for switch options are now shown in the help. Help text can be customized using the defaultForHelp argument, similar to normal options. (#205)
  • ➕ Added FlagOption.convert (#208)
  • ➕ Added ability to use unicode NEL character (\u0085) to manually break lines in help output (#214)
  • ➕ Added help("") extension to options and arguments as an alternative to passing the help as an argument (#207)
  • ➕ Added valueSourceKey parameter to option
  • ➕ Added check() extensions to options and arguments as an alternative to validate()
  • ➕ Added prompt and confirm functions to CliktCommand that call the TermUi equivalents with the current console.
  • ➕ Added echo() overload with no parameters to CliktCommand that prints a newline by itself.
  • ➕ Added localization support. You can set an implementation of the Localization interface on your context with your translations. (#227)

  🛠 Fixed

  • Hidden options will no longer be suggested as possible typo corrections. (#202)
  • Options and Arguments with multiple(required=true) will now show as required in help output. (#212)
  • Multiple short lines in a help text paragraph no longer appear dedented (#215)

  🔄 Changed

  • ⚡️ Updated Kotlin to 1.4.0
  • Argument.help and Option.help properties have been renamed to argumentHelp and optionHelp, respectively. The help parameter names to option() and argument() are unchanged.
  • commandHelp and commandHelpEpilog properties on CliktCommand are now open, so you can choose to override them instead of passing help and epilog to the constructor.
  • 0️⃣ Replaced MapValueSource.defaultKey with ValueSource.getKey(), which is more customizable.
  • Option.metavar, Option.parameterHelp, OptionGroup.parameterHelp and Argument.parameterHelp properties are now functions.
  • 🔄 Changed constructor parameters of CliktHelpFormatter. Added localization and removed usageTitle, optionsTitle, argumentsTitle, commandsTitle, optionsMetavar, and commandMetavar. Those strings are now defined on equivalently named functions on Localization.

  ✂ Removed

  • ✂ Removed envvarSplit parameter from option() and convert(). Option values from environment variables are no longer split automatically. (#177)
  • ✂ Removed public constructors from the following classes: ProcessedArgument, OptionWithValues, FlagOption, CoOccurringOptionGroup, ChoiceGroup, MutuallyExclusiveOptions.
  • 👻 MissingParameter exception replaced with MissingOption and MissingArgument
  • ✂ Removed Context.helpOptionMessage. Override Localization.helpOptionMessage and set it on your context instead.

  🗄 Deprecated

  • @ExperimentalCompletionCandidates and @ExperimentalValueSourceApi annotations. These APIs no longer require an opt-in.

• v3.0.0-rc

  August 27, 2020

• 1
• 2
• 3
• Next ›
• Last »