From 81a6dd91198fc7571dac28f17234e75ec3eb0999 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 1 Nov 2024 13:59:33 +0100 Subject: [PATCH] fix(deps): update dependency com.github.ajalt.clikt:clikt to v5 (#1023) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.github.ajalt.clikt:clikt](https://redirect.github.com/ajalt/clikt) | `4.4.0` -> `5.0.1` | [![age](https://developer.mend.io/api/mc/badges/age/maven/com.github.ajalt.clikt:clikt/5.0.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/com.github.ajalt.clikt:clikt/5.0.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/com.github.ajalt.clikt:clikt/4.4.0/5.0.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/com.github.ajalt.clikt:clikt/4.4.0/5.0.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes
ajalt/clikt (com.github.ajalt.clikt:clikt) ### [`v5.0.1`](https://redirect.github.com/ajalt/clikt/blob/HEAD/CHANGELOG.md#501) [Compare Source](https://redirect.github.com/ajalt/clikt/compare/5.0.0...5.0.1) ##### Added - Added completion commands for suspending and chained commands. ([#​553](https://redirect.github.com/ajalt/clikt/pull/553)) - Added no-op suspending commands. ([#​554](https://redirect.github.com/ajalt/clikt/pull/554)) ##### Changed - Unknown option errors and missing argument errors that occur at the same time will now both be reported. ([#​553](https://redirect.github.com/ajalt/clikt/pull/553)) ### [`v5.0.0`](https://redirect.github.com/ajalt/clikt/blob/HEAD/CHANGELOG.md#500) [Compare Source](https://redirect.github.com/ajalt/clikt/compare/4.4.0...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](https://redirect.github.com/ajalt/clikt/pull/517)) - Added `associate{}`, `associateBy{}`, and `associateWith{}` transforms for options that allow you to convert the keys and values of the map. ([#​529](https://redirect.github.com/ajalt/clikt/pull/529)) - Added support for aliasing options to other options. ([#​535](https://redirect.github.com/ajalt/clikt/pull/535)) - Added `limit` and `ignoreCase` parameters to `option().split()`. ([#​541](https://redirect.github.com/ajalt/clikt/pull/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 ##### Fixed - Fixed excess arguments not being reported when `allowMultipleSubcommands=true` and a subcommand has excess arguments followed by another subcommand. - Commands with `printHelpOnEmptyArgs=true` will no longer print help if an option has a value from an environment variable or value source. ([#​382](https://redirect.github.com/ajalt/clikt/pull/382)) ##### Deprecated - Deprecated `Context.originalArgv`. It will now always return an empty list. If your commands need an argv, you can pass it to them before you run them, or set in on the new `Context.data` map. - Deprecated `Context.expandArgumentFiles`. Use `Context.argumentFileReader` instead. - Renamed the following `Context` fields to be more consistent. The old names are deprecated. | old name | new name | |-------------------------------|---------------------------------| | `Context.envvarReader` | `Context.readEnvvar` | | `Context.correctionSuggestor` | `Context.suggestTypoCorrection` | | `Context.argumentFileReader` | `Context.readArgumentFile` | | `Context.tokenTransformer` | `Context.transformToken` | ##### Removed - Removed previously deprecated experimental annotations. - Removed `MordantHelpFormatter.graphemeLength` - Removed `TermUi`
--- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/pachli/pachli-android). --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Nik Clayton --- gradle/libs.versions.toml | 2 +- .../src/main/kotlin/app/pachli/mklanguages/Main.kt | 6 +++++- .../src/main/kotlin/app/pachli/mkserverversions/Main.kt | 6 +++++- tools/mvstring/src/main/kotlin/app/pachli/mvstring/Main.kt | 6 +++++- 4 files changed, 16 insertions(+), 4 deletions(-) diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 433c926fa..d071040c9 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -79,7 +79,7 @@ xmlwriter = "1.0.4" # Tool dependencies betterparse = "0.4.4" -clikt = "4.4.0" +clikt = "5.0.1" icu4j = "76.1" junit-jupiter = "5.11.3" kotlin-logging-jvm = "7.0.0" diff --git a/tools/mklanguages/src/main/kotlin/app/pachli/mklanguages/Main.kt b/tools/mklanguages/src/main/kotlin/app/pachli/mklanguages/Main.kt index fd6675bb3..efb54963a 100644 --- a/tools/mklanguages/src/main/kotlin/app/pachli/mklanguages/Main.kt +++ b/tools/mklanguages/src/main/kotlin/app/pachli/mklanguages/Main.kt @@ -20,7 +20,9 @@ package app.pachli.mklanguages import ch.qos.logback.classic.Level import ch.qos.logback.classic.Logger import com.github.ajalt.clikt.core.CliktCommand +import com.github.ajalt.clikt.core.Context import com.github.ajalt.clikt.core.UsageError +import com.github.ajalt.clikt.core.main import com.github.ajalt.clikt.parameters.options.flag import com.github.ajalt.clikt.parameters.options.option import com.github.h0tk3y.betterParse.grammar.parseToEnd @@ -82,9 +84,11 @@ data class Language( * * Run with `gradlew :tools:mklanguages:run` or `runtools mklanguages`. */ -class App : CliktCommand(help = """Update languages in donottranslate.xml""") { +class App : CliktCommand() { private val verbose by option("-n", "--verbose", help = "show additional information").flag() + override fun help(context: Context) = "Update languages in donottranslate.xml" + /** * Returns the full path to the Pachli `.../app/src/main/res` directory, starting from the * given [start] directory, walking up the tree if it can't be found there. diff --git a/tools/mkserverversions/src/main/kotlin/app/pachli/mkserverversions/Main.kt b/tools/mkserverversions/src/main/kotlin/app/pachli/mkserverversions/Main.kt index caa1f2317..9bf8d4128 100644 --- a/tools/mkserverversions/src/main/kotlin/app/pachli/mkserverversions/Main.kt +++ b/tools/mkserverversions/src/main/kotlin/app/pachli/mkserverversions/Main.kt @@ -22,7 +22,9 @@ import ch.qos.logback.classic.Level import ch.qos.logback.classic.Logger import com.apollographql.apollo3.ApolloClient import com.github.ajalt.clikt.core.CliktCommand +import com.github.ajalt.clikt.core.Context import com.github.ajalt.clikt.core.UsageError +import com.github.ajalt.clikt.core.main import com.github.ajalt.clikt.parameters.options.flag import com.github.ajalt.clikt.parameters.options.option import com.squareup.moshi.Moshi @@ -42,9 +44,11 @@ private val log = KotlinLogging.logger {} const val DEST_DIR = "core/network/src/test/resources" -class App : CliktCommand(help = """Update server-versions.json5""") { +class App : CliktCommand() { private val verbose by option("-n", "--verbose", help = "show additional information").flag() + override fun help(context: Context) = "Update server-versions.json5" + /** * Returns the full path to the Pachli `.../core/network/src/test/resources` directory, * starting from the given [start] directory, walking up the tree if it can't be found diff --git a/tools/mvstring/src/main/kotlin/app/pachli/mvstring/Main.kt b/tools/mvstring/src/main/kotlin/app/pachli/mvstring/Main.kt index 658142b26..2e9dce04c 100644 --- a/tools/mvstring/src/main/kotlin/app/pachli/mvstring/Main.kt +++ b/tools/mvstring/src/main/kotlin/app/pachli/mvstring/Main.kt @@ -20,7 +20,9 @@ package app.pachli.mvstring import ch.qos.logback.classic.Level import ch.qos.logback.classic.Logger import com.github.ajalt.clikt.core.CliktCommand +import com.github.ajalt.clikt.core.Context import com.github.ajalt.clikt.core.UsageError +import com.github.ajalt.clikt.core.main import com.github.ajalt.clikt.parameters.arguments.argument import com.github.ajalt.clikt.parameters.arguments.multiple import com.github.ajalt.clikt.parameters.options.default @@ -50,13 +52,15 @@ private val log = KotlinLogging.logger {} * * Run with `gradlew :tools:mvstring:run` or `runtools mvstring`. */ -class App : CliktCommand(help = """Move string resources between modules""") { +class App : CliktCommand() { private val args by argument().multiple() private val verbose by option("-v", "--verbose", help = "show additional information").flag() private val srcVariant by option("--srcVariant").default("main") private val dstVariant by option("--dstVariant").default("main") + override fun help(context: Context) = "Move string resources between modules" + /** * Returns the full path to a module's `.../src/main/res` directory, starting from the * given [start] directory, walking up the tree if it can't be found there.