darwincereska/kargs
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

feat(init): init

Browse Source
This commit is contained in:
darwincereska
2025-11-18 03:03:08 -05:00
commit f6e7cdae89
12 changed files with 671 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
.gitignore vendored Normal file
View File

@@ -0,0 +1,32 @@
# Gradle build
.gradle/
build/
out/
# Kotlin/Java compiled files
*.class
*.jar
*.war
*.ear
# Gradle wrapper
gradle/wrapper/gradle-wrapper.jar
gradle.properties
#IDEs
#IntelliJ Idea
.idea/
*.iml
*.iws
*.ipr
#VS Code
.vscode/
# OS-Specific
.DS_Store
Thumbs.db
# Logs and Temporary
*.log
tmp/

50
build.gradle.kts Normal file
View File

@@ -0,0 +1,50 @@
plugins {
kotlin("jvm") version "2.2.21"
id("com.vanniktech.maven.publish") version "0.35.0"
}
group = "org.kargs"
version = "1.0.0"
repositories {
mavenCentral()
}
dependencies {
testImplementation(kotlin("test"))
implementation(kotlin("stdlib"))
implementation("org.jetbrains.kotlin:kotlin-reflect:2.2.21")
}
mavenPublishing {
publishToMavenCentral()
signAllPublications()
coordinates(group.toString(), "kargs", version.toString())
pom {
name = "Kargs"
description = "A cli parsing library."
inceptionYear = "2025"
url = "https://github.com/darwincereska/karg"
licenses {
license {
name = "MIT License"
url = "http://www.opensource.org/licenses/mit-license.php"
}
}
developers {
developer {
id = "darwincereska"
name = "Darwin Cereska"
url = "https://github.com/darwincereska"
}
}
scm {
url = "https://github.com/darwincereska/kargs"
connection = "scm:git:git://github.com/darwincereska/kargs.git"
developerConnection = "scm:git:ssh://git@github.com:darwincereska:kargs.git"
}
}
}

7
gradle/wrapper/gradle-wrapper.properties vendored Normal file
View File

@@ -0,0 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.0-bin.zip
networkTimeout=10000
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

248
gradlew vendored Executable file
View File

