use cloud-build-logic (#619)

jpenilla · web-flow · commit bcd083816726 · 2024-01-10T11:29:58.000-07:00
* use cloud-build-logic

* fix

* bump checkstyle

* add back revapi dep

* Remove mavenLocal

* Bump cloud-build-logic
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,14 +1,9 @@
 plugins {
-    id("cloud.parent-build-logic")
+    alias(libs.plugins.cloud.buildLogic.rootProject.publishing)
+    alias(libs.plugins.cloud.buildLogic.rootProject.spotless)
     alias(libs.plugins.versions)
 }
 
-subprojects {
-    if (!name.startsWith("example-")) {
-        apply(plugin = "cloud.publishing-conventions")
-    }
-}
-
 spotlessPredeclare {
     kotlin { ktlint(libs.versions.ktlint.get()) }
     kotlinGradle { ktlint(libs.versions.ktlint.get()) }
diff --git a/cloud-annotations/build.gradle.kts b/cloud-annotations/build.gradle.kts
@@ -2,7 +2,8 @@ import net.ltgt.gradle.errorprone.errorprone
 
 plugins {
     id("cloud.base-conventions")
-    id("com.palantir.revapi")
+    id("cloud.publishing-conventions")
+    alias(libs.plugins.revapi)
 }
 
 dependencies {
diff --git a/cloud-bom/build.gradle.kts b/cloud-bom/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     `java-platform`
+    id("cloud.publishing-conventions")
 }
 
 indra {
diff --git a/cloud-core/build.gradle.kts b/cloud-core/build.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
     id("cloud.base-conventions")
-    id("com.palantir.revapi")
+    id("cloud.publishing-conventions")
+    alias(libs.plugins.revapi)
 }
 
 dependencies {
diff --git a/cloud-core/src/main/java/cloud/commandframework/arguments/flags/CommandFlagParser.java b/cloud-core/src/main/java/cloud/commandframework/arguments/flags/CommandFlagParser.java
@@ -338,7 +338,7 @@ public String getInput() {
      * and flag values. On failure the intermediate results
      * can be obtained, which are used for providing suggestions.
      */
-    private class FlagParser {
+    private final class FlagParser {
 
         private String lastParsedFlag;
 
diff --git a/cloud-discord/cloud-javacord/build.gradle.kts b/cloud-discord/cloud-javacord/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-discord/cloud-jda/build.gradle.kts b/cloud-discord/cloud-jda/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-irc/cloud-pircbotx/build.gradle.kts b/cloud-irc/cloud-pircbotx/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-kotlin/cloud-kotlin-coroutines-annotations/build.gradle.kts b/cloud-kotlin/cloud-kotlin-coroutines-annotations/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.kotlin-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-kotlin/cloud-kotlin-coroutines/build.gradle.kts b/cloud-kotlin/cloud-kotlin-coroutines/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.kotlin-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-kotlin/cloud-kotlin-extensions/build.gradle.kts b/cloud-kotlin/cloud-kotlin-extensions/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.kotlin-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-kotlin/cloud-kotlin-extensions/src/main/kotlin/cloud/commandframework/kotlin/extension/ParserDescriptorExtensions.kt b/cloud-kotlin/cloud-kotlin-extensions/src/main/kotlin/cloud/commandframework/kotlin/extension/ParserDescriptorExtensions.kt
@@ -1,3 +1,26 @@
+//
+// MIT License
+//
+// Copyright (c) 2022 Alexander Söderberg & Contributors
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
 package cloud.commandframework.kotlin.extension
 
 import cloud.commandframework.arguments.parser.ArgumentParser
diff --git a/cloud-minecraft/cloud-brigadier/build.gradle.kts b/cloud-minecraft/cloud-brigadier/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-minecraft/cloud-bukkit/build.gradle.kts b/cloud-minecraft/cloud-bukkit/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-minecraft/cloud-bungee/build.gradle.kts b/cloud-minecraft/cloud-bungee/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-minecraft/cloud-cloudburst/build.gradle.kts b/cloud-minecraft/cloud-cloudburst/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-minecraft/cloud-fabric/build.gradle.kts b/cloud-minecraft/cloud-fabric/build.gradle.kts
@@ -4,6 +4,7 @@ import net.ltgt.gradle.errorprone.errorprone
 plugins {
     id("quiet-fabric-loom")
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 indra {
diff --git a/cloud-minecraft/cloud-minecraft-extras/build.gradle.kts b/cloud-minecraft/cloud-minecraft-extras/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-minecraft/cloud-paper/build.gradle.kts b/cloud-minecraft/cloud-paper/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 java {
diff --git a/cloud-minecraft/cloud-sponge7/build.gradle.kts b/cloud-minecraft/cloud-sponge7/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 dependencies {
diff --git a/cloud-minecraft/cloud-velocity/build.gradle.kts b/cloud-minecraft/cloud-velocity/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     id("cloud.base-conventions")
+    id("cloud.publishing-conventions")
 }
 
 java {
diff --git a/cloud-services/build.gradle.kts b/cloud-services/build.gradle.kts
@@ -1,8 +1,10 @@
 plugins {
     id("cloud.base-conventions")
-    id("com.palantir.revapi")
+    id("cloud.publishing-conventions")
+    alias(libs.plugins.revapi)
 }
 
 dependencies {
+    compileOnlyApi(libs.bundles.annotations)
     api(libs.geantyref)
 }
diff --git a/examples/example-bukkit/build.gradle.kts b/examples/example-bukkit/build.gradle.kts
@@ -1,6 +1,7 @@
 import xyz.jpenilla.runpaper.task.RunServer
 
 plugins {
+    id("cloud.base-conventions")
     id("cloud.example-conventions")
     alias(libs.plugins.shadow)
     alias(libs.plugins.run.paper)
diff --git a/examples/example-bungee/build.gradle.kts b/examples/example-bungee/build.gradle.kts
@@ -1,4 +1,5 @@
 plugins {
+    id("cloud.base-conventions")
     id("cloud.example-conventions")
     alias(libs.plugins.shadow)
     alias(libs.plugins.run.waterfall)
diff --git a/examples/example-javacord/build.gradle b/examples/example-javacord/build.gradle
@@ -1,4 +1,5 @@
 plugins {
+    id("cloud.base-conventions")
     id("cloud.example-conventions")
 }
 
diff --git a/examples/example-jda/build.gradle.kts b/examples/example-jda/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     application
+    id("cloud.base-conventions")
     id("cloud.example-conventions")
     alias(libs.plugins.shadow)
 }
diff --git a/examples/example-velocity/build.gradle.kts b/examples/example-velocity/build.gradle.kts
@@ -1,5 +1,6 @@
 plugins {
     alias(libs.plugins.shadow)
+    id("cloud.base-conventions")
     id("cloud.example-conventions")
     alias(libs.plugins.run.velocity)
 }
diff --git a/gradle/build-logic/build.gradle.kts b/gradle/build-logic/build.gradle.kts
@@ -1,41 +1,41 @@
 plugins {
     `kotlin-dsl`
-    alias(libs.plugins.spotless)
+    alias(libs.plugins.cloud.buildLogic.spotless)
 }
 
 repositories {
     gradlePluginPortal()
+    maven("https://oss.sonatype.org/content/repositories/snapshots/") {
+        name = "sonatypeOssSnapshots"
+        mavenContent { snapshotsOnly() }
+    }
 }
 
 dependencies {
     // loom needs this version of asm, for some reason we have an older one on the classpath without this
     implementation("org.ow2.asm:asm:9.6")
-    implementation(libs.indraCommon)
-    implementation(libs.indraPublishingSonatype)
-    implementation(libs.gradleErrorprone)
+    implementation(libs.cloud.build.logic)
     implementation(libs.gradleKotlinJvm)
     implementation(libs.gradleDokka)
-    implementation(libs.spotless)
-    implementation(libs.revapi)
 
     // https://github.com/gradle/gradle/issues/15383#issuecomment-779893192
     implementation(files(libs.javaClass.superclass.protectionDomain.codeSource.location))
 }
 
-spotless {
-    kotlinGradle {
-        target("*.gradle.kts", "src/*/kotlin/**.gradle.kts", "src/*/kotlin/**.kt")
-        ktlint(libs.versions.ktlint.get())
-            .editorConfigOverride(
-                mapOf(
-                    "ktlint_standard_filename" to "disabled",
-                    "ktlint_standard_trailing-comma-on-call-site" to "disabled",
-                    "ktlint_standard_trailing-comma-on-declaration-site" to "disabled",
-                )
-            )
+cloudSpotless {
+    licenseHeaderFile.convention(null as RegularFile?)
+    ktlintVersion = libs.versions.ktlint
+}
+
+plugin("base")
+plugin("publishing")
+plugin("kotlin")
+plugin("example")
 
-        indentWithSpaces(4)
-        trimTrailingWhitespace()
-        endWithNewline()
+fun plugin(name: String) {
+    val prefixedId = "cloud.$name-conventions"
+    gradlePlugin.plugins.register(name) {
+        id = prefixedId
+        implementationClass = "Cloud${name.replaceFirstChar(Char::uppercase)}Conventions"
     }
 }
diff --git a/gradle/build-logic/settings.gradle.kts b/gradle/build-logic/settings.gradle.kts
@@ -1,5 +1,15 @@
 rootProject.name = "build-logic"
 
+pluginManagement {
+    repositories {
+        gradlePluginPortal()
+        maven("https://oss.sonatype.org/content/repositories/snapshots/") {
+            name = "sonatypeOssSnapshots"
+            mavenContent { snapshotsOnly() }
+        }
+    }
+}
+
 dependencyResolutionManagement {
     versionCatalogs {
         create("libs") {
diff --git a/gradle/build-logic/src/main/kotlin/CloudBaseConventions.kt b/gradle/build-logic/src/main/kotlin/CloudBaseConventions.kt
@@ -0,0 +1,47 @@
+import com.diffplug.gradle.spotless.SpotlessExtension
+import net.kyori.indra.IndraExtension
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.configure
+import org.gradle.kotlin.dsl.dependencies
+import org.incendo.cloudbuildlogic.CloudSpotlessExtension
+
+class CloudBaseConventions : Plugin<Project> {
+    override fun apply(target: Project) {
+        target.plugins.apply("org.incendo.cloud-build-logic")
+        target.plugins.apply("org.incendo.cloud-build-logic.spotless")
+        target.plugins.apply("org.incendo.cloud-build-logic.errorprone")
+
+        val libs = target.libs
+
+        target.extensions.configure(IndraExtension::class) {
+            checkstyle().set(libs.versions.checkstyle)
+        }
+
+        target.extensions.configure(CloudSpotlessExtension::class) {
+            ktlintVersion.set(libs.versions.ktlint)
+        }
+
+        target.extensions.configure(SpotlessExtension::class) {
+            java {
+                importOrderFile(target.rootProject.file(".spotless/cloud.importorder"))
+            }
+        }
+
+        /* Disable checkstyle on tests */
+        target.gradle.startParameter.excludedTaskNames.add("checkstyleTest")
+
+        target.dependencies {
+            "compileOnly"(libs.bundles.immutables)
+            "annotationProcessor"(libs.bundles.immutables)
+
+            "testImplementation"(libs.bundles.baseTestingDependencies)
+
+            "errorprone"(libs.errorproneCore)
+            // Silences compiler warnings from guava using errorprone
+            "compileOnly"(libs.errorproneAnnotations)
+
+            "checkstyle"(libs.stylecheck)
+        }
+    }
+}
diff --git a/gradle/build-logic/src/main/kotlin/CloudExampleConventions.kt b/gradle/build-logic/src/main/kotlin/CloudExampleConventions.kt
@@ -0,0 +1,17 @@
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+import org.incendo.cloudbuildlogic.ciBuild
+
+class CloudExampleConventions : Plugin<Project> {
+    private val Project.compileExamples: Boolean
+        get() = providers.gradleProperty("compile-examples").isPresent
+
+    override fun apply(target: Project) {
+        // Only compile examples on CI, or when the compile-examples property exists
+        if (!target.providers.ciBuild.get() && !target.compileExamples) {
+            target.tasks.configureEach {
+                onlyIf { false }
+            }
+        }
+    }
+}
diff --git a/gradle/build-logic/src/main/kotlin/CloudKotlinConventions.kt b/gradle/build-logic/src/main/kotlin/CloudKotlinConventions.kt
diff --git a/gradle/build-logic/src/main/kotlin/CloudPublishingConventions.kt b/gradle/build-logic/src/main/kotlin/CloudPublishingConventions.kt
diff --git a/gradle/build-logic/src/main/kotlin/cloud.base-conventions.gradle.kts b/gradle/build-logic/src/main/kotlin/cloud.base-conventions.gradle.kts
diff --git a/gradle/build-logic/src/main/kotlin/cloud.errorprone-conventions.gradle.kts b/gradle/build-logic/src/main/kotlin/cloud.errorprone-conventions.gradle.kts
diff --git a/gradle/build-logic/src/main/kotlin/cloud.example-conventions.gradle.kts b/gradle/build-logic/src/main/kotlin/cloud.example-conventions.gradle.kts
diff --git a/gradle/build-logic/src/main/kotlin/cloud.kotlin-conventions.gradle.kts b/gradle/build-logic/src/main/kotlin/cloud.kotlin-conventions.gradle.kts
diff --git a/gradle/build-logic/src/main/kotlin/cloud.parent-build-logic.gradle.kts b/gradle/build-logic/src/main/kotlin/cloud.parent-build-logic.gradle.kts
diff --git a/gradle/build-logic/src/main/kotlin/cloud.publishing-conventions.gradle.kts b/gradle/build-logic/src/main/kotlin/cloud.publishing-conventions.gradle.kts
diff --git a/gradle/build-logic/src/main/kotlin/cloud.spotless-conventions.gradle.kts b/gradle/build-logic/src/main/kotlin/cloud.spotless-conventions.gradle.kts
diff --git a/gradle/build-logic/src/main/kotlin/extensions.kt b/gradle/build-logic/src/main/kotlin/extensions.kt
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
diff --git a/settings.gradle.kts b/settings.gradle.kts

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,8 @@ import net.ltgt.gradle.errorprone.errorprone`
`2`	`2`
`3`	`3`	`plugins {`
`4`	`4`	`id("cloud.base-conventions")`
`5`		`- id("com.palantir.revapi")`
	`5`	`+ id("cloud.publishing-conventions")`
	`6`	`+ alias(libs.plugins.revapi)`
`6`	`7`	`}`
`7`	`8`
`8`	`9`	`dependencies {`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`plugins {`
`2`	`2`	`java-platform`
	`3`	`+ id("cloud.publishing-conventions")`
`3`	`4`	`}`
`4`	`5`
`5`	`6`	`indra {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`plugins {`
`2`	`2`	`id("cloud.base-conventions")`
`3`		`- id("com.palantir.revapi")`
	`3`	`+ id("cloud.publishing-conventions")`
	`4`	`+ alias(libs.plugins.revapi)`
`4`	`5`	`}`
`5`	`6`
`6`	`7`	`dependencies {`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`plugins {`
`2`	`2`	`id("cloud.kotlin-conventions")`
	`3`	`+ id("cloud.publishing-conventions")`
`3`	`4`	`}`
`4`	`5`
`5`	`6`	`dependencies {`