build: Use utility function to configure published artifacts

Author: freya022

BotCommands-core/build.gradle.kts

@@ -159,3 +159,5 @@ kotlin {
         )
     }
 }
+
+configurePublishedArtifact(artifactId = "BotCommands-core")

BotCommands-spring/build.gradle.kts

@@ -31,3 +31,5 @@ dependencies {
     testImplementation(libs.spring.boot.starter)
     testRuntimeOnly(libs.spring.boot.devtools)
 }
+
+configurePublishedArtifact(artifactId = "BotCommands-spring")

build.gradle.kts

@@ -29,8 +29,4 @@ dependencies {
     dokka(projects.botCommandsSpring)
 }
 
-mavenPublishing {
-    pom {
-        packaging = "pom"
-    }
-}
+configurePublishedArtifact(artifactId = "BotCommands", packaging = "pom")

buildSrc/src/main/kotlin/BotCommands-publish-conventions.gradle.kts

@@ -97,7 +97,6 @@ mavenPublishing {
     }
 
     pom {
-        name = project.name
         description = "A Kotlin-first (and Java) framework that makes creating Discord bots a piece of cake, using the JDA library."
         url = "https://github.com/freya022/BotCommands"
         inceptionYear = "2020"
@@ -126,3 +125,9 @@ mavenPublishing {
         }
     }
 }
+
+afterEvaluate {
+    check(isPublishedArtifactConfigured(project)) {
+        "Project '${project.path}' did not call 'configurePublishedArtifact'"
+    }
+}

buildSrc/src/main/kotlin/tasks.kt

@@ -0,0 +1,44 @@
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.*
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+import org.jetbrains.dokka.gradle.DokkaExtension
+import com.vanniktech.maven.publish.MavenPublishBaseExtension
+
+private val configuredPublishedArtifacts = hashSetOf<String>()
+
+fun isPublishedArtifactConfigured(project: Project) = project.path in configuredPublishedArtifacts
+
+/**
+ * Sets the provided [artifactId] as the Kotlin module name, Dokka module name & path, and Maven artifact ID.
+ */
+fun Project.configurePublishedArtifact(artifactId: String, packaging: String? = null) {
+    check(artifactId.startsWith("BotCommands")) {
+        "Artifact ID must start with 'BotCommands'"
+    }
+
+    configuredPublishedArtifacts += this.path
+
+    tasks.withType<KotlinCompile> {
+        compilerOptions {
+            // Match up with Dokka's module path, as the wiki reconstructs wiki links with the module name
+            moduleName = artifactId
+        }
+    }
+
+    extensions.configure<DokkaExtension>("dokka") {
+        // For display in the nav sidebar
+        moduleName = artifactId
+        // For URLs consistent with the Kotlin module name
+        modulePath = artifactId
+    }
+
+    extensions.configure<MavenPublishBaseExtension>("mavenPublishing") {
+        coordinates(artifactId = artifactId)
+
+        pom {
+            // Sonatype requires
+            this.name = artifactId
+            this.packaging = packaging
+        }
+    }
+}