Infendro/cli.kt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Wiki Activity

1.4.1 release #10

Merged
Infendro merged 8 commits from develop into main 2026-01-29 16:48:33 +00:00
Conversation 0 Commits 8 Files Changed 40 +137 -120
40 changed files with 137 additions and 120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
.gitea/workflows/main.yaml
View File

@@ -1,36 +0,0 @@
on:
push:
branches:
- main
env:
INFENDRO__TOKEN: ${{ secrets.TOKEN }}
jobs:
publish:
runs-on: linux
steps:
- uses: actions/checkout@v4
- uses: actions/cache/restore@v4
with:
key: gradle
path: |
~/.gradle/caches/
~/.gradle/wrapper/
~/.konan/
- uses: actions/setup-java@v4
with:
java-version: '24'
distribution: 'temurin'
- run: ./gradlew publish
- uses: actions/cache/save@v4
with:
key: gradle
path: |
~/.gradle/caches/
~/.gradle/wrapper/
~/.konan/

47
.gitea/workflows/publish.yaml Normal file
View File

@@ -0,0 +1,47 @@
on:
push:
branches: [ main ]
jobs:
publish:
runs-on: linux
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Java
uses: actions/setup-java@v4
with:
java-version: '24'
distribution: 'temurin'
- name: Cache Gradle
uses: actions/cache@v4
with:
key: gradle-${{ hashFiles('**/libs.versions.toml') }}
restore-keys: gradle
path: |
~/.gradle/caches/
~/.gradle/wrapper/
- name: Cache Konan
uses: actions/cache@v4
with:
key: konan-${{ hashFiles('**/libs.versions.toml') }}
restore-keys: konan
path: |
~/.konan/
- name: Cache Node
uses: actions/cache@v4
with:
key: node-${{ hashFiles('**/libs.versions.toml') }}
restore-keys: node
path: |
~/.gradle/nodejs
~/.gradle/yarn
- name: Publish
run: ./gradlew publish
env:
INFENDRO__TOKEN: ${{ secrets.TOKEN }}

11
README.md
View File

