use json5 for user input

.run/CLI build.run.xml

@@ -2,7 +2,7 @@
   <configuration default="false" name="CLI compile fabricPack" type="JetRunConfigurationType">
     <module name="voodoo-parent.voodoo.main" />
     <option name="VM_PARAMETERS" value="" />
-    <option name="PROGRAM_PARAMETERS" value="--log TRACE compile fabricPack/152Version.voodoo.json fabricPack/164Version.voodoo.json" />
+    <option name="PROGRAM_PARAMETERS" value="--log TRACE compile fabricPack/152Version.voodoo.json5 fabricPack/164Version.voodoo.json5" />
     <option name="ALTERNATIVE_JRE_PATH_ENABLED" value="false" />
     <option name="ALTERNATIVE_JRE_PATH" />
     <option name="PASS_PARENT_ENVS" value="true" />

README.md

@@ -86,7 +86,7 @@ java -jar voodoo.jar init project
 ./voodoo init pack --id newPack --mcVersion 1.16.2
 
 # builds a pack
-./voodoo compile newPack/v0.0.1.voodoo.json
+./voodoo compile newPack/v0.0.1.voodoo.json5
 
 # packages for upload
 ./voodoo package --id mypack -p voodoo -p mmc-voodoo -p curse
@@ -135,10 +135,9 @@ Developing
 Support
 -------
 
