Skip to content

fix message for invalid uint / ulong #624

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.

Sign up for GitHub

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

Merged
ajalt merged 1 commit into from
Nov 5, 2025
Merged

fix message for invalid uint / ulong #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions clikt/api/clikt.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,6 +708,7 @@ public abstract interface class com/github/ajalt/clikt/output/Localization {
public abstract fun requiredMutexOption (Ljava/lang/String;)Ljava/lang/String;
public abstract fun stringMetavar ()Ljava/lang/String;
public abstract fun switchOptionEnvvar ()Ljava/lang/String;
public abstract fun uintConversionError (Ljava/lang/String;)Ljava/lang/String;
public abstract fun unclosedQuote ()Ljava/lang/String;
public abstract fun usageError ()Ljava/lang/String;
public abstract fun usageTitle ()Ljava/lang/String;
Expand Down Expand Up @@ -768,6 +769,7 @@ public final class com/github/ajalt/clikt/output/Localization$DefaultImpls {
public static fun requiredMutexOption (Lcom/github/ajalt/clikt/output/Localization;Ljava/lang/String;)Ljava/lang/String;
public static fun stringMetavar (Lcom/github/ajalt/clikt/output/Localization;)Ljava/lang/String;
public static fun switchOptionEnvvar (Lcom/github/ajalt/clikt/output/Localization;)Ljava/lang/String;
public static fun uintConversionError (Lcom/github/ajalt/clikt/output/Localization;Ljava/lang/String;)Ljava/lang/String;
public static fun unclosedQuote (Lcom/github/ajalt/clikt/output/Localization;)Ljava/lang/String;
public static fun usageError (Lcom/github/ajalt/clikt/output/Localization;)Ljava/lang/String;
public static fun usageTitle (Lcom/github/ajalt/clikt/output/Localization;)Ljava/lang/String;
Expand Down
3 changes: 3 additions & 0 deletions clikt/src/commonMain/kotlin/com/github/ajalt/clikt/output/Localization.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,9 @@ interface Localization {
/** Invalid value for a parameter of type [Int] or [Long] */
fun intConversionError(value: String) = "$value is not a valid integer"

/** Invalid value for a parameter of type [UInt] or [ULong] */
fun uintConversionError(value: String) = "$value is not a valid unsigned integer"

/** Invalid value for a parameter of type [Boolean] */
fun boolConversionError(value: String) = "$value is not a valid boolean"

Expand Down
2 changes: 1 addition & 1 deletion clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/types/uint.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import com.github.ajalt.clikt.parameters.transform.TransformContext


private val conversion: TransformContext.(String) -> UInt =
{ it.toUIntOrNull() ?: fail(context.localization.intConversionError(it)) }
{ it.toUIntOrNull() ?: fail(context.localization.uintConversionError(it)) }

/** Convert the argument values to an `UInt` */
fun RawArgument.uint(): ProcessedArgument<UInt, UInt> = convert(conversion = conversion)
Expand Down
2 changes: 1 addition & 1 deletion clikt/src/commonMain/kotlin/com/github/ajalt/clikt/parameters/types/ulong.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import com.github.ajalt.clikt.parameters.transform.TransformContext


private val conversion: TransformContext.(String) -> ULong =
{ it.toULongOrNull() ?: fail(context.localization.intConversionError(it)) }
{ it.toULongOrNull() ?: fail(context.localization.uintConversionError(it)) }

/** Convert the argument values to a `ULong` */
fun RawArgument.ulong(): ProcessedArgument<ULong, ULong> = convert(conversion = conversion)
Expand Down
2 changes: 1 addition & 1 deletion test/src/commonTest/kotlin/com/github/ajalt/clikt/parameters/types/UIntTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class UIntTest {
}

shouldThrow<BadParameterValue> { C().parse("--foo bar") }
.formattedMessage shouldBe "invalid value for --foo: bar is not a valid integer"
.formattedMessage shouldBe "invalid value for --foo: bar is not a valid unsigned integer"

shouldThrow<NoSuchOption> { C().parse("-2") }
shouldThrow<BadParameterValue> { C().parse("--foo=-1") }
Expand Down
2 changes: 1 addition & 1 deletion test/src/commonTest/kotlin/com/github/ajalt/clikt/parameters/types/ULongTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class ULongTest {
}

shouldThrow<BadParameterValue> { C().parse("--foo bar") }
.formattedMessage shouldBe "invalid value for --foo: bar is not a valid integer"
.formattedMessage shouldBe "invalid value for --foo: bar is not a valid unsigned integer"

shouldThrow<NoSuchOption> { C().parse("-2") }
shouldThrow<BadParameterValue> { C().parse("--foo=-1") }
Expand Down