v0.12.0

.github/workflows/qodona.yml

@@ -0,0 +1,16 @@
+name: Qodona
+on: [push]
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Qodana Scan
+        uses: JetBrains/qodana-action@main
+        env:
+          QODANA_TOKEN: "${{ secrets.QODANA_TOKEN }}"
+      - name: Upload CodeQL SARIF
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: "${{ runner.temp }}/qodana/results/qodana.sarif.json"

build.gradle.kts

@@ -1,7 +1,6 @@
 @file:Suppress("UnstableApiUsage")
 plugins {
   `kotlin-dsl`
-  kotlin("plugin.serialization") version "1.7.10"
 
   `maven-publish`
   `java-gradle-plugin`
@@ -10,7 +9,7 @@ plugins {
 }
 
 group = "gay.pizza.foundation"
-version = "0.10.0"
+version = "0.12.0"
 
 repositories {
   mavenCentral()
@@ -37,7 +36,7 @@ gradlePlugin {
       implementationClass = "gay.pizza.foundation.concrete.ConcreteRootPlugin"
 
       displayName = "Concrete Root"
-      description = "Concrete project root."
+      description = "Gradle conventions for Foundation Bukkit plugins. Root project plugin."
     }
 
     create("concrete-base") {
@@ -45,7 +44,7 @@ gradlePlugin {
       implementationClass = "gay.pizza.foundation.concrete.ConcreteBasePlugin"
 
       displayName = "Concrete Base"
-      description = "Concrete project base."
+      description = "Gradle conventions for Foundation Bukkit plugins. Base project plugin."
     }
 
     create("concrete-library") {
@@ -53,7 +52,7 @@ gradlePlugin {
       implementationClass = "gay.pizza.foundation.concrete.ConcreteLibraryPlugin"
 
       displayName = "Concrete Library"
-      description = "Concrete project library."
+      description = "Gradle conventions for Foundation Bukkit plugins. Library project plugin."
     }
 
     create("concrete-plugin") {
@@ -61,7 +60,7 @@ gradlePlugin {
       implementationClass = "gay.pizza.foundation.concrete.ConcretePluginPlugin"
 
       displayName = "Concrete Library"
-      description = "Concrete project plugin."
+      description = "Gradle conventions for Foundation Bukkit plugins. Plugin project plugin."
     }
 
     forEach { declaration ->
@@ -129,7 +128,7 @@ publishing {
 }
 
 tasks.withType<Wrapper> {
-  gradleVersion = "7.6"
+  gradleVersion = "8.0"
 }
 
 java {

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -144,7 +144,7 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045 
+        # shellcheck disable=SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
@@ -152,7 +152,7 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
       '' | soft) :;; #(
       *)
         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045 
+        # shellcheck disable=SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac

samples/mixed/bukkit-plugins/hello-world/build.gradle.kts

@@ -6,3 +6,7 @@ dependencies {
   implementation(project(":other-library"))
   implementation(project(":bukkit-plugins:common-library"))
 }
+
+concrete {
+  dependency(project(":bukkit-plugins:goodbye-world"))
+}

samples/mixed/gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.1-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

samples/mixed/gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,10 +80,10 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
@@ -143,12 +143,16 @@ fi
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac

samples/mixed/gradlew.bat

@@ -26,6 +26,7 @@ if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
 if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 

samples/shared/gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.1-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

samples/shared/gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,10 +80,10 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
@@ -143,12 +143,16 @@ fi
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac

samples/shared/gradlew.bat

@@ -26,6 +26,7 @@ if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
 if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 

samples/simple/gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.1-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

samples/simple/gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,10 +80,10 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
@@ -143,12 +143,16 @@ fi
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac

samples/simple/gradlew.bat

@@ -26,6 +26,7 @@ if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
 if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 

src/main/kotlin/gay/pizza/foundation/concrete/ConcretePluginExtension.kt

@@ -0,0 +1,12 @@
+package gay.pizza.foundation.concrete
+
+import org.gradle.api.DomainObjectSet
+import org.gradle.api.Project
+
+interface ConcretePluginExtension {
+  val dependencies: DomainObjectSet<Project>
+
+  fun dependency(project: Project) {
+    dependencies.add(project)
+  }
+}

src/main/kotlin/gay/pizza/foundation/concrete/ConcretePluginPlugin.kt

@@ -9,6 +9,8 @@ class ConcretePluginPlugin : ConcreteBaseBukkitPlugin() {
   override fun apply(project: Project) {
     super.apply(project)
 
+    project.extensions.create("concrete", ConcretePluginExtension::class.java)
+
     project.plugins.apply("com.github.johnrengelman.shadow")
 
     // During IDEA project import, if this code is active, it will print warnings.

src/main/kotlin/gay/pizza/foundation/concrete/ConcreteRootExtension.kt

@@ -2,7 +2,7 @@ package gay.pizza.foundation.concrete
 
 import org.gradle.api.provider.Property
 
-interface ConcreteExtension {
+interface ConcreteRootExtension {
   val paperServerVersionGroup: Property<String>
   val paperApiVersion: Property<String>
   val minecraftServerPath: Property<String>

src/main/kotlin/gay/pizza/foundation/concrete/ConcreteRootPlugin.kt

@@ -9,7 +9,7 @@ import java.nio.file.Paths
 class ConcreteRootPlugin : Plugin<Project> {
   override fun apply(project: Project) {
     project.apply(plugin = "base")
-    project.extensions.create<ConcreteExtension>("concrete")
+    project.extensions.create<ConcreteRootExtension>("concrete")
     val setupPaperServer = project.tasks.create<SetupPaperServer>("setupPaperServer")
     val runPaperServer = project.tasks.create<RunPaperServer>("runPaperServer")
     runPaperServer.dependsOn(setupPaperServer)

src/main/kotlin/gay/pizza/foundation/concrete/ExtensibleManifest.kt

@@ -0,0 +1,55 @@
+package gay.pizza.foundation.concrete
+
+/**
+ * The extensible update manifest format.
+ */
+data class ExtensibleManifest(
+  /**
+   * The items the manifest describes.
+   */
+  val items: List<ExtensibleManifestItem>
+)
+
+/**
+ * An item in the update manifest.
+ */
+data class ExtensibleManifestItem(
+  /**
+   * The name of the item.
+   */
+  val name: String,
+  /**
+   * The type of item, for example "bukkit-plugin"
+   */
+  val type: String,
+  /**
+   * The version of the item.
+   */
+  val version: String,
+  /**
+   * The dependencies of the item.
+   */
+  val dependencies: List<String>,
+  /**
+   * The files that are required to install the item.
+   */
+  val files: List<String>
+)
+
+/**
+ * A file built from the item.
+ */
+data class ExtensibleManifestItemFile(
+  /**
+   * The name of the file.
+   */
+  val name: String,
+  /**
+   * A type of file. For example: "plugin-jar".
+   */
+  val type: String,
+  /**
+   * The relative path to download the file.
+   */
+  val path: String
+)

src/main/kotlin/gay/pizza/foundation/concrete/Globals.kt

@@ -1,7 +1,9 @@
 package gay.pizza.foundation.concrete
 
 import com.google.gson.Gson
+import com.google.gson.GsonBuilder
 
 object Globals {
-  val gson = Gson()
+  val gsonPretty: Gson = GsonBuilder().setPrettyPrinting().create()
+  val gson: Gson = Gson()
 }

src/main/kotlin/gay/pizza/foundation/concrete/RunPaperServer.kt

@@ -11,7 +11,7 @@ open class RunPaperServer : RunMinecraftServer() {
 
   @Internal
   override fun getServerDirectory(): File {
-    val concrete = project.extensions.getByType<ConcreteExtension>()
+    val concrete = project.extensions.getByType<ConcreteRootExtension>()
     return project.file(concrete.minecraftServerPath.get())
   }
 

src/main/kotlin/gay/pizza/foundation/concrete/SetupMinecraftServer.kt

@@ -34,7 +34,7 @@ abstract class SetupMinecraftServer : DefaultTask() {
       Files.createSymbolicLink(pluginLinkFile.toPath(), pluginJarFile.toPath())
     }
 
-    val concrete = project.extensions.getByType<ConcreteExtension>()
+    val concrete = project.extensions.getByType<ConcreteRootExtension>()
     if (concrete.acceptServerEula.isPresent && concrete.acceptServerEula.get()) {
       val writer = minecraftServerDirectory.resolve("eula.txt").bufferedWriter()
       val properties = Properties()

src/main/kotlin/gay/pizza/foundation/concrete/SetupPaperServer.kt

@@ -18,7 +18,7 @@ open class SetupPaperServer : SetupMinecraftServer() {
 
   @TaskAction
   fun setupPaperServer() {
-    val concrete = project.extensions.getByType<ConcreteExtension>()
+    val concrete = project.extensions.getByType<ConcreteRootExtension>()
     val minecraftServerDirectory = getServerDirectory()
     val paperJarFile = project.file("${minecraftServerDirectory}/paper.jar")
     if (!paperJarFile.exists() || shouldUpdatePaperServer) {
@@ -50,7 +50,7 @@ open class SetupPaperServer : SetupMinecraftServer() {
 
   @Internal
   override fun getServerDirectory(): File {
-    val concrete = project.extensions.getByType<ConcreteExtension>()
+    val concrete = project.extensions.getByType<ConcreteRootExtension>()
     return project.file(concrete.minecraftServerPath.get())
   }
 }

src/main/kotlin/gay/pizza/foundation/concrete/UpdateManifestTask.kt

@@ -9,10 +9,10 @@ open class UpdateManifestTask : DefaultTask() {
   @TaskAction
   fun update() {
     val manifestsDir = ensureManifestsDirectory()
-    val updateFile = manifestsDir.resolve("update.json")
-    val rootPath = project.rootProject.rootDir.toPath()
-    val updateManifest = project.findPluginProjects().mapNotNull { project ->
+    val rootPath = project.projectDir.toPath()
+    val legacyUpdateManifest = project.findPluginProjects().mapNotNull { project ->
       val paths = project.shadowJarOutputs!!.allFilesRelativeToPath(rootPath)
+
       if (paths.isNotEmpty()) {
         project.name to mapOf(
           "version" to project.version,
@@ -21,7 +21,29 @@ open class UpdateManifestTask : DefaultTask() {
       } else null
     }.toMap()
 
-    Files.writeString(updateFile, Globals.gson.toJson(updateManifest))
+    val legacyUpdateFile = manifestsDir.resolve("update.json")
+    Files.writeString(legacyUpdateFile, Globals.gson.toJson(legacyUpdateManifest))
+
+    val extensibleUpdateManifestItems = project.findPluginProjects().mapNotNull { project ->
+      val paths = project.shadowJarOutputs!!.allFilesRelativeToPath(rootPath)
+
+      val dependencies = project.concretePluginExtension.dependencies.map { it.name }
+      ExtensibleManifestItem(
+        name = project.name,
+        type = "bukkit-plugin",
+        version = project.version.toString(),
+        dependencies = dependencies,
+        files = paths.map { it.toUnixString() }
+      )
+    }
+
+    val extensibleUpdateManifest = ExtensibleManifest(
+      items = extensibleUpdateManifestItems
+    )
+
+    val extensibleUpdateManifestFile = manifestsDir.resolve("manifest.json")
+    Files.writeString(
+      extensibleUpdateManifestFile, Globals.gsonPretty.toJson(extensibleUpdateManifest) + "\n")
   }
 
   private fun ensureManifestsDirectory(): Path {

src/main/kotlin/gay/pizza/foundation/concrete/extensions.kt

@@ -30,20 +30,23 @@ internal val Project.shadowJarTask: ShadowJar?
 internal val Project.shadowJarOutputs: TaskOutputs?
   get() = shadowJarTask?.outputs
 
-internal val Project.concreteRootExtension: ConcreteExtension
+internal val Project.concreteRootExtension: ConcreteRootExtension
   get() = findTargetParent(
-    valid = { extensions.findByType(ConcreteExtension::class.java) != null },
-    extract = { extensions.findByType(ConcreteExtension::class.java)!! },
+    valid = { extensions.findByType(ConcreteRootExtension::class.java) != null },
+    extract = { extensions.findByType(ConcreteRootExtension::class.java)!! },
     error = { "Failed to find concrete root. Did you apply the concrete root plugin?" }
   )
 
+internal val Project.concretePluginExtension: ConcretePluginExtension
+  get() = extensions.getByType(ConcretePluginExtension::class.java)
+
 /**
  * Finds the concrete root project, which is the first project in the project hierarchy
  * that has the concrete extension.
  */
 internal val Project.concreteRootProject: Project
   get() = findTargetParent(
-    valid = { extensions.findByType(ConcreteExtension::class.java) != null },
+    valid = { extensions.findByType(ConcreteRootExtension::class.java) != null },
     extract = { this },
     error = { "Failed to find concrete root. Did you apply the concrete root plugin?" }
   )