refactor: Switch to conventions plugins for multiplatform configuration

refactor: Switch to mia catalog for more dependencies

Author: 0ffz

.github/workflows/docs.yml

@@ -22,19 +22,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - uses: MineInAbyss/publish-action@v3
-        with:
-          publish-github-release: false
-          build-tasks: 'docsGenerate'
-
-      - name: Update HTML links for GitHub Pages subdomain
-        run: |
-          find out -name "*.html" -exec sed -i 's#href="/#href="/geary/#g; s#src="/#src="/geary/#g' {} \;
-
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: out
+      - uses: MineInAbyss/publish-action/docs@develop
 
   deploy:
     environment:

CHANGELOG.md

@@ -13,6 +13,7 @@ MAJOR is set to zero.
 
 ### Changed
 
-- Switched to our own small DI library for internal module and for addons
+- Switched to our own small DI library for internal module and for addons, docs can be
+  found [here](https://docs.mineinabyss.com/dependencies-kt/)
 - `WorldScoped` is now the preferred receiver when writing extension functions. `WorldScoped.newScope()` can be used to
   register systems, observers, etc... and automatically unregister them when calling `close` on the returned scope

README.md

@@ -100,3 +100,9 @@ As the project matures, our primary goal is to make it useful to more people. He
 - Multiplatform support, with js, jvm, and native targets
 - Publish numbers for benchmarks and cover more parts of the engine with them
 - Relation queries, ex. entities with a parent that has X component.
+
+## Development
+
+- `gradle build` builds the project
+- `gradle allTests` runs tests
+- `gradle docsServe` serve docs locally

addons/geary-prefabs/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     id(idofrontLibs.plugins.mia.kotlin.multiplatform.get().pluginId)
+    id("multiplatform-targets")
     id(idofrontLibs.plugins.mia.publication.get().pluginId)
     alias(idofrontLibs.plugins.kotlinx.serialization)
 }

addons/geary-prefabs/test@jvm/com/mineinabyss/geary/prefabs/GearyEntityComponentIdSerializerTest.kt

@@ -30,7 +30,7 @@ class GearyEntityComponentIdSerializerTest : GearyTest() {
     @Test
     fun `GearyEntitySerializer should deserialize to entity correctly`() {
         // arrange
-        val format = YamlFormat(world.scope.get(SerializableComponents)!!.formats.module)
+        val format = YamlFormat(world.scope[SerializableComponents].formats.module)
         val file =
             """
             test:thing.a: {}

addons/geary-serialization/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     id(idofrontLibs.plugins.mia.kotlin.multiplatform.get().pluginId)
+    id("multiplatform-targets")
     id(idofrontLibs.plugins.mia.publication.get().pluginId)
     alias(idofrontLibs.plugins.kotlinx.serialization)
 }

addons/geary-uuid/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     id(idofrontLibs.plugins.mia.kotlin.multiplatform.get().pluginId)
+    id("multiplatform-targets")
     id(idofrontLibs.plugins.mia.publication.get().pluginId)
 }
 

build.gradle.kts

@@ -1,79 +1,6 @@
 plugins {
-    alias(idofrontLibs.plugins.kotlin.multiplatform)
-    alias(idofrontLibs.plugins.mia.autoversion)
-    alias(idofrontLibs.plugins.dependencyversions)
-    alias(idofrontLibs.plugins.version.catalog.update)
+    alias(idofrontLibs.plugins.kotlin.multiplatform) apply false
+    alias(idofrontLibs.plugins.mia.docs)
+    alias(idofrontLibs.plugins.mia.publication) apply false
     alias(idofrontLibs.plugins.kotlinx.serialization) apply false
 }
-
-allprojects {
-    repositories {
-        mavenCentral()
-        google()
-        maven("https://repo.mineinabyss.com/releases")
-        maven("https://repo.mineinabyss.com/snapshots")
-        mavenLocal()
-    }
-}
-
-allprojects {
-    pluginManager.withPlugin("org.jetbrains.kotlin.multiplatform") {
-        kotlin {
-            jvm {
-                testRuns["test"].executionTask.configure {
-                    useJUnitPlatform()
-                }
-            }
-            // TODO Other targets are missing some implementations like Roaring Bitmaps, but we hope someone
-            //  interested can add support in the future. Thus, we force a target that doesn't actually compile
-            //  so we can't accidentally use jvm-only code in the common target.
-            linuxX64()
-
-            sourceSets {
-                all {
-                    languageSettings {
-                        optIn("kotlinx.coroutines.ExperimentalCoroutinesApi")
-                        optIn("kotlin.time.ExperimentalTime")
-                        optIn("kotlin.ExperimentalUnsignedTypes")
-                        optIn("kotlin.uuid.ExperimentalUuidApi")
-                        optIn("kotlinx.serialization.ExperimentalSerializationApi")
-                        optIn("kotlin.RequiresOptIn")
-                    }
-                }
-            }
-
-            compilerOptions {
-                freeCompilerArgs.addAll(
-                    listOf(
-                        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi",
-                        "-Xexpect-actual-classes"
-                    )
-                )
-            }
-        }
-    }
-}
-
-configurations {
-    create("docs")
-}
-
-afterEvaluate {
-    val version = file("docs/version").readText()
-    dependencies {
-        "docs"("me.dvyy:shocky-docs:$version")
-    }
-}
-
-tasks {
-    register<JavaExec>("docsGenerate") {
-        classpath = configurations.getByName("docs")
-        mainClass.set("me.dvyy.shocky.docs.MainKt")
-        args("generate")
-    }
-    register<JavaExec>("docsServe") {
-        classpath = configurations.getByName("docs")
-        mainClass.set("me.dvyy.shocky.docs.MainKt")
-        args("serve")
-    }
-}

conventions/build.gradle.kts

@@ -0,0 +1,11 @@
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    gradlePluginPortal()
+}
+
+dependencies {
+    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:${idofrontLibs.versions.kotlin.get()}")
+}

conventions/settings.gradle.kts

@@ -0,0 +1,18 @@
+import java.util.*
+
+dependencyResolutionManagement {
+    val gradlePropertiesFile = file("../gradle.properties")
+    val properties = Properties()
+    gradlePropertiesFile.inputStream().use { properties.load(it) }
+    val catalogVersion = properties.getProperty("catalogVersion")
+    repositories {
+        maven("https://repo.mineinabyss.com/releases")
+        maven("https://repo.mineinabyss.com/snapshots")
+        mavenLocal()
+    }
+    versionCatalogs {
+        create("idofrontLibs") {
+            from("com.mineinabyss:catalog:$catalogVersion")
+        }
+    }
+}