Skip to content
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.

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

Fix string quoting in json sample #456

Merged
merged 1 commit into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion samples/json/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# JSON Configuration files

This example shows how to read option values from JSON files using the kotlinx.serialization library.
This example shows how to read option values from JSON files using the `kotlinx.serialization`
library. It reads config files from the `config.json` file located in this directory.

```
./runsample json subcommand
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ import com.github.ajalt.clikt.core.InvalidFileFormat
import com.github.ajalt.clikt.parameters.options.Option
import com.github.ajalt.clikt.sources.ValueSource
import kotlinx.serialization.SerializationException
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonArray
import kotlinx.serialization.json.JsonElement
import kotlinx.serialization.json.JsonObject
import kotlinx.serialization.json.*
import java.io.File

/**
Expand All @@ -27,10 +24,17 @@ class JsonValueSource(
}
if (cursor == null) return emptyList()

// This implementation interprets a list as multiple invocations, but you could also
// implement it as a single invocation with multiple values.
if (cursor is JsonArray) return cursor.map { ValueSource.Invocation.value(it) }
return ValueSource.Invocation.just(cursor)
try {
// This implementation interprets a list as multiple invocations, but you could also
// implement it as a single invocation with multiple values.
if (cursor is JsonArray) return cursor.map {
ValueSource.Invocation.value(it.jsonPrimitive.content)
}
return ValueSource.Invocation.just(cursor.jsonPrimitive.content)
} catch (e: IllegalArgumentException) {
// This implementation skips invalid values, but you could handle them differently.
return emptyList()
}
}

companion object {
Expand All @@ -41,12 +45,16 @@ class JsonValueSource(
Json.parseToJsonElement(file.readText()) as? JsonObject
?: throw InvalidFileFormat(file.path, "object expected", 1)
} catch (e: SerializationException) {
if (requireValid) throw InvalidFileFormat(file.name, e.message ?: "could not read file")
if (requireValid) {
throw InvalidFileFormat(file.name, e.message ?: "could not read file")
}
JsonObject(emptyMap())
}
return JsonValueSource(json)
}

fun from(file: String, requireValid: Boolean = false): JsonValueSource = from(File(file), requireValid)
fun from(file: String, requireValid: Boolean = false): JsonValueSource {
return from(File(file), requireValid)
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class Cli : CliktCommand(help = "An example using json files for configuration v
init {
context {
valueSources(
JsonValueSource.from(System.getProperty("user.dir") + "config.json"),
JsonValueSource.from(System.getProperty("user.dir") + "/config.json"),
JsonValueSource.from(System.getProperty("user.dir") + "/samples/json/config.json")
)
}
Expand Down