-Feel welcome to post ideas and suggestions to our [tracker](https://github.com/DaemonicLabs/Voodoo/issues).
+Feel welcome to post ideas and suggestions to our [issue tracker](https://github.com/DaemonicLabs/Voodoo/issues).
 
-contact me directly in chat [![Discord](https://img.shields.io/discord/342696338556977153.svg?style=flat-square&label=%23ai-lab&logo=discord)](https://discord.gg/SRFkHfp)   
-or on irc `#unascribed` @ `irc.esper.net`
+contact me directly in chat [![Discord](https://img.shields.io/discord/342696338556977153.svg?style=flat-square&label=%23ai-lab&logo=discord)](https://discord.gg/SRFkHfp)
 
 How to contribute?
 ------------------

docs/index.md

@@ -72,7 +72,7 @@ java -jar voodoo.jar init project
 ./voodoo init pack --id newPack --mcVersion 1.16.2
 
 # builds a pack
-./voodoo compile newPack/v0.0.1.voodoo.json
+./voodoo compile newPack/v0.0.1.voodoo.json5
 
 # packages for upload
 ./voodoo package --id mypack -p voodoo -p mmc-voodoo -p curse
@@ -122,10 +122,9 @@ Developing
 Support
 =======
 
-Feel welcome to post ideas and suggestions to our [tracker](https://github.com/DaemonicLabs/Voodoo/issues).
+Feel welcome to post ideas and suggestions to our [issue tracker](https://github.com/DaemonicLabs/Voodoo/issues).
 
-contact me directly in chat [![Discord](https://img.shields.io/discord/342696338556977153.svg?style=flat-square&label=%23ai-lab&logo=discord)](https://discord.gg/SRFkHfp)   
-or on irc `#unascribed` @ `irc.esper.net`
+contact me directly in chat [![Discord](https://img.shields.io/discord/342696338556977153.svg?style=flat-square&label=%23ai-lab&logo=discord)](https://discord.gg/SRFkHfp)
 
 How to contribute?
 ==================

docs/quickstart.md

@@ -35,10 +35,10 @@ run the `generateSchema` command once to make it generate a `config.json` and `.
 ./voodoo generateSchema
 ```
 
-now you should see `config.json`
+now you should see `config.json5`
 
-`/config.json`
-```json
+`/config.json5`
+```json5
 {
     "$schema": "./schema/config.schema.json",
     "curseforgeGenerators": {
@@ -73,8 +73,8 @@ so `init` created a gitignore file
 
 we are interested in fabric and fabric mods on curseforge
 
-`/config.json`
-```json
+`/config.json5`
+```json5
 {
     "$schema": "./schema/config.schema.json",
     "curseforgeGenerators": {
@@ -132,8 +132,8 @@ try to keep them separate when maintaining multiple versions
 
 by default the modloader is set to `None`
 
-??? note "`/magicpack/v0.0.1.voodoo.json`"
-    ```json hl_lines="6 7 8"
+??? note "`/magicpack/v0.0.1.voodoo.json5`"
+    ```json5 hl_lines="6 7 8"
     {
       "$schema": "../schema/versionPack.schema.json",
       "version": "0.0.1",
@@ -149,8 +149,8 @@ by default the modloader is set to `None`
 
 lets replace with with fabric
 
-!!! note "`/magicpack/v0.0.1.voodoo.json`"
-    ```json hl_lines="6 7 8 9"
+!!! note "`/magicpack/v0.0.1.voodoo.json5`"
+    ```json5 hl_lines="6 7 8 9"
     {
       "$schema": "../schema/versionPack.schema.json",
       "version": "0.0.1",
@@ -202,8 +202,8 @@ there is multiple entry types that you can
 since we setup mods from curseforge with the name `Fabric` before, we can use them  
 so lets add some mods
 
-???+ note "`/magicpack/v0.0.1.voodoo.json`"
-    ```json hl_lines="10 11 12 13 14 15 16 17 18 19"
+???+ note "`/magicpack/v0.0.1.voodoo.json5`"
+    ```json5 hl_lines="10 11 12 13 14 15 16 17 18 19"
     {
       "$schema": "../schema/versionPack.schema.json",
       "version": "0.0.1",
@@ -233,7 +233,7 @@ so lets add some mods
 `compiling` the pack does resolve all dependencies of entries and pins versions
 
 ```bash
-voodoo compile magicpack/v0.0.1.voodoo.json
+voodoo compile magicpack/v0.0.1.voodoo.json5
 ```
 
 this created `/magicpack/lock/` folder containing the output artifacts
@@ -247,13 +247,13 @@ before deploying the pack, lets make sure it runs first
 before this make sure multimc is in your `PATH`
 
 ```bash
-voodoo launch multimc magicpack/v0.0.1.voodoo.json
+voodoo launch multimc magicpack/v0.0.1.voodoo.json5
 ```
 
 ## Packaging and Upload
 
 ```bash
-voodoo package magicpack/modpack/meta.json voodoo mmc-voodoo server
+voodoo package magicpack/modpack/meta.json5 voodoo mmc-voodoo server
 ```
 
 this created `/_upload/voodoo/`, `/_upload/multimc-voodoo` and `/_upload/server/`

samples/fabricpack/164Version.voodoo.json → samples/fabricpack/164Version.voodoo.json5

@@ -11,6 +11,7 @@
     "curse=Fabric16/fabric-api",
     "curse=Fabric16/betternether",
     "curse=Fabric16/betternether",
+    // comment
     {
       "type": "curse",
       "projectName": "Fabric16/tab-inventory-fabric",

util/src/main/kotlin/voodoo/util/JsonExtension.kt

@@ -12,5 +12,12 @@ val json = Json {
     prettyPrint = true
     encodeDefaults = false
 }
+val lenientJson = Json {
+    prettyPrint = true
+    encodeDefaults = false
+    isLenient = true
+//    allowSpecialFloatingPointValues = true
+
+}
 
 inline fun <reified T : Any> T.toJson(serializer: SerializationStrategy<T>): String = json.encodeToString(serializer, this)

util/src/main/kotlin/voodoo/util/ZipExtension.kt

@@ -6,7 +6,7 @@ import java.util.zip.ZipEntry
 import java.util.zip.ZipOutputStream
 
 
-val logger = KotlinLogging.logger{}
+private val logger = KotlinLogging.logger {}
 
 fun packToZip(sourceDir: File, zipFile: File, preserveTimestamps: Boolean = true) {
     zipFile.let { if (it.exists()) it.delete() }

versions.properties

@@ -51,3 +51,5 @@ version.logback-classic=1.2.3
 version.org.junit.jupiter..junit-jupiter-api=5.7.0
 
 version.org.junit.jupiter..junit-jupiter-engine=5.7.0
+
+version.blue.endless..jankson=1.2.0

voodoo/build.gradle.kts

@@ -14,6 +14,8 @@ dependencies {
     api(project(":pack"))
     api(project(":pack:pack-tester"))
 
+    implementation("blue.endless:jankson:_")
+
 //    implementation(KotlinX.coroutines.debug)
 
     implementation(group = "ch.qos.logback", name = "logback-classic", version = "_") {

voodoo/scripting/src/main/kotlin/voodoo/cli/EvalScriptCommand.kt

@@ -41,12 +41,12 @@ class EvalScriptCommand(
     val rootDir by requireObject<File>()
     val scriptFile by argument(
         "script",
-        "pack .voodoo.json file"
+        "pack .voodoo.json5 file"
     ).file(mustExist = true, canBeFile = true, canBeDir = false, mustBeReadable = true, mustBeWritable = false, canBeSymlink = false)
 
     val outputFile by argument(
         "output",
-        "output pack .voodoo.json file"
+        "output pack .voodoo.json5 file"
     ).file(mustExist = false, canBeFile = true, canBeDir = false, mustBeReadable = false, mustBeWritable = true, canBeSymlink = false)
         .validate { file ->
             require(file.name.endsWith(".voodoo.json")) { "output file must be of type '.voodoo.json'" }

voodoo/src/main/kotlin/voodoo/cli/CompileCommand.kt

@@ -31,7 +31,7 @@ class CompileCommand() : CliktCommand(
 
     val packFiles by argument(
         "PACK_FILE",
-        "path to .voodoo.json file"
+        "path to .${VersionPack.extension} file"
     ).file(mustExist = true, canBeFile = true, canBeDir = false)
         .multiple()
         .validate { files ->
@@ -55,10 +55,9 @@ class CompileCommand() : CliktCommand(
                 val packs: Map<Pair<String, MetaPack>, List<VersionPack>> = packFiles.map { packFile ->
                     val baseDir = rootDir.resolve(packFile.absoluteFile.parentFile)
                     val id = baseDir.name
-                    val metaPackFile = baseDir.resolve(MetaPack.FILENAME)
                     val versionPack = VersionPack.parse(packFile = packFile)
 
-                    val metaPack = json.decodeFromString(MetaPack.serializer(), metaPackFile.readText())
+                    val metaPack = MetaPack.parse(baseDir.resolve(MetaPack.FILENAME))
                     Triple(id, metaPack, versionPack)
                 }
                     .groupBy(

voodoo/src/main/kotlin/voodoo/cli/GenerateSchemaCommand.kt

@@ -54,7 +54,7 @@ class GenerateSchemaCommand : CliktCommand(
                 writeText(json.encodeToSchema(MetaPack.serializer()))
             }
 
-            Autocompletions.generate(configFile = configFile)
+            Autocompletions.generate(config = config)
 
 
 //            rootDir.resolve("packIdPlaceholder").resolve(Modpack.defaultSchema).apply {

voodoo/src/main/kotlin/voodoo/cli/PackageCommand.kt

@@ -44,15 +44,6 @@ class PackageCommand(): CliktCommand(
             }
         }
 
-//    val id by option(
-//        "--id",
-//        help = "pack id"
-//    ).required()
-//        .validate {
-//            require(it.isNotBlank()) { "id must not be blank" }
-//            require(it.matches("""[\w_]+""".toRegex())) { "modpack id must not contain special characters" }
-//        }
-
     val packTargets by argument(
         "TARGET", "pack targets"
     ).choice(Pack.packMap)
@@ -73,7 +64,7 @@ class PackageCommand(): CliktCommand(
             val id = baseDir.name
 
             stopwatch {
-                val metaPack = json.decodeFromString(MetaPack.serializer(), metaPackFile.readText())
+                val metaPack = MetaPack.parse(metaPackFile)
                 val uploadDir = uploadDirOption ?: SharedFolders.UploadDir.get(id)
 
                 packTargets.toSet().forEach { packTarget ->

voodoo/src/main/kotlin/voodoo/cli/launch/LaunchMultiMCCommand.kt

@@ -32,7 +32,7 @@ class LaunchMultiMCCommand(): CliktCommand(
 
     val packFile by argument(
         "PACK_FILE",
-        "path to .voodoo.json file"
+        "path to .${VersionPack.extension} file"
     ).file(mustExist = true, canBeFile = true, canBeDir = false)
         .validate { file ->
             require(file.name.endsWith("." + VersionPack.extension)) {

voodoo/src/main/kotlin/voodoo/config/Autocompletions.kt

@@ -1,6 +1,5 @@
 package voodoo.config
 
-import com.github.ricky12awesome.jss.encodeToSchema
 import kotlinx.coroutines.coroutineScope
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
@@ -19,9 +18,6 @@ object Autocompletions {
     private val rootDir by lazy {
         SharedFolders.RootDir.get().absoluteFile
     }
-    private val configFile by lazy {
-        rootDir.resolve("config.json")
-    }
     private val cacheDir by lazy {
         rootDir.resolve(".completions").apply { mkdirs() }
     }
@@ -34,12 +30,7 @@ object Autocompletions {
     private val fabricLoadersFile: File = cacheDir.resolve("fabric_loaders.json")
 
     private val config by lazy {
-        if (configFile.exists()) {
-            json.decodeFromString(
-                Configuration.serializer(),
-                configFile.readText()
-            )
-        } else {
+        Configuration.parseOrDefault(rootDir) {
             Configuration()
         }
     }
@@ -140,17 +131,10 @@ object Autocompletions {
         }
 
 
-    suspend fun generate(configFile: File) {
+    suspend fun generate(config: Configuration) {
 
         logger.info { "generating autocompletions into $cacheDir" }
 
-        val config = if (configFile.exists()) {
-            json.decodeFromString(
-                Configuration.serializer(),
-                configFile.readText()
-            )
-        } else Configuration()
-
         coroutineScope {
             launch(MDCContext()) {
                 generateCurse(config.curseforgeGenerators)

voodoo/src/main/kotlin/voodoo/config/Configuration.kt

@@ -1,9 +1,11 @@
 package voodoo.config
 
+import blue.endless.jankson.Jankson
 import com.github.ricky12awesome.jss.JsonSchema
 import kotlinx.serialization.Required
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
+import mu.KotlinLogging
 import voodoo.pack.EntryOverride
 import voodoo.util.json
 import java.io.File
@@ -24,17 +26,36 @@ data class Configuration(
     val overrides: Map<String, EntryOverride> = mapOf()
 ) {
     companion object {
+        private val logger = KotlinLogging.logger {}
         const val defaultSchema = "./schema/config.schema.json"
-        private const val CONFIG_PATH = "config.json"
+        private const val CONFIG_PATH = "config.json5"
         fun parse(rootDir: File): Configuration {
             val configFile = rootDir.resolve(CONFIG_PATH)
-            return json.decodeFromString(serializer(), configFile.readText())
+
+            val cleanedString = Jankson
+                .builder()
+                .build()
+                .load(configFile.readText()).let { jsonObject ->
+                    jsonObject.toJson(false, true);
+                }
+
+            return json.decodeFromString(serializer(), cleanedString)
         }
-        fun parseOrElse(rootDir: File, generateDefault: () -> Configuration = { Configuration() }): Configuration {
+        fun parseOrDefault(rootDir: File, generateDefault: () -> Configuration = { Configuration() }): Configuration {
             val configFile = rootDir.resolve(CONFIG_PATH)
             return if(configFile.exists()) {
-                json.decodeFromString(serializer(), configFile.readText())
-            } else generateDefault()
+                val cleanedString = Jankson
+                    .builder()
+                    .build()
+                    .load(configFile.readText()).let { jsonObject ->
+                        jsonObject.toJson(false, true);
+                    }
+
+                json.decodeFromString(serializer(), cleanedString)
+            } else {
+                logger.trace { "generate default configuration" }
+                generateDefault()
+            }
         }
         fun save(rootDir: File, configuration: Configuration) {
             val configFile = rootDir.resolve(CONFIG_PATH)

voodoo/src/main/kotlin/voodoo/config/Extensions.kt

@@ -3,11 +3,14 @@ package voodoo.config
 import com.github.ricky12awesome.jss.buildJsonSchema
 import com.github.ricky12awesome.jss.encodeToSchema
 import kotlinx.serialization.json.*
+import mu.KotlinLogging
 import voodoo.data.nested.NestedPack
 import voodoo.pack.FileEntry
 import voodoo.pack.VersionPack
 import voodoo.util.json
 
+private val logger = KotlinLogging.logger {}
+
 fun NestedPack.Companion.generateSchema() = json.encodeToSchema(serializer())
     .replace("\"replace_with_curseforge_projects\"",
         Autocompletions.curseforge.keys.joinToString(",") { "\"$it\"" }