add curated deps step to grill generate

Frotty · Frotty · commit 27953ce7c734 · 2026-06-03T13:22:29.000+02:00
diff --git a/src/main/kotlin/file/CLICommand.kt b/src/main/kotlin/file/CLICommand.kt
@@ -1,6 +1,7 @@
 package file
 
 import config.ScriptMode
+import logging.KotlinLogging
 
 enum class CLICommand {
     HELP,
@@ -83,7 +84,25 @@ enum class GlobalOptions(val optionName: String = "", val argCount: Int = 0) {
             setupMain.gamePath = java.nio.file.Paths.get(args[0])
             setupMain.gamePathExplicit = true
         }
+    },
+    WITH_DEP("--with-dep", 1) {
+        override fun runOption(setupMain: SetupMain, args: List<String>) {
+            val requested = args[0].trim()
+            val curated = CuratedDependencies.findById(requested)
+            if (curated == null) {
+                log.error("❌ Unknown curated dependency: $requested")
+                log.info("Available: ${CuratedDependencies.ids.joinToString(", ")}")
+                ExitHandler.exit(1)
+            }
+            if (!setupMain.curatedDependencyIds.contains(curated.id)) {
+                setupMain.curatedDependencyIds.add(curated.id)
+            }
+        }
     };
 
 	abstract fun runOption(setupMain: SetupMain, args: List<String>)
+
+	companion object {
+		private val log = KotlinLogging.logger {}
+	}
 }
