✨ 基于.metadata的项目自动配置

Author: way-zer

build.gradle.kts

@@ -74,15 +74,14 @@ allprojects {
 }
 
 dependencies.constraints {
-    val mindustryVersion = "v2025.10.X21" //v153
+    val mindustryVersion = "3e787fe01c" //v155.4
     api("com.github.TinyLake.MindustryX:core:$mindustryVersion")
     val bukkitVersion = "1.21.4-R0.1-SNAPSHOT"
     api("dev.folia:folia-api:$bukkitVersion")
 }
 dependencies {
-    val libraryVersion = "2.2.0.4"
+    val libraryVersion = "2.3.2.4"
     api("cf.wayzer:ScriptAgent:${libraryVersion}")
-    implementation("cf.wayzer:LibraryManager:1.6")
 
     "mindustryCompileOnly"("com.github.TinyLake.MindustryX:core")
     "bukkitCompileOnly"("dev.folia:folia-api")
@@ -139,7 +138,7 @@ tasks {
         )
         dependencies {
             include(dependency("cf.wayzer:ScriptAgent"))
-            include(dependency("cf.wayzer:LibraryManager"))
+            include(dependency("com.github.way-zer:LibraryManager"))
         }
         doLast {
             println(archiveFile.get())

buildSrc/src/Module.kt

@@ -1,51 +1,70 @@
 @file:Suppress("unused")
 
+package buildsrc
+
 import org.gradle.api.Project
-import org.gradle.api.artifacts.Dependency
-import org.gradle.api.artifacts.dsl.DependencyHandler
 import org.gradle.api.tasks.SourceSet
 import org.gradle.api.tasks.SourceSetContainer
 import org.gradle.kotlin.dsl.dependencies
 import org.gradle.kotlin.dsl.kotlin
 import org.gradle.kotlin.dsl.project
 
 @DslMarker
-annotation class ModuleBuilderMarker
+internal annotation class ModuleBuilderMarker
 
 @ModuleBuilderMarker
-class ModuleScope(val moduleId: String, val project: Project, val sourceSet: SourceSet) {
+internal class ModuleScope(val moduleId: String, val project: Project, val sourceSet: SourceSet) {
     val exposedConfigurationName get() = sourceSet.apiConfigurationName.replace("Api", "Exposed")
 
-    fun DependencyHandler.dependsOnModule(module: String, project: Project = this@ModuleScope.project): Dependency? {
+    fun dependsOnModule(module: String, project: Project = this.project) {
         val sourceSet = project.sourceSets.getByName(mapIdToSourceSetName(module))
-        return dependsOn(ModuleScope(module, project, sourceSet))
+        dependsOn(ModuleScope(module, project, sourceSet))
     }
 
-    fun DependencyHandler.dependsOn(module: ModuleScope): Dependency? {
-        return add(sourceSet.apiConfigurationName, project(module.project.path, module.exposedConfigurationName))
+    fun dependsOn(module: ModuleScope) {
+        project.dependencies {
+            add(
+                sourceSet.apiConfigurationName,
+                project(module.project.path, module.exposedConfigurationName)
+            )
+        }
     }
 
-    fun DependencyHandler.api(dep: Any) = add(sourceSet.apiConfigurationName, dep)
-    fun DependencyHandler.implementation(dep: Any) = add(sourceSet.implementationConfigurationName, dep)
+    fun api(dep: Any) = project.dependencies.add(sourceSet.apiConfigurationName, dep)
+    fun implementation(dep: Any) = project.dependencies.add(sourceSet.implementationConfigurationName, dep)
 }
 
 private fun mapIdToSourceSetName(id: String) = id.replace('/', '.')
 
-@ModuleBuilderMarker
-fun Project.defineModule(
+// Child directories with their own `.metadata` become standalone modules,
+// so the parent source set should exclude them from compilation.
+private fun Project.excludeNestedMetadataModules(moduleId: String, sourceSet: SourceSet) {
+    val moduleDir = projectDir.resolve(moduleId)
+    if (!moduleDir.isDirectory) return
+
+    moduleDir.walkTopDown()
+        .filter { it.isDirectory && it != moduleDir && it.resolve(".metadata").isFile }
+        .forEach { childDir ->
+            val relative = childDir.relativeTo(moduleDir).invariantSeparatorsPath
+            sourceSet.java.exclude("$relative/**")
+        }
+}
+
+// Create the backing SourceSet and base configurations for a script module.
+internal fun Project.createModule(
     name: String,
     onlyLibrary: Boolean = false,
-    body: ModuleScope.() -> Unit,
-) {
+): ModuleScope {
     val sourceSet = sourceSets.create(mapIdToSourceSetName(name)) {
-        if(!onlyLibrary){
+        if (!onlyLibrary) {
             java.srcDir(name)
             java.exclude("lib/**")
         }
         //独立设置成srcDir，这样可以自定义package，不需要包含lib前缀。
         java.srcDir("$name/lib")
     }
-    ModuleScope(name, project, sourceSet).apply {
+    excludeNestedMetadataModules(name, sourceSet)
+    return ModuleScope(name, project, sourceSet).apply {
         configurations.create(exposedConfigurationName) {
             extendsFrom(configurations.getByName(sourceSet.apiConfigurationName))
             isCanBeConsumed = true
@@ -56,30 +75,15 @@ fun Project.defineModule(
             implementation(rootProject)
             add(exposedConfigurationName, sourceSet.output)
         }
-        body()
     }
 }
 
-@ModuleBuilderMarker
-fun ModuleScope.subModule(
-    name: String,
-    onlyLibrary: Boolean = false,
-    body: ModuleScope.() -> Unit,
-) {
-    val parent = this@subModule
-    val project = parent.project
-
-    val id = "${parent.moduleId}/$name"
-    parent.sourceSet.java.exclude("$name/**")
-    project.dependencies {
-        project.defineModule(id, onlyLibrary = onlyLibrary) {
-            dependsOn(parent)
-            body()
-        }
-    }
+// Apply additional module wiring after all dependent SourceSets are available.
+internal fun configureModule(scope: ModuleScope, body: ModuleScope.() -> Unit) {
+    scope.body()
 }
 
 private val Project.sourceSets
     get() = project.extensions.getByType(
         SourceSetContainer::class.java
-    )
+    )

buildSrc/src/ModuleParser.kt

@@ -0,0 +1,78 @@
+@file:Suppress("unused")
+
+package buildsrc
+
+import java.io.File
+
+/**
+ * ScriptAgent Gradle Plugin - 模块信息
+ * 
+ * 从 metadata 文件中提取的顶层模块配置
+ */
+internal data class ModuleInfo(
+    val id: String,
+    val depends: List<String> = emptyList(),
+    val apiDeps: List<String> = emptyList(),
+    val implementationDeps: List<String> = emptyList(),
+)
+
+/**
+ * 解析 ScriptAgent metadata 文件，聚合成顶层模块配置
+ * 
+ * metadata 格式：
+ * ```
+ * ID coreLibrary
+ * +IMPORT MavenDependsSingle com.example:lib:1.0
+ * +IMPORT MavenDepends com.example:impl:1.0
+ * +DEPENDS otherModule
+ * 
+ * ID coreLibrary/subModule   <- 子脚本，依赖与导入会聚合到 coreLibrary
+ * ...
+ * ```
+ */
+private fun parseMetadataFile(file: File, moduleId: String): ModuleInfo? {
+    if (!file.exists()) return null
+
+    val lines = file.readLines()
+    val depends = linkedSetOf<String>()
+    val apiDeps = linkedSetOf<String>()
+    val implementationDeps = linkedSetOf<String>()
+
+    for (line in lines) {
+        val trimmed = line.trim()
+        when {
+            trimmed.startsWith("+DEPENDS ") -> {
+                val dep = trimmed.removePrefix("+DEPENDS ").trim().split(" ").firstOrNull()
+                if (dep != null) depends.add(dep)
+            }
+            trimmed.startsWith("+IMPORT MavenDependsSingle ") -> {
+                apiDeps.add(trimmed.removePrefix("+IMPORT MavenDependsSingle ").trim())
+            }
+            trimmed.startsWith("+IMPORT MavenDepends ") -> {
+                // metadata 只描述脚本编译依赖，不可靠地区分 Gradle api/implementation。
+                // 这里统一提升为 api，优先保证 IDE 与脚本编译的可见性。
+                apiDeps.add(trimmed.removePrefix("+IMPORT MavenDepends ").trim())
+            }
+        }
+    }
+
+    return ModuleInfo(moduleId, depends.toList(), apiDeps.toList(), implementationDeps.toList())
+}
+
+/**
+ * 扫描脚本目录下的所有 .metadata 文件。
+ * `.metadata` 的模块 id 由其所在目录相对路径决定，例如：
+ * - `scripts/coreLibrary/.metadata` -> `coreLibrary`
+ * - `scripts/coreLibrary/db/.metadata` -> `coreLibrary/db`
+ */
+internal fun scanMetadataDir(scriptsDir: File): Map<String, ModuleInfo> {
+    if (!scriptsDir.exists()) return emptyMap()
+
+    return scriptsDir.walkTopDown()
+        .filter { it.isFile && it.name == ".metadata" }
+        .mapNotNull { file ->
+            val moduleId = file.parentFile.relativeTo(scriptsDir).invariantSeparatorsPath
+            if (moduleId.isBlank()) null else parseMetadataFile(file, moduleId)
+        }
+        .associateBy { it.id }
+}

buildSrc/src/SAMetadataModules.kt

@@ -0,0 +1,42 @@
+package buildsrc
+
+import org.gradle.api.Project
+import java.io.File
+
+// Resolve script-level dependencies like `coreLibrary/extApi/KVStore` to the
+// nearest folder that actually declares a `.metadata` module.
+private fun resolveModuleDependency(dependencyId: String, moduleIds: Set<String>): String? {
+    var current = dependencyId
+    while (current.isNotEmpty()) {
+        if (current in moduleIds) return current
+        current = current.substringBeforeLast('/', "")
+    }
+    return null
+}
+
+// Register modules in two phases: create all source sets first, then wire dependencies.
+fun Project.defineMetadataModules(scriptsDir: File = projectDir) {
+    val modules = scanMetadataDir(scriptsDir)
+    val moduleIds = modules.keys
+    val scopes = linkedMapOf<String, ModuleScope>()
+
+    for (info in modules.values.sortedBy { it.id }) {
+        scopes[info.id] = createModule(info.id)
+    }
+
+    for (info in modules.values.sortedBy { it.id }) {
+        val scope = scopes.getValue(info.id)
+        configureModule(scope) {
+            for (dep in info.depends.mapNotNull { resolveModuleDependency(it, moduleIds) }.distinct()) {
+                if (dep == info.id) continue
+                dependsOnModule(dep)
+            }
+            for (dep in info.apiDeps) {
+                api(dep)
+            }
+            for (dep in info.implementationDeps) {
+                implementation(dep)
+            }
+        }
+    }
+}

loader/bukkit/src/Main.kt

@@ -26,7 +26,7 @@ class Main : JavaPlugin(), CommonMain {
         Config.pluginMain = this
         Config.delayEnable = mutableListOf()
 
-        DependencyManager {
+        DependencyManager.blocking {
             require(Dependency.parse("org.jetbrains.kotlin:kotlin-stdlib:${Config.kotlinVersion}"))
             require(Dependency.parse("org.jetbrains.kotlin:kotlin-reflect:${Config.kotlinVersion}"))
             require(Dependency.parse("org.jetbrains.kotlinx:kotlinx-coroutines-core:${Config.kotlinCoroutineVersion}"))

scripts/bootStrap/.metadata

@@ -1,69 +1,13 @@
+import buildsrc.defineMetadataModules
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
     kotlin("jvm")
 }
-dependencies {
-    defineModule("kcp") {
-        //kcp/serialization
-        api("org.jetbrains.kotlinx:kotlinx-serialization-json:1.8.0")
-    }
-    defineModule("bootStrap") {}
-    //不能设置为onlyLibrary，因为有子模块，IDEA会无法正确关联脚本所在模块。
-    defineModule("coreLibrary"/*, onlyLibrary = true*/) {
-        api("com.github.way-zer:PlaceHoldLib:v7.3")
-        api("io.github.config4k:config4k:0.7.0")
-        api("org.slf4j:slf4j-api:2.0.16")
-
-        subModule("db", onlyLibrary = true) {
-            val exposedVersion = "0.59.0"
-            api("org.jetbrains.exposed:exposed-core:$exposedVersion")
-            api("org.jetbrains.exposed:exposed-dao:$exposedVersion")
-            api("org.jetbrains.exposed:exposed-java-time:$exposedVersion")
-        }
-
-        subModule("extApi", onlyLibrary = true) {
-            //coreLib/extApi/redisApi
-            api("redis.clients:jedis:4.3.1")
-            //coreLib/extApi/mongoApi
-            api("org.litote.kmongo:kmongo-coroutine:4.8.0")
-            implementation("com.fasterxml.jackson.datatype:jackson-datatype-jsr310")
-            //coreLib/extApi/KVStore
-            api("com.h2database:h2-mvstore:2.3.232")
-        }
-    }
-
-    defineModule("javalin") {
-        dependsOnModule("coreLibrary")
-        api("io.javalin:javalin:6.7.0")
-    }
 
-    defineModule("coreMindustry") {
-        dependsOnModule("coreLibrary")
-        api("com.github.TinyLake.MindustryX:core")
-        //coreMindustry/console
-        implementation("org.jline:jline-terminal:3.21.0")
-        implementation("org.jline:jline-reader:3.21.0")
-    }
-    defineModule("scratch") {
-        dependsOnModule("coreLibrary")
-    }
-
-    defineModule("wayzer") {
-        dependsOnModule("coreMindustry")
-        dependsOnModule("coreLibrary/extApi")
-        api("com.google.guava:guava:30.1-jre")
-        //wayzer/ext/profiler
-        implementation("tools.profiler:async-profiler:4.1")
-        subModule("store") {
-            dependsOnModule("coreLibrary/db")
-        }
-    }
-    defineModule("mapScript") {
-        dependsOnModule("wayzer")
-    }
-}
+defineMetadataModules()
 
+// 全局编译器配置
 allprojects {
     tasks.withType<KotlinCompile>().configureEach {
         compilerOptions {
@@ -75,4 +19,4 @@ allprojects {
             )
         }
     }
-}
+}