Move checkstyle settings to plugin

pubnub · Sep 16, 2024 · a620aa1 · a620aa1
1 parent c89fee1
commit a620aa1
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 51 deletions.
diff --git a/build-logic/gradle-plugins/src/main/kotlin/com/pubnub/gradle/PubNubJavaLibraryPlugin.kt b/build-logic/gradle-plugins/src/main/kotlin/com/pubnub/gradle/PubNubJavaLibraryPlugin.kt
@@ -3,19 +3,42 @@ package com.pubnub.gradle
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.plugins.JavaLibraryPlugin
+import org.gradle.api.plugins.quality.Checkstyle
+import org.gradle.api.plugins.quality.CheckstyleExtension
+import org.gradle.api.plugins.quality.CheckstylePlugin
+import org.gradle.api.tasks.SourceSetContainer
 import org.gradle.api.tasks.compile.JavaCompile
 import org.gradle.kotlin.dsl.apply
+import org.gradle.kotlin.dsl.configure
+import org.gradle.kotlin.dsl.getByType
 import org.gradle.kotlin.dsl.withType
 
 class PubNubJavaLibraryPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         with(target) {
             apply<PubNubSharedPlugin>()
             apply<JavaLibraryPlugin>()
+            apply<CheckstylePlugin>()
 
             tasks.withType<JavaCompile>().configureEach {
                 it.options.compilerArgs.add("-parameters")
             }
+
+            extensions.configure<CheckstyleExtension> {
+                toolVersion = "8.14"
+                configFile = rootProject.file("config/checkstyle/checkstyle.xml")
+                sourceSets = listOf(extensions.getByType<SourceSetContainer>().getByName("main"))
+            }
+
+            tasks.withType<Checkstyle>().configureEach {
+                it.exclude("**/vendor/**", "**/*Test*")
+
+                it.reports { report ->
+                    report.xml.required.set(true)
+                    report.html.required.set(true)
+                }
+            }
+
         }
     }
 }
diff --git a/pubnub-gson/build.gradle.kts b/pubnub-gson/build.gradle.kts
@@ -1,5 +1,4 @@
 plugins {
-    checkstyle
     alias(libs.plugins.benmanes.versions)
     alias(libs.plugins.lombok)
     id("pubnub.java-library")
@@ -10,18 +9,3 @@ dependencies {
     api(project(":pubnub-gson:pubnub-gson-api"))
     implementation(project(":pubnub-gson:pubnub-gson-impl"))
 }
-
-checkstyle {
-    toolVersion = "8.14"
-    configFile = rootProject.file("config/checkstyle/checkstyle.xml")
-    sourceSets = listOf(project.sourceSets.getByName("main"))
-}
-
-tasks.withType<Checkstyle>().configureEach {
-    exclude("**/vendor/**", "**/*Test*")
-
-    reports {
-        xml.required = true
-        html.required = true
-    }
-}
diff --git a/pubnub-gson/pubnub-gson-api/build.gradle.kts b/pubnub-gson/pubnub-gson-api/build.gradle.kts
@@ -1,5 +1,4 @@
 plugins {
-    checkstyle
     alias(libs.plugins.benmanes.versions)
     alias(libs.plugins.lombok)
     id("pubnub.java-library")
@@ -9,23 +8,6 @@ plugins {
 
 dependencies {
     api(project(":pubnub-kotlin:pubnub-kotlin-api"))
-//    implementation(project(":pubnub-core:pubnub-core-impl"))
-
     implementation(libs.slf4j)
     implementation(libs.jetbrains.annotations)
 }
-
-checkstyle {
-    toolVersion = "8.14"
-    configFile = rootProject.file("config/checkstyle/checkstyle.xml")
-    sourceSets = listOf(project.sourceSets.getByName("main"))
-}
-
-tasks.withType<Checkstyle>().configureEach {
-    exclude("**/vendor/**", "**/*Test*")
-
-    reports {
-        xml.required = true
-        html.required = true
-    }
-}
diff --git a/pubnub-gson/pubnub-gson-impl/build.gradle.kts b/pubnub-gson/pubnub-gson-impl/build.gradle.kts
@@ -1,5 +1,4 @@
 plugins {
-    checkstyle
     alias(libs.plugins.benmanes.versions)
     alias(libs.plugins.lombok)
     id("pubnub.java-library")
@@ -10,7 +9,6 @@ plugins {
 }
 
 dependencies {
-//    api(project(":pubnub-kotlin:pubnub-kotlin-api"))
     api(project(":pubnub-gson:pubnub-gson-api"))
     implementation(project(":pubnub-kotlin:pubnub-kotlin-impl"))
 
@@ -32,18 +30,3 @@ dependencies {
     testImplementation("com.google.guava:guava:33.3.0-jre")
     "integrationTestImplementation"(libs.owner)
 }
-
-checkstyle {
-    toolVersion = "8.14"
-    configFile = rootProject.file("config/checkstyle/checkstyle.xml")
-    sourceSets = listOf(project.sourceSets.getByName("main"))
-}
-
-tasks.withType<Checkstyle>().configureEach {
-    exclude("**/vendor/**", "**/*Test*")
-
-    reports {
-        xml.required = true
-        html.required = true
-    }
-}