diff --git a/src/main/kotlin/file/CuratedDependencies.kt b/src/main/kotlin/file/CuratedDependencies.kt
@@ -0,0 +1,46 @@
+package file
+
+/**
+ * A community library that is commonly useful but is not part of the Wurst
+ * standard library. The `generate` wizard surfaces these as opt-in extras so a
+ * fresh project can pick them up front instead of running `grill install <url>`
+ * afterwards.
+ */
+data class CuratedDependency(
+    /** Short, stable handle used by the `--with-dep <id>` flag. */
+    val id: String,
+    /** Repository name shown to the user, e.g. "wurst-table-layout". */
+    val label: String,
+    /** One-line blurb shown next to the label, e.g. "AI ready UI toolkit". */
+    val description: String,
+    /** Dependency URL written into the wurst.build `dependencies` array. */
+    val url: String
+) {
+    /** e.g. "wurst-table-layout (AI ready UI toolkit)" */
+    val summary: String get() = "$label ($description)"
+}
+
+/**
+ * The curated catalogue offered by the generate wizard. Add an entry here to
+ * surface a new optional dependency; both the wizard step and the
+ * `--with-dep <id>` flag pick it up automatically.
+ */
+object CuratedDependencies {
+    val all: List<CuratedDependency> = listOf(
+        CuratedDependency(
+            id = "table-layout",
+            label = "wurst-table-layout",
+            description = "AI ready UI toolkit",
+            url = "https://github.com/Frotty/wurst-table-layout"
+        )
+    )
+
+    fun findById(id: String): CuratedDependency? =
+        all.firstOrNull { it.id.equals(id, ignoreCase = true) }
+
+    /** Curated entries whose URL is present in the given dependency list. */
+    fun matching(dependencies: List<String>): List<CuratedDependency> =
+        all.filter { dependency -> dependencies.any { it.equals(dependency.url, ignoreCase = true) } }
+
+    val ids: List<String> get() = all.map { it.id }
+}
diff --git a/src/main/kotlin/file/SetupApp.kt b/src/main/kotlin/file/SetupApp.kt
@@ -146,6 +146,7 @@ object SetupApp {
                     |  --wc3-path <dir>                 Warcraft III install folder for VS Code/run
                     |  --with-agents / --no-agents      Include AGENTS.md (default: no)
                     |  --with-ci / --no-ci              Include GitHub Actions workflow (default: no)
+                    |  --with-dep <id>                  Add a curated dependency (repeatable; ids: ${CuratedDependencies.ids.joinToString(", ")})
                 """.trimMargin())
             }
 			setup.command == CLICommand.INSTALL -> {
@@ -191,9 +192,10 @@ object SetupApp {
                 val projectDir = DEFAULT_DIR.resolve(setup.commandArg)
                 val projectName = projectDir.fileName?.toString() ?: setup.commandArg
                 val stdlibUrl = stdlibDependencyForPatch(setup.wc3Patch)
+                val curatedUrls = setup.curatedDependencyIds.mapNotNull { CuratedDependencies.findById(it)?.url }
                 val projectConfig = newProjectConfig(
                     projectName = projectName,
-                    dependencies = listOf(stdlibUrl),
+                    dependencies = (listOf(stdlibUrl) + curatedUrls).distinct(),
                     buildMapData = generatedBuildMapData(projectName),
                     scriptMode = setup.scriptMode,
                     wc3Patch = setup.wc3Patch
@@ -307,6 +309,8 @@ object SetupApp {
         addGithubWorkflow: Boolean,
         gameRoot: Path?
     ) {
+        val curated = CuratedDependencies.matching(projectConfig.dependencies)
+        val curatedSummary = if (curated.isEmpty()) "none" else curated.joinToString(", ") { it.label }
         log.info("""
             |✅ Created ${projectDir.fileName}
             |
@@ -315,6 +319,7 @@ object SetupApp {
             |  WC3 patch: ${CoreJassProvider.describePatch(projectConfig.wc3Patch ?: CoreJassProvider.DEFAULT_PATCH)}
             |  Warcraft III: ${gameRoot?.toAbsolutePath()?.normalize() ?: "not configured"}
             |  Stdlib: ${if (projectConfig.dependencies.any { it.endsWith(":pre1.29") }) "pre1.29" else "current"}
+            |  Curated dependencies: $curatedSummary
             |  AGENTS.md: ${yesNo(addAgents)}
             |  GitHub Actions CI: ${yesNo(addGithubWorkflow)}
             |
@@ -477,6 +482,31 @@ object SetupApp {
         val ciDefault = if (setup.addGithubWorkflow) "Y" else "N"
         val ciInput = prompt("Add GitHub Actions CI?", ciDefault)
         setup.addGithubWorkflow = ciInput?.lowercase() == "y"
+
+        setup.curatedDependencyIds = selectCuratedDependencies(prompt, setup.curatedDependencyIds).toMutableList()
+    }
+
+    private fun selectCuratedDependencies(
+        prompt: (String, String?) -> String?,
+        preselectedIds: List<String>
+    ): List<String> {
+        val catalog = CuratedDependencies.all
+        if (catalog.isEmpty()) {
+            return preselectedIds
+        }
+
+        log.info("Curated dependencies (optional extras beyond the standard library):")
+        val selected = LinkedHashSet(preselectedIds)
+        for (dependency in catalog) {
+            val default = if (selected.contains(dependency.id)) "Y" else "N"
+            val answer = prompt("Add ${dependency.summary}?", default)
+            if (answer?.trim()?.lowercase() == "y") {
+                selected.add(dependency.id)
+            } else {
+                selected.remove(dependency.id)
+            }
+        }
+        return selected.toList()
     }
 
     private fun selectGamePath(
diff --git a/src/main/kotlin/file/SetupMain.kt b/src/main/kotlin/file/SetupMain.kt
@@ -33,6 +33,9 @@ class SetupMain {
     var scriptMode: ScriptMode = ScriptMode.LUA
     var wc3Patch: String = CoreJassProvider.DEFAULT_PATCH
 
+    /** Ids of curated dependencies (see [CuratedDependencies]) to seed into the generated project. */
+    var curatedDependencyIds: MutableList<String> = mutableListOf()
+
     var gamePathExplicit: Boolean = false
 
 	fun setProjectDir(dir: Path) {
diff --git a/src/test/kotlin/GenerateTests.kt b/src/test/kotlin/GenerateTests.kt
@@ -1,6 +1,7 @@
 import config.ScriptMode
 import file.CLICommand
 import file.CoreJassProvider
+import file.CuratedDependencies
 import file.ExitHandler
 import file.SetupApp
 import file.SetupMain
@@ -261,7 +262,7 @@ class GenerateTests {
     fun testGenerateWithoutNameUsesWizardPrompt() {
         val setup = SetupMain()
         setup.parseArgs(listOf("generate"))
-        val answers = java.util.ArrayDeque(listOf("wizardproject", "jass", "pre1.29", "none", "y", "y"))
+        val answers = java.util.ArrayDeque(listOf("wizardproject", "jass", "pre1.29", "none", "y", "y", "n"))
         val prevPrompt = SetupApp.generatePrompt
         try {
             SetupApp.generatePrompt = { _, _ -> answers.removeFirst() }
@@ -275,13 +276,14 @@ class GenerateTests {
         Assert.assertEquals(setup.wc3Patch, CoreJassProvider.PRE_129_PATCH)
         Assert.assertTrue(setup.addAgents)
         Assert.assertTrue(setup.addGithubWorkflow)
+        Assert.assertTrue(setup.curatedDependencyIds.isEmpty())
     }
 
     @Test(priority = 10)
     fun testGenerateWizardRejectsUnsupportedScriptModeAndPatchInput() {
         val setup = SetupMain()
         setup.parseArgs(listOf("generate"))
-        val answers = java.util.ArrayDeque(listOf("wizardproject", "t", "jass", "t", "2", "none", "n", "n"))
+        val answers = java.util.ArrayDeque(listOf("wizardproject", "t", "jass", "t", "2", "none", "n", "n", "n"))
         val prevPrompt = SetupApp.generatePrompt
         try {
             SetupApp.generatePrompt = { _, _ -> answers.removeFirst() }
@@ -301,7 +303,7 @@ class GenerateTests {
     fun testGenerateWizardPreservesCliPatchDefault() {
         val setup = SetupMain()
         setup.parseArgs(listOf("generate", "--wc3-patch", "pre1.29"))
-        val answers = java.util.ArrayDeque(listOf("wizardproject", "", "", "none", "n", "n"))
+        val answers = java.util.ArrayDeque(listOf("wizardproject", "", "", "none", "n", "n", "n"))
         val prevPrompt = SetupApp.generatePrompt
         try {
             SetupApp.generatePrompt = { _, _ -> answers.removeFirst() }
@@ -333,6 +335,57 @@ class GenerateTests {
         Assert.assertTrue(setup.commandArg.isBlank())
     }
 
+    @Test(priority = 10)
+    fun testCuratedDependencyCatalogResolvesTableLayout() {
+        val dep = CuratedDependencies.findById("table-layout")
+        Assert.assertNotNull(dep)
+        Assert.assertEquals(dep!!.url, "https://github.com/Frotty/wurst-table-layout")
+        Assert.assertEquals(dep.summary, "wurst-table-layout (AI ready UI toolkit)")
+        Assert.assertEquals(CuratedDependencies.findById("TABLE-LAYOUT")?.id, "table-layout")
+        Assert.assertEquals(
+            CuratedDependencies.matching(listOf(dep.url)).map { it.id },
+            listOf("table-layout")
+        )
+    }
+
+    @Test(priority = 10)
+    fun testGenerateWithDepFlagSelectsCuratedDependency() {
+        val setup = SetupMain()
+        setup.parseArgs(listOf("generate", "myproject", "--with-dep", "table-layout"))
+        Assert.assertEquals(setup.curatedDependencyIds, listOf("table-layout"))
+    }
+
+    @Test(priority = 10)
+    fun testGenerateWithDepFlagIsDeduplicated() {
+        val setup = SetupMain()
+        setup.parseArgs(listOf("generate", "myproject", "--with-dep", "table-layout", "--with-dep", "table-layout"))
+        Assert.assertEquals(setup.curatedDependencyIds, listOf("table-layout"))
+    }
+
+    @Test(priority = 10)
+    fun testGenerateWithUnknownDepFlagExitsCleanly() {
+        val code = catchExit2 {
+            SetupMain().parseArgs(listOf("generate", "myproject", "--with-dep", "does-not-exist"))
+        }
+        Assert.assertEquals(code, 1, "An unknown curated dependency id should be reported as a CLI error")
+    }
+
+    @Test(priority = 10)
+    fun testGenerateWizardSelectsCuratedDependency() {
+        val setup = SetupMain()
+        setup.parseArgs(listOf("generate"))
+        val answers = java.util.ArrayDeque(listOf("wizardproject", "lua", "", "none", "n", "n", "y"))
+        val prevPrompt = SetupApp.generatePrompt
+        try {
+            SetupApp.generatePrompt = { _, _ -> answers.removeFirst() }
+            Assert.assertTrue(SetupApp.prepareGenerate(setup))
+        } finally {
+            SetupApp.generatePrompt = prevPrompt
+        }
+
+        Assert.assertEquals(setup.curatedDependencyIds, listOf("table-layout"))
+    }
+
     @Test(priority = 10)
     fun testNoArgsExitsZeroWithoutOldUi() {
         val code = catchExit2 { SetupMain().doMain(arrayOf()) }
