Restructure project

Move some stuff to a buildSrc Gradle plugin so it can be shared with a
new submodule (coming later) and remove the unncessary
com/demonwav/mcdev directory structure in the Kotlin source directory.

Kotlin does not require files to be in the full package directory like
Java, and the official style guide says to prefer not laying them out
like Java for non-shared modules. This project has existed longer than
that style guide, and that's a lot of files to move, so I just never
felt like move them until now.

Author: DenWav

.gitignore

@@ -1,50 +1,29 @@
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio
-
-*.iml
-
-## Directory-based project format:
 .idea/
-
-## File-based project format:
+.idea_modules/
+*.iml
 *.ipr
 *.iws
 
-## Plugin-specific files:
-
-# IntelliJ
-/out/
+**/out/
+**/build/
 
-# mpeltonen/sbt-idea plugin
-.idea_modules/
-
-# JIRA plugin
-atlassian-ide-plugin.xml
-
-# Crashlytics plugin (for Android Studio and IntelliJ)
 com_crashlytics_export_strings.xml
 crashlytics.properties
 crashlytics-build.properties
 
 *.class
-
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
-# Package Files #
+*.jar
 *.war
 *.ear
 *.zip
 
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 
-/classes/
-/target/
-/build/
-.gradle/
+**/.gradle/
 .sandbox/
 
 /gen/
 
-
 .DS_Store
+
+!gradle/wrapper/gradle-wrapper.jar

build.gradle.kts

