All Versions
17
Latest Version
Avg Release Cycle
48 days
Latest Release
10 days ago

Changelog History
Page 1

  • v2.7.1

    May 19, 2020

    🛠 Fixed

    • 🛠 Fixed NPE thrown when in some cases when using defaultByName (#179)
  • v2.7.0

    May 13, 2020

    ➕ Added

    • Ability to use custom program exit status codes via ProgramResult.
    • inputStream and outputStream conversions for options and arguments. (#157 and #159)
    • splitPair, toMap, and associate extensions on option. (#166)
    • treatUnknownOptionsAsArgs parameter to CliktCommand. (#152)
    • 0️⃣ defaultByName function for groupChoice and groupSwitch options. (#171)

    🔄 Changed

    • ⚡️ Update Kotlin to 1.3.71
    • 👌 Improved command name inference. Now, a class like MyAppCommand will infer its commandName as my-app rather than myappcommand. You can still specify the name manually as before. (#168)

    🛠 Fixed

    • 📜 Correctly parse short options with attached values that contain =

    🚀 Thanks to @sschuberth for his contributions to this release!

  • v2.6.0

    March 15, 2020

    ➕ Added

    • registeredSubcommands, registeredOptions, registeredArguments, and registeredParameterGroups methods on CliktCommand.
    • 👀 Ability to read default option values from configuration files and other sources. Support for Java property files is built in on JVM, see the json sample for an example of reading from other formats.
    • 📄 allowMultipleSubcommands parameter to CliktCommand that allows you to pass multiple subcommands in the same call. (docs)
    • ✏️ Errors from typos in subcommand names will now include suggested corrections. Corrections for options and subcommands are now based on a Jaro-Winkler similarity metric, and can be customized with Context.correctionSuggestor

    🔄 Changed

    • ⚡️ Update Kotlin to 1.3.70
    • convert can be called more than once on the same option or argument, including after calls to conversion functions like int and file.
    • 🗄 wrapValue is now deprecated, since convert can be used in its place instead.
    • CliktCommand.toString now includes the class name
    • Reverted automatic ~ expansion in file() and path() introduced in 2.5.0. If you need this behavior, you can implement it with code like convert { /* expand tidle */ }.file()
  • v2.5.0

    February 22, 2020

    ➕ Added

    • 🍎 Clikt is now available as a Kotlin Multiplatform Project, supporting JVM, NodeJS, and native Windows, Linux, and macOS.
    • eagerOption {} function to more easily register eager options.
    • Eager options can now be added to option groups in help out by passing a value for groupName when creating them.
    • canBeSymlink parameter to file() and path() conversions that can be used to disallow symlinks
    • CliktCommand.eagerOption to simplify creating custom eager options

    🔄 Changed

    • 🚚 The parameter names of file() and path() conversions have changed. The existing names are deprecated, and can be converted to the new usages with an IntelliJ inspection. Note that if you are calling these functions with unnamed arguments (e.g. file(true, false)), you'll need to add argument names in order to remove the deprecation warning.

    🗄 Deprecated

    • 🗄 The CliktCommand.context property has been deprecated in favor of the new name, currentContext, to avoid confusion with the CliktCommand.context{} method.
    • 🗄 NoRunCliktCommand was renamed to NoOpCliktCommand. The existing class is deprecated. (#130)

    🛠 Fixed

    • file() and path() conversions will now properly expand leading ~ in paths to the home directory for mustExist, canBeFile, and canBeDir checks. The property value is unchanged, and can still begin with a ~. (#131)
  • v2.5.0-beta1

    February 13, 2020
  • v2.4.0

    January 25, 2020

    ➕ Added

    • 🛠 CompletionCandidates.Fixed now has a secondary convenience constructor that take a vararg of Strings
    • CompletionCadidates.Custom, which allows you to call other binaries or write a script to generate completions. This class is currently experimental. (#79)
    • Option.wrapValue and Argument.wrapValue to make it easier to reuse existing conversion functions.
    • ignoreCase parameter to choice() and enum() conversion functions.

    🔄 Changed

    • 0️⃣ option() and argument() now take optional completionCandidates parameters to override how completion is generated. The constructor and copy functions of OptionsWithValues and ProcessedArgument have changed to support default values.
    • 🗄 The overloads of findObject (1 2) that take a default value have been renamed findOrSetObject. The existing names are marked with @Deprecated, and IntelliJ can convert your callsites automatically. (#110)
    • 0️⃣ enum() parameters now accept case-insensitive values by default. You change this behavior by passing ignoreCase = false to enum() (#115)

    🛠 Fixed

    • groupChoice help output now includes the choices in the help output metavar
    • TermUi.edit* functions could freeze on certain editors (#99, thanks @iampravikant and @sebokopter)
    • Shell completion can now handle command names with dashes. (#104)
    • Arguments with = in them could be incorrectly interpreted as options (#106)
  • v2.3.0

    November 07, 2019

    ➕ Added

    • option().groupSwitch(), which works like groupChoice(), but uses a switch() option rather than a choice() option.
    • 0️⃣ UsageError now has a statusCode parameter (which defaults to 1). If you're using ClicktCommand.main, the value of statusCode will be passed to exitProcess.

    🔄 Changed

    • 🖨 Shell completion code is now printed by throwing a PrintCompletionMessage (a subclass of PrintMessage) rather than calling echo directly.
  • v2.2.0

    September 25, 2019

    ➕ Added

    🔄 Changed

    🛠 Fixed

    • Help output missing items when no help text is specified. (#85)
    • Help output not grouping options in groups passed to groupChoice. (#88)
  • v2.1.0

    May 23, 2019

    ➕ Added

    • Ability to prevent rewrapping individual paragraphs in help output.
    • ➕ Added parameter required to Option.multiple() to require at least one instance of the option on the command line.

    🔄 Changed

    • CliktCommand.toString() now includes the names and values of all parameters and subcommands,

    🛠 Fixed

    • Create subcommand context when helpOptionNames is empty. (#64)
  • v2.0.0

    May 12, 2019

    ➕ Added

    🔄 Changed

    • 📜 If multiple -- tokens are present on the command line, all subsequent occurrences after the first are now parsed as positional arguments. Previously, subsequent -- tokens were skipped.
    • 👀 The PlaintextHelpFormatter has been replaced with CliktHelpFormatter, which is more customizable. See the docs for more info, or the [new sample](samples/ansicolors/README.md) for an example of customizing help output to use ANSI colors.
    • Some of the properties and constructor parameters for OptionWithValues and ProcessedArgument have changed.
    • The OptionDelegate interface has changed, and GroupableOption and ParameterHolder interfaces have been added to work with option groups.
    • Parameter validation now occurs after all parameter delegates have set their values, so the lambdas passed to validate may reference other parameters.