@@ -0,0 +1,248 @@
#!/bin/sh
#
# Copyright © 2015 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
#
##############################################################################
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
# This is normally unused
# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
warn () {
echo "$*"
} >&2
die () {
echo
echo "$*"
echo
exit 1
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD=java
if ! command -v java >/dev/null 2>&1
then
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
# shellcheck disable=SC2039,SC3045
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Collect all arguments for the java command:
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
# and any embedded shellness will be escaped.
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
# treated as '${Hostname}' itself on the command line.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
"$@"
# Stop when "xargs" is not available.
if ! command -v xargs >/dev/null 2>&1
then
die "xargs is not available"
fi
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"

93
gradlew.bat vendored Normal file
View File

@@ -0,0 +1,93 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@rem SPDX-License-Identifier: Apache-2.0
@rem
@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%"=="" set DIRNAME=.
@rem This is normally unused
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if %ERRORLEVEL% equ 0 goto execute
echo. 1>&2
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
echo. 1>&2
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
echo. 1>&2
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
echo location of your Java installation. 1>&2
goto fail
:execute
@rem Setup the command line
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
:end
@rem End local scope for the variables with windows NT shell
if %ERRORLEVEL% equ 0 goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
set EXIT_CODE=%ERRORLEVEL%
if %EXIT_CODE% equ 0 set EXIT_CODE=1
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
exit /b %EXIT_CODE%
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

1
settings.gradle Normal file
View File

@@ -0,0 +1 @@
rootProject.name = "karg"

23
src/main/kotlin/org/kargs/ArgType.kt Normal file
View File

@@ -0,0 +1,23 @@
package org.kargs
sealed class ArgType<T>(val typeName: String) {
abstract fun convert(value: String): T
object StringType : ArgType<kotlin.String>("String") {
override fun convert(value: String) = value
}
object IntType : ArgType<kotlin.Int>("Int") {
override fun convert(value: String) = value.toInt()
}
object BooleanType : ArgType<kotlin.Boolean>("Boolean") {
override fun convert(value: String) = value.toBoolean()
}
companion object {
val String: ArgType<kotlin.String> = StringType
val Int: ArgType<kotlin.Int> = IntType
val Boolean: ArgType<kotlin.Boolean> = BooleanType
}
}

26
src/main/kotlin/org/kargs/Argument.kt Normal file
View File

@@ -0,0 +1,26 @@
package org.kargs
import kotlin.properties.ReadWriteProperty
import kotlin.reflect.KProperty
class Argument<T>(
val type: ArgType<T>,
val name: String,
val description: String = "",
val required: Boolean = true
) : ReadWriteProperty<Any?, T?> {
private var _value: T? = null
var value: T?
get() = _value
set(v) { _value = v }
override fun getValue(thisRef: Any?, property: KProperty<*>): T? = _value
override fun setValue(thisRef: Any?, property: KProperty<*>, value: T?) { _value = value }
fun parseValue(input: String) {
_value = type.convert(input)
}
}

24
src/main/kotlin/org/kargs/Flag.kt Normal file
View File

@@ -0,0 +1,24 @@
package org.kargs
import kotlin.properties.ReadWriteProperty
import kotlin.reflect.KProperty
class Flag(
val longName: String,
val shortName: String? = null,
val description: String = "",
val default: Boolean = false
) : ReadWriteProperty<Any?, Boolean> {
private var _value = default
var value: Boolean
get() = _value
set(v) { _value = v }
override fun getValue(thisRef: Any?, property: KProperty<*>): Boolean = _value
override fun setValue(thisRef: Any?, property: KProperty<*>, value: Boolean) { _value = value }
fun setFlag() { _value = true }
}

28
src/main/kotlin/org/kargs/Option.kt Normal file
View File

@@ -0,0 +1,28 @@
package org.kargs
import kotlin.properties.ReadWriteProperty
import kotlin.reflect.KProperty
class Option<T>(
val type: ArgType<T>,
val longName: String,
val shortName: String? = null,
val description: String = "",
val required: Boolean = false,
val default: T? = null
) : ReadWriteProperty<Any?, T?> {
private var _value: T? = default
var value: T?
get() = _value
set(v) { _value = v }
override fun getValue(thisRef: Any?, property: KProperty<*>): T? = _value
override fun setValue(thisRef: Any?, property: KProperty<*>, value: T?) { _value = value }
fun parseValue(input: String) {
_value = type.convert(input)
}
}

98
src/main/kotlin/org/kargs/Parser.kt Normal file
View File

@@ -0,0 +1,98 @@
package org.kargs
class Parser(val programName: String) {
private val commands = mutableListOf<Subcommand>()
fun subcommands(vararg cmds: Subcommand) {
commands.addAll(cmds)
}
fun parse(args: Array<String>) {
if (args.isEmpty()) {
printGlobalHelp()
return
}
val cmdName = args[0]
val cmd = commands.firstOrNull { it.name == cmdName || it.aliases.contains(cmdName) }
if (cmd == null) {
println("Unknown command: $cmdName")
printGlobalHelp()
return
}
if (args.contains("--help") || args.contains("-h")) {
cmd.printHelp()
return
}
// Reflection: find all Option, Flag, Argument properties
val props = cmd::class.members.filterIsInstance<kotlin.reflect.KProperty<*>>()
val options = props.mapNotNull { it.getter.call(cmd) as? Option<*> }
val flags = props.mapNotNull { it.getter.call(cmd) as? Flag }
val arguments = props.mapNotNull { it.getter.call(cmd) as? Argument<*> }
// Parse args starting at index 1
var i = 1
while (i < args.size) {
val arg = args[i]
when {
arg.startsWith("--") -> {
val key = arg.removePrefix("--")
val option = options.firstOrNull { it.longName == key }
val flag = flags.firstOrNull { it.longName == key }
when {
option != null -> {
i++
if (i >= args.size) throw IllegalArgumentException("Missing value for option --$key")
option.parseValue(args[i])
}
flag != null -> flag.setFlag()
else -> println("Unknown option --$key")
}
}
arg.startsWith("-") -> {
val key = arg.removePrefix("-")
val option = options.firstOrNull { it.shortName == key }
val flag = flags.firstOrNull { it.shortName == key }
when {
option != null -> {
i++
if (i >= args.size) throw IllegalArgumentException("Missing value for option -$key")
option.parseValue(args[i])
}
flag != null -> flag.setFlag()
else -> println("Unknown option -$key")
}
}
else -> {
// Positional arguments
val nextArg = arguments.firstOrNull { it.value == null }
if (nextArg != null) {
nextArg.parseValue(arg)
} else {
println("Unexpected argument: $arg")
}
}
}
i++
}
// Execute the command
cmd.execute()
}
private fun printGlobalHelp() {
println("Usage: $programName <command> [options]")
println("\nCommands:")
commands.forEach {
println(" ${it.name}\t${it.description}")
}
}
}

41
src/main/kotlin/org/kargs/Subcommand.kt Normal file
View File

@@ -0,0 +1,41 @@
package org.kargs
abstract class Subcommand(
val name: String,
val description: String = "",
val aliases: List<String> = emptyList()
) {
abstract fun execute()
open fun printHelp() {
println("Usage: $name [options] [arguments]")
if (description.isNotEmpty()) println(description)
val props = this::class.members.filterIsInstance<kotlin.reflect.KProperty<*>>()
val options = props.mapNotNull { it.getter.call(this) as? Option<*> }
val flags = props.mapNotNull { it.getter.call(this) as? Flag }
val arguments = props.mapNotNull { it.getter.call(this) as? Argument<*> }
if (options.isNotEmpty()) {
println("\nOptions:")
options.forEach { o ->
println(" ${o.shortName?.let { "-$it, " } ?: ""}--${o.longName}\t${o.description}")
}
}
if (flags.isNotEmpty()) {
println("\nFlags:")
flags.forEach { f ->
println(" ${f.shortName?.let { "-$it, " } ?: ""}--${f.longName}\t${f.description}")
}
}
if (arguments.isNotEmpty()) {
println("\nArguments:")
arguments.forEach { a ->
println(" ${a.name}\t${a.description}")
}
}
}
}