@@ -19,6 +19,7 @@ buildscript {
 }
 
 plugins {
+    mcdev
     kotlin("jvm") version "1.3.31" // kept in sync with IntelliJ's bundled dep
     groovy
     idea
@@ -27,7 +28,7 @@ plugins {
     id("org.jlleitschuh.gradle.ktlint") version "9.3.0"
 }
 
-apply(from = "gradle/attach-sources.gradle.kts")
+// apply(from = "gradle/attach-sources.gradle.kts")
 
 val coroutineVersion = "1.2.1" // Coroutine version also kept in sync with IntelliJ's bundled dep
 
@@ -38,20 +39,21 @@ val downloadIdeaSources: String by project
 
 // configurations
 val idea by configurations
+val jflex by configurations
+val jflexSkeleton by configurations
+val grammarKit by configurations
+
 val gradleToolingExtension: Configuration by configurations.creating {
     extendsFrom(idea)
 }
-val jflex: Configuration by configurations.creating
-val jflexSkeleton: Configuration by configurations.creating
-val grammarKit: Configuration by configurations.creating
 val testLibs: Configuration by configurations.creating {
     isTransitive = false
 }
 
 group = "com.demonwav.minecraft-dev"
 version = "$ideaVersionName-$coreVersion"
 
-val gradleToolingExtensionSourceSet = sourceSets.create("gradle-tooling-extension") {
+val gradleToolingExtensionSourceSet: SourceSet = sourceSets.create("gradle-tooling-extension") {
     configurations.named(compileOnlyConfigurationName) {
         extendsFrom(gradleToolingExtension)
     }
@@ -74,12 +76,14 @@ dependencies {
     // Add tools.jar for the JDI API
     implementation(files(Jvm.current().toolsJar))
 
-    implementation(files(gradleToolingExtensionJar))
-
+    // Kotlin
+    compileOnly(kotlin("stdlib-jdk8"))
+    compileOnly("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutineVersion")
     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-swing:$coroutineVersion") {
         isTransitive = false
     }
-    compileOnly("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutineVersion")
+
+    implementation(files(gradleToolingExtensionJar))
 
     implementation("com.extracraftx.minecraft:TemplateMakerFabric:0.3.0")
 
@@ -147,6 +151,7 @@ tasks.withType<KotlinCompile>().configureEach {
         jvmTarget = JavaVersion.VERSION_1_8.toString()
         freeCompilerArgs = listOf("-Xjvm-default=enable")
     }
+    this.javaPackagePrefix
 }
 
 tasks.withType<GroovyCompile>().configureEach {
@@ -247,92 +252,30 @@ tasks.register("format") {
     dependsOn(licenseFormat, ktlintFormat)
 }
 
-// Credit for this intellij-rust
-// https://github.com/intellij-rust/intellij-rust/blob/d6b82e6aa2f64b877a95afdd86ec7b84394678c3/build.gradle#L131-L181
-fun generateLexer(name: String, flex: String, pack: String) = tasks.register<JavaExec>(name) {
-    val src = "src/main/grammars/$flex.flex"
-    val dst = "gen/com/demonwav/mcdev/$pack"
-    val output = "$dst/$flex.java"
-
-    classpath = jflex
-    main = "jflex.Main"
-
-    doFirst {
-        args(
-            "--skel", jflexSkeleton.singleFile.absolutePath,
-            "-d", dst,
-            src
-        )
+val generateAtLexer by lexer("AtLexer", "com/demonwav/mcdev/platform/mcp/at/gen")
+val generateAtParser by parser("AtParser", "com/demonwav/mcdev/platform/mcp/at/gen")
 
-        // Delete current lexer
-        delete(output)
-    }
+val generateNbttLexer by lexer("NbttLexer", "com/demonwav/mcdev/nbt/lang/gen")
+val generateNbttParser by parser("NbttParser", "com/demonwav/mcdev/nbt/lang/gen")
 
-    inputs.files(src, jflexSkeleton)
-    outputs.file(output)
-}
+val generateLangLexer by lexer("LangLexer", "com/demonwav/mcdev/translations/lang/gen")
+val generateLangParser by parser("LangParser", "com/demonwav/mcdev/translations/lang/gen")
 
-fun generatePsiAndParser(name: String, bnf: String, pack: String) = tasks.register<JavaExec>(name) {
-    val src = "src/main/grammars/$bnf.bnf".replace('/', File.separatorChar)
-    val dstRoot = "gen"
-    val dst = "$dstRoot/com/demonwav/mcdev/$pack".replace('/', File.separatorChar)
-    val psiDir = "$dst/psi/".replace('/', File.separatorChar)
-    val parserDir = "$dst/parser/".replace('/', File.separatorChar)
-
-    doFirst {
-        delete(psiDir, parserDir)
-    }
-
-    classpath = grammarKit
-    main = "org.intellij.grammar.Main"
-
-    if (JavaVersion.current().isJava9Compatible) {
-        jvmArgs(
-            "--add-opens", "java.base/java.lang=ALL-UNNAMED",
-            "--add-opens", "java.base/java.lang.reflect=ALL-UNNAMED",
-            "--add-opens", "java.base/java.util=ALL-UNNAMED"
-        )
-    }
-
-    args(dstRoot, src)
-
-    inputs.file(src)
-    outputs.dirs(
-        mapOf(
-            "psi" to psiDir,
-            "parser" to parserDir
-        )
-    )
-}
-
-val generateAtLexer = generateLexer("generateAtLexer", "AtLexer", "platform/mcp/at/gen/")
-val generateAtPsiAndParser = generatePsiAndParser("generateAtPsiAndParser", "AtParser", "platform/mcp/at/gen")
-
-val generateNbttLexer = generateLexer("generateNbttLexer", "NbttLexer", "nbt/lang/gen/")
-val generateNbttPsiAndParser = generatePsiAndParser("generateNbttPsiAndParser", "NbttParser", "nbt/lang/gen")
-
-val generateLangLexer = generateLexer("generateLangLexer", "LangLexer", "translations/lang/gen/")
-val generateLangPsiAndParser = generatePsiAndParser("generateLangPsiAndParser", "LangParser", "translations/lang/gen")
-
-val generateTranslationTemplateLexer = generateLexer(
-    "generateTranslationTemplateLexer",
-    "TranslationTemplateLexer",
-    "translations/lang/gen/"
-)
+val generateTranslationTemplateLexer by lexer("TranslationTemplateLexer", "com/demonwav/mcdev/translations/lang/gen")
 
 val generate by tasks.registering {
     group = "minecraft"
     description = "Generates sources needed to compile the plugin."
+    outputs.dir("gen")
     dependsOn(
         generateAtLexer,
-        generateAtPsiAndParser,
+        generateAtParser,
         generateNbttLexer,
-        generateNbttPsiAndParser,
+        generateNbttParser,
         generateLangLexer,
-        generateLangPsiAndParser,
+        generateLangParser,
         generateTranslationTemplateLexer
     )
-    outputs.dir("gen")
 }
 
 sourceSets.named("main") { java.srcDir(generate) }
@@ -343,12 +286,9 @@ tasks.clean { delete(generate) }
 tasks.runIde {
     maxHeapSize = "2G"
 
+    jvmArgs("--add-exports=java.base/jdk.internal.vm=ALL-UNNAMED")
     System.getProperty("debug")?.let {
         systemProperty("idea.ProcessCanceledException", "disabled")
         systemProperty("idea.debug.mode", "true")
     }
 }
-
-inline fun <reified T : Task> TaskContainer.existing() = existing(T::class)
-inline fun <reified T : Task> TaskContainer.register(name: String, configuration: Action<in T>) =
-    register(name, T::class, configuration)

buildSrc/build.gradle.kts

@@ -0,0 +1,21 @@
+/*
+ * Minecraft Dev for IntelliJ
+ *
+ * https://minecraftdev.org
+ *
+ * Copyright (c) 2020 minecraft-dev
+ *
+ * MIT License
+ */
+
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("com.google.code.gson:gson:2.8.6")
+}

gradle/attach-sources.gradle.kts renamed to buildSrc/src/main/kotlin/mcdev.gradle.kts

@@ -8,62 +8,56 @@
  * MIT License
  */
 
-import com.github.salomonbrys.kotson.fromJson
 import com.google.gson.Gson
 import com.google.gson.GsonBuilder
+import com.google.gson.reflect.TypeToken
+import java.net.HttpURLConnection
+import java.net.URL
 import java.util.Properties
 import java.util.zip.ZipFile
-import java.net.URL
-import java.net.HttpURLConnection
 
-buildscript {
-    repositories {
-        mavenCentral()
-    }
-    dependencies {
-        classpath("com.google.code.gson:gson:2.8.6")
-        classpath("com.github.salomonbrys.kotson:kotson:2.5.0")
-    }
-}
-
-/*
- * This file and the task `resolveIntellijLibSources` below attempts to find sources for IntelliJ's dependencies (the
- * jars in its lib/ dir) which are in Maven Central. This check isn't perfect and may miss some, but grabs most of them.
- * The task writes the result to `.gradle/intellij-deps.json`.
- *
- * At configuration time if `.gradle/intellij-deps.json` exists the below code not in a task will add those dependencies
- * explicitly, causing Gradle to download the sources for those dependencies, and allowing IntelliJ to pick up those
- * sources. None of this affects the actual build or any of the code, this only exists to help ease development by
- * making library sources available in the dev environment.
- */
+val jflex: Configuration by configurations.creating
+val jflexSkeleton: Configuration by configurations.creating
+val grammarKit: Configuration by configurations.creating
+val compileOnly by configurations
 
+// Analyze dependencies
 val fileName = ".gradle/intellij-deps.json"
-
 val jsonFile = file("$projectDir/$fileName")
+
+val ideaVersion: String by project
+val ideaVersionName: String by project
+
+data class DepList(val intellijVersion: String, val intellijVersionName: String, val deps: List<Dep>)
+data class Dep(val groupId: String, val artifactId: String, val version: String)
+
 if (jsonFile.exists()) {
-    val deps = jsonFile.bufferedReader().use { reader ->
-        Gson().fromJson<List<Dep>>(reader)
+    val deps: DepList = jsonFile.bufferedReader().use { reader ->
+        Gson().fromJson(reader, object : TypeToken<DepList>() {}.type)
     }
-    dependencies {
-        for ((groupId, artifactId, version) in deps) {
-            "compileOnly"(
-                group = groupId,
-                name = artifactId,
-                version = version
-            )
+    if (ideaVersion != deps.intellijVersion || ideaVersionName != deps.intellijVersionName) {
+        println("IntelliJ library sources file definition is out of date, deleting")
+        jsonFile.delete()
+    } else {
+        dependencies {
+            for ((groupId, artifactId, version) in deps.deps) {
+                compileOnly(
+                    group = groupId,
+                    name = artifactId,
+                    version = version
+                )
+            }
         }
     }
 }
 
-data class Dep(val groupId: String, val artifactId: String, val version: String)
-
 tasks.register("resolveIntellijLibSources") {
     group = "minecraft"
-    val config = project.configurations["compileClasspath"]
-    dependsOn(config)
+    val compileClasspath by project.configurations
+    dependsOn(compileClasspath)
 
     doLast {
-        val files = config.resolvedConfiguration.files
+        val files = compileClasspath.resolvedConfiguration.files
         val deps = files.asSequence()
             .map { it.toPath() }
             .filter {
@@ -104,8 +98,9 @@ tasks.register("resolveIntellijLibSources") {
                 }
             }.toList()
 
+        val depList = DepList(ideaVersion, ideaVersionName, deps.sortedWith(compareBy<Dep> { it.groupId }.thenBy { it.artifactId }))
         jsonFile.bufferedWriter().use { writer ->
-            GsonBuilder().setPrettyPrinting().create().toJson(deps, writer)
+            GsonBuilder().setPrettyPrinting().create().toJson(depList, writer)
         }
     }
 }