@@ -2,15 +2,6 @@
`cli-kt` is a Kotlin Multiplatform framework for implementing terminal applications.
## Targets
| Target | Status |
|------------------|---------------|
| JVM | Supported |
| JavaScript | Supported |
| Native (Linux) | Supported |
| Native (Windows) | Not Supported |
## Installation
Add the following to your `build.gradle.kts`.
@@ -21,7 +12,7 @@ repositories {
}
dependencies {
implementation("com.infendro:cli:1.4.0")
implementation("com.infendro:cli:1.4.1")
}
```

15
build.gradle.kts
View File

@@ -1,8 +1,11 @@
@file:OptIn(ExperimentalWasmDsl::class)
import com.infendro.plugin.infendro
import com.infendro.plugin.token
import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
group = "com.infendro"
version = "1.4.0"
version = "1.4.1"
plugins {
alias(libs.plugins.infendro)
@@ -12,10 +15,14 @@ plugins {
kotlin {
jvm()
js {
nodejs()
}
linuxX64()
linuxArm64()
mingwX64()
macosX64()
macosArm64()
js { nodejs() }
wasmJs { nodejs() }
wasmWasi { nodejs() }
repositories {
mavenCentral()

2
gradle/libs.versions.toml
View File

@@ -1,6 +1,6 @@
[versions]
infendro = "1.0.0"
kotlin = "2.2.21"
kotlin = "2.3.0"
[plugins]
infendro = { id = "com.infendro.plugin", version.ref = "infendro" }

6
src/commonMain/kotlin/com/infendro/cli/command/argument/Argument.kt → src/commonMain/kotlin/com/infendro/cli/argument/Argument.kt
View File

@@ -1,7 +1,7 @@
package com.infendro.cli.command.argument
package com.infendro.cli.argument
import com.infendro.cli.error.build.InvalidArgumentName
import com.infendro.cli.error.build.InvalidRange
import com.infendro.cli.exception.InvalidArgumentName
import com.infendro.cli.exception.InvalidRange
import com.infendro.cli.parser.Parser
import com.infendro.cli.util.Regex.ARGUMENT

2
src/commonMain/kotlin/com/infendro/cli/command/argument/ArgumentFactory.kt → src/commonMain/kotlin/com/infendro/cli/argument/ArgumentFactory.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.command.argument
package com.infendro.cli.argument
import com.infendro.cli.parser.*

8
src/commonMain/kotlin/com/infendro/cli/command/Command.kt
View File

@@ -1,13 +1,13 @@
package com.infendro.cli.command
import com.infendro.cli.Dsl
import com.infendro.cli.command.argument.Argument
import com.infendro.cli.argument.Argument
import com.infendro.cli.command.context.Context
import com.infendro.cli.command.context.ContextParser
import com.infendro.cli.command.help.DefaultHelpRenderer
import com.infendro.cli.command.help.HelpRenderer
import com.infendro.cli.command.option.Option
import com.infendro.cli.error.build.*
import com.infendro.cli.exception.*
import com.infendro.cli.option.Option
import com.infendro.cli.parser.Parser
import com.infendro.cli.util.Regex
@@ -33,7 +33,7 @@ sealed class Command private constructor(
if (help != null) print(help)
}
is ContextParser.Result.Failure -> {
println("error: ${result.failure.message}")
println("error: ${result.error.message}")
val command = result.path.last()
val help = command.renderer.render(result.path)
if (help != null) print("\n$help")

4
src/commonMain/kotlin/com/infendro/cli/command/context/Context.kt
View File

@@ -2,8 +2,8 @@ package com.infendro.cli.command.context
import com.infendro.cli.Dsl
import com.infendro.cli.command.Command
import com.infendro.cli.command.argument.Argument
import com.infendro.cli.command.option.Option
import com.infendro.cli.argument.Argument
import com.infendro.cli.option.Option
import kotlin.reflect.KProperty
@Dsl

12
src/commonMain/kotlin/com/infendro/cli/command/context/ContextParser.kt
View File

@@ -1,7 +1,7 @@
package com.infendro.cli.command.context
import com.infendro.cli.command.Command
import com.infendro.cli.error.run.*
import com.infendro.cli.error.*
import com.infendro.cli.parser.Parser
internal class ContextParser(
@@ -19,13 +19,13 @@ internal class ContextParser(
data class Failure(
val path: List<Command>,
val failure: RuntimeFailure,
val error: Error,
) : Result()
}
private fun success(context: Context) = Result.Success(context)
private fun help(path: List<Command>) = Result.Help(path)
private fun failure(path: List<Command>, exception: RuntimeFailure) = Result.Failure(path, exception)
private fun failure(path: List<Command>, error: Error) = Result.Failure(path, error)
private var index = 0
private val current: String
@@ -63,7 +63,7 @@ internal class ContextParser(
if (cmd is Command.Fallback<*>) {
val value = when (val result = cmd.parser.parse(current)) {
is Parser.Result.Success<*> -> result.value
is Parser.Result.Failure<*> -> return failure(path, result.failure)
is Parser.Result.Failure<*> -> return failure(path, result.error)
}
commands[cmd.key] = value
}
@@ -91,7 +91,7 @@ internal class ContextParser(
val value = when (val result = argument.parser.parse(current)) {
is Parser.Result.Success<*> -> result.value
is Parser.Result.Failure<*> -> return failure(path, result.failure)
is Parser.Result.Failure<*> -> return failure(path, result.error)
}
arguments[argument]!! += value
argumentCount++
@@ -141,7 +141,7 @@ internal class ContextParser(
text != null ->
when (val result = option.parser.parse(text)) {
is Parser.Result.Success<*> -> result.value
is Parser.Result.Failure<*> -> return failure(path, result.failure)
is Parser.Result.Failure<*> -> return failure(path, result.error)
}
option.flag -> option.fallback!!
else -> return failure(path, MissingOptionValue(option))

4
src/commonMain/kotlin/com/infendro/cli/command/help/DefaultHelpRenderer.kt
View File

@@ -1,8 +1,8 @@
package com.infendro.cli.command.help
import com.infendro.cli.command.Command
import com.infendro.cli.command.argument.Argument
import com.infendro.cli.command.option.Option
import com.infendro.cli.argument.Argument
import com.infendro.cli.option.Option
import kotlin.reflect.KClass
object DefaultHelpRenderer : HelpRenderer {

5
src/commonMain/kotlin/com/infendro/cli/error/Error.kt Normal file
View File

@@ -0,0 +1,5 @@
package com.infendro.cli.error
abstract class Error {
abstract val message: String
}

6
src/commonMain/kotlin/com/infendro/cli/error/run/InvalidArgumentCount.kt → src/commonMain/kotlin/com/infendro/cli/error/InvalidArgumentCount.kt
View File

@@ -1,11 +1,11 @@
package com.infendro.cli.error.run
package com.infendro.cli.error
import com.infendro.cli.command.argument.Argument
import com.infendro.cli.argument.Argument
class InvalidArgumentCount(
val argument: Argument<*>,
val count: Int,
) : RuntimeFailure() {
) : Error() {
override val message: String
get() {
val expected = when {

6
src/commonMain/kotlin/com/infendro/cli/error/run/InvalidOptionCount.kt → src/commonMain/kotlin/com/infendro/cli/error/InvalidOptionCount.kt
View File

@@ -1,11 +1,11 @@
package com.infendro.cli.error.run
package com.infendro.cli.error
import com.infendro.cli.command.option.Option
import com.infendro.cli.option.Option
class InvalidOptionCount(
val option: Option<*>,
val count: Int,
) : RuntimeFailure() {
) : Error() {
override val message: String
get() {
val expected = when {

4
src/commonMain/kotlin/com/infendro/cli/error/run/InvalidValue.kt → src/commonMain/kotlin/com/infendro/cli/error/InvalidValue.kt
View File

@@ -1,11 +1,11 @@
package com.infendro.cli.error.run
package com.infendro.cli.error
import kotlin.reflect.KClass
class InvalidValue(
val value: String,
val type: KClass<*>,
) : RuntimeFailure() {
) : Error() {
override val message: String
get() = """"$value" cannot be converted to ${type.simpleName ?: "Unknown"}."""
}

4
src/commonMain/kotlin/com/infendro/cli/error/run/MalformedOption.kt → src/commonMain/kotlin/com/infendro/cli/error/MalformedOption.kt
View File

@@ -1,8 +1,8 @@
package com.infendro.cli.error.run
package com.infendro.cli.error
class MalformedOption(
val option: String,
) : RuntimeFailure() {
) : Error() {
override val message: String
get() = """Malformed option "$option"."""
}

6
src/commonMain/kotlin/com/infendro/cli/error/run/MissingOptionValue.kt → src/commonMain/kotlin/com/infendro/cli/error/MissingOptionValue.kt
View File

@@ -1,10 +1,10 @@
package com.infendro.cli.error.run
package com.infendro.cli.error
import com.infendro.cli.command.option.Option
import com.infendro.cli.option.Option
class MissingOptionValue(
val option: Option<*>,
) : RuntimeFailure() {
) : Error() {
override val message: String
get() = """No value provided for option "${option.name}"."""
}

4
src/commonMain/kotlin/com/infendro/cli/error/run/UnexpectedArgument.kt → src/commonMain/kotlin/com/infendro/cli/error/UnexpectedArgument.kt
View File

@@ -1,8 +1,8 @@
package com.infendro.cli.error.run
package com.infendro.cli.error
class UnexpectedArgument(
val argument: String,
) : RuntimeFailure() {
) : Error() {
override val message: String
get() = """Unexpected argument "$argument"."""
}

4
src/commonMain/kotlin/com/infendro/cli/error/run/UnknownCommand.kt → src/commonMain/kotlin/com/infendro/cli/error/UnknownCommand.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.run
package com.infendro.cli.error
import com.infendro.cli.command.Command
import com.infendro.cli.util.distance
@@ -8,7 +8,7 @@ import kotlin.math.min
class UnknownCommand(
val command: Command,
val name: String,
) : RuntimeFailure() {
) : Error() {
override val message: String
get() = buildString {
val suggestion = command.commands

4
src/commonMain/kotlin/com/infendro/cli/error/run/UnknownOption.kt → src/commonMain/kotlin/com/infendro/cli/error/UnknownOption.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.run
package com.infendro.cli.error
import com.infendro.cli.command.Command
import com.infendro.cli.util.distance
@@ -8,7 +8,7 @@ import kotlin.math.min
class UnknownOption(
val command: Command,
val name: String,
) : RuntimeFailure() {
) : Error() {
override val message: String
get() = buildString {
val suggestion = command.options

3
src/commonMain/kotlin/com/infendro/cli/error/build/BuildException.kt
View File

@@ -1,3 +0,0 @@
package com.infendro.cli.error.build
abstract class BuildException : Exception()

5
src/commonMain/kotlin/com/infendro/cli/error/run/RuntimeFailure.kt
View File

@@ -1,5 +0,0 @@
package com.infendro.cli.error.run
abstract class RuntimeFailure {
abstract val message: String
}

5
src/commonMain/kotlin/com/infendro/cli/exception/BuildException.kt Normal file
View File

@@ -0,0 +1,5 @@
package com.infendro.cli.exception
abstract class BuildException : Exception() {
abstract override val message: String
}

4
src/commonMain/kotlin/com/infendro/cli/error/build/DuplicateArgument.kt → src/commonMain/kotlin/com/infendro/cli/exception/DuplicateArgument.kt
View File

@@ -1,6 +1,6 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
import com.infendro.cli.command.argument.Argument
import com.infendro.cli.argument.Argument
class DuplicateArgument(
val argument: Argument<*>,

2
src/commonMain/kotlin/com/infendro/cli/error/build/DuplicateCommand.kt → src/commonMain/kotlin/com/infendro/cli/exception/DuplicateCommand.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
import com.infendro.cli.command.Command

2
src/commonMain/kotlin/com/infendro/cli/error/build/DuplicateExecute.kt → src/commonMain/kotlin/com/infendro/cli/exception/DuplicateExecute.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
class DuplicateExecute : BuildException() {
override val message: String

4
src/commonMain/kotlin/com/infendro/cli/error/build/DuplicateOption.kt → src/commonMain/kotlin/com/infendro/cli/exception/DuplicateOption.kt
View File

@@ -1,6 +1,6 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
import com.infendro.cli.command.option.Option
import com.infendro.cli.option.Option
class DuplicateOption(
val option: Option<*>,

2
src/commonMain/kotlin/com/infendro/cli/error/build/DuplicateRenderer.kt → src/commonMain/kotlin/com/infendro/cli/exception/DuplicateRenderer.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
class DuplicateRenderer : BuildException() {
override val message: String

2
src/commonMain/kotlin/com/infendro/cli/error/build/InvalidArgumentName.kt → src/commonMain/kotlin/com/infendro/cli/exception/InvalidArgumentName.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
class InvalidArgumentName(
val name: String,

2
src/commonMain/kotlin/com/infendro/cli/error/build/InvalidArgumentOrder.kt → src/commonMain/kotlin/com/infendro/cli/exception/InvalidArgumentOrder.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
class InvalidArgumentOrder : BuildException() {
override val message: String

2
src/commonMain/kotlin/com/infendro/cli/error/build/InvalidCommandName.kt → src/commonMain/kotlin/com/infendro/cli/exception/InvalidCommandName.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
class InvalidCommandName(
val name: String,

2
src/commonMain/kotlin/com/infendro/cli/error/build/InvalidCommandOrder.kt → src/commonMain/kotlin/com/infendro/cli/exception/InvalidCommandOrder.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
class InvalidCommandOrder : BuildException() {
override val message: String

2
src/commonMain/kotlin/com/infendro/cli/error/build/InvalidFallback.kt → src/commonMain/kotlin/com/infendro/cli/exception/InvalidFallback.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
class InvalidFallback : BuildException() {
override val message: String

2
src/commonMain/kotlin/com/infendro/cli/error/build/InvalidOptionName.kt → src/commonMain/kotlin/com/infendro/cli/exception/InvalidOptionName.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
class InvalidOptionName(
val name: String,

2
src/commonMain/kotlin/com/infendro/cli/error/build/InvalidRange.kt → src/commonMain/kotlin/com/infendro/cli/exception/InvalidRange.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
class InvalidRange : BuildException() {
override val message: String

2
src/commonMain/kotlin/com/infendro/cli/error/build/MissingOptionName.kt → src/commonMain/kotlin/com/infendro/cli/exception/MissingOptionName.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.error.build
package com.infendro.cli.exception
class MissingOptionName : BuildException() {
override val message: String

8
src/commonMain/kotlin/com/infendro/cli/command/option/Option.kt → src/commonMain/kotlin/com/infendro/cli/option/Option.kt
View File

@@ -1,8 +1,8 @@
package com.infendro.cli.command.option
package com.infendro.cli.option
import com.infendro.cli.error.build.InvalidOptionName
import com.infendro.cli.error.build.InvalidRange
import com.infendro.cli.error.build.MissingOptionName
import com.infendro.cli.exception.InvalidOptionName
import com.infendro.cli.exception.InvalidRange
import com.infendro.cli.exception.MissingOptionName
import com.infendro.cli.parser.Parser
import com.infendro.cli.util.Regex.OPTION

2
src/commonMain/kotlin/com/infendro/cli/command/option/OptionFactory.kt → src/commonMain/kotlin/com/infendro/cli/option/OptionFactory.kt
View File

@@ -1,4 +1,4 @@
package com.infendro.cli.command.option
package com.infendro.cli.option
import com.infendro.cli.parser.*

6
src/commonMain/kotlin/com/infendro/cli/parser/Parser.kt
View File

@@ -1,7 +1,7 @@
package com.infendro.cli.parser
import com.infendro.cli.error.run.InvalidValue
import com.infendro.cli.error.run.RuntimeFailure
import com.infendro.cli.error.Error
import com.infendro.cli.error.InvalidValue
import kotlin.reflect.KClass
abstract class Parser<T : Any>(
@@ -13,7 +13,7 @@ abstract class Parser<T : Any>(
) : Result<T>()
data class Failure<T : Any>(
val failure: RuntimeFailure,
val error: Error,
) : Result<T>()
}

8
src/commonMain/kotlin/com/infendro/cli/util/Distance.kt
View File

@@ -3,7 +3,13 @@ package com.infendro.cli.util
internal const val threshold = 2
/**
* Damerau-Levenshtein string distance
* Calculates the Damerau-Levenshtein distance between two strings.
*
* The distance is the minimum number of operations (insertion, deletion, substitution, and transposition) required to transform one string into another.
*
* @param a The source string.
* @param b The target string.
* @return The minimum number of operations to transform [a] into [b].
*/
internal fun distance(a: String, b: String): Int {
if (a == b) return 0