Reorganize build conventions

Author: zhangt2333

build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     application
-    id("tai-e.conventions")
+    id("java.conventions")
+    id("checkstyle.conventions")
     id("maven-publish.conventions")
 }
 

buildSrc/src/main/kotlin/CheckstyleUtils.kt

@@ -38,7 +38,15 @@ fun summarizeStyleViolations(checkstyle: Checkstyle): String? {
         var id = 1
         violationGroup.forEach {
             it.forEach {
-                result.append("\n#${id++}: ${it.msg}\n  rule: ${it.source}\n  Please click to fix: ${it.path}")
+                result.append("\n#${id++}: ${it.msg} (corresponding rule is ${it.source})")
+                // use file protocol to help quick locating
+                val path = it.path.replace("\\", "/")
+                val pathWithFileProtocol = if (path.startsWith("/")) {
+                    "file://" + path
+                } else {
+                    "file:///" + path
+                }
+                result.append("\n  Please click to fix: ${pathWithFileProtocol}")
             }
         }
         return result.toString().removeHtmlTag()

buildSrc/src/main/kotlin/checkstyle.conventions.gradle.kts

@@ -0,0 +1,21 @@
+plugins {
+    checkstyle
+}
+
+// checks the code style after compilation
+tasks.findByName("classes")?.finalizedBy("checkstyleMain")
+tasks.findByName("testClasses")?.finalizedBy("checkstyleTest")
+
+// custom the report format
+checkstyle {
+    isShowViolations = false
+}
+tasks.withType<Checkstyle> {
+    // only xml need
+    reports {
+        xml.required.set(true)
+        html.required.set(false)
+    }
+    // report the error style to help developers fix it
+    doLast { summarizeStyleViolations(this as Checkstyle)?.let(logger::warn) }
+}

buildSrc/src/main/kotlin/java.conventions.gradle.kts

@@ -0,0 +1,25 @@
+plugins {
+    java
+    jacoco
+}
+
+repositories {
+    mavenCentral()
+}
+
+java {
+    toolchain {
+        languageVersion.set(javaVersion)
+    }
+}
+
+tasks.withType<JavaCompile> {
+    options.encoding = "UTF-8"
+}
+
+// jacoco
+tasks.jacocoTestReport {
+    reports {
+        xml.required.set(true)
+    }
+}

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

@@ -14,6 +14,37 @@ java {
     withSourcesJar()
 }
 
+tasks.withType<Javadoc> {
+    val javadocConfigDir = rootProject.rootDir.resolve(
+        "config/javadoc/")
+    fun String.escapeLineBreaking() = this.replace("\r", "")
+        .replace("\n", "")
+    options {
+        this as StandardJavadocDocletOptions
+        // style
+        title = "Tai-e $projectVersion API"
+        overview = javadocConfigDir.resolve("overview.html").path
+        addStringOption("-add-stylesheet",
+            javadocConfigDir.resolve("javadoc.css").path)
+        header = javadocConfigDir.resolve("header.html").readText().escapeLineBreaking()
+        bottom = javadocConfigDir.resolve("footer.html").readText().escapeLineBreaking()
+        // fix language and encoding
+        encoding = "UTF-8"
+        docEncoding = "UTF-8"
+        locale = "en"
+        jFlags("-Duser.language=en")
+        // suppress the warning(s)
+        addBooleanOption("Xdoclint:all,-missing", true)
+        // others
+        splitIndex(true)
+        use(true)
+        noTimestamp(true)
+        memberLevel = JavadocMemberLevel.PROTECTED
+        addBooleanOption("html5", true)
+        links("https://docs.oracle.com/en/java/javase/17/docs/api")
+    }
+}
+
 val signingKeyId: String? by project         // env.ORG_GRADLE_PROJECT_signingKeyId
 val signingKey: String? by project           // env.ORG_GRADLE_PROJECT_signingKey
 val signingPassword: String? by project      // env.ORG_GRADLE_PROJECT_signingPassword