Configure a comunity plugin by Extension

Similar to core plugins, also community plugins (or your own plugins) may provide extensions to configure them. In the Kotlin DSL and the Groovy DSL, an extension is accessed directly by its name. In class-baed approaches, we need to retrieve it via 'extensions.getByType()' and provide the implementation type of the extension there.
jjohannes · Jan 6, 2022 · 39baa4d · 39baa4d
1 parent a4d53b5
commit 39baa4d
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 0 deletions.
diff --git a/.../java-plugins/src/main/clojure/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.clj b/.../java-plugins/src/main/clojure/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.clj
@@ -25,5 +25,12 @@
       (.showStackTraces (.getTestLogging test) true)
     ))))
     (.add (.getDependencies project) "implementation" "org.junit.jupiter:junit-jupiter:5.7.2")
+
+    ; Configure a community plugin - example Spotless
+    (.format (.getByType (.getExtensions project) SpotlessExtension) "buildFiles" (reify Action (execute [this format] (do
+      (.target format (into-array Object ["build.gradle.kts"]))
+      (.trimTrailingWhitespace format)
+      (.endWithNewline format)
+    ))))
   )
 )
diff --git a/...logic/java-plugins/src/main/groovy/software.onepiece.gradle.pluginshowto.java-base.gradle b/...logic/java-plugins/src/main/groovy/software.onepiece.gradle.pluginshowto.java-base.gradle
@@ -16,3 +16,12 @@ tasks.named("test") {
 dependencies {
     testImplementation("org.junit.jupiter:junit-jupiter:5.7.2")
 }
+
+// Configure a community plugin - example Spotless
+spotless {
+    format("buildFiles") {
+        target("build.gradle.kts")
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+}
diff --git a/...ava-plugins/src/main/groovy/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.groovy b/...ava-plugins/src/main/groovy/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.groovy
@@ -32,5 +32,13 @@ abstract class MyJavaBasePlugin implements Plugin<Project> {
             it.testLogging.showStackTraces = true
         }
         project.dependencies.add(TEST_IMPLEMENTATION_CONFIGURATION_NAME, "org.junit.jupiter:junit-jupiter:5.7.2")
+
+        // Configure a community plugin - example Spotless
+        def spotless = project.extensions.getByType(SpotlessExtension)
+        spotless.format("buildFiles") {
+            it.target("build.gradle.kts")
+            it.trimTrailingWhitespace()
+            it.endWithNewline()
+        }
     }
 }
diff --git a/...ic/java-plugins/src/main/java/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.java b/...ic/java-plugins/src/main/java/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.java
@@ -31,5 +31,13 @@ public void apply(Project project) {
             test.getTestLogging().setShowStackTraces(true);
         });
         project.getDependencies().add(TEST_IMPLEMENTATION_CONFIGURATION_NAME, "org.junit.jupiter:junit-jupiter:5.7.2");
+
+        // Configure a community plugin - example Spotless
+        SpotlessExtension spotless = project.getExtensions().getByType(SpotlessExtension.class);
+        spotless.format("buildFiles", format -> {
+            format.target("build.gradle.kts");
+            format.trimTrailingWhitespace();
+            format.endWithNewline();
+        });
     }
 }
diff --git a/...c/java-plugins/src/main/kotlin/software.onepiece.gradle.pluginshowto.java-base.gradle.kts b/...c/java-plugins/src/main/kotlin/software.onepiece.gradle.pluginshowto.java-base.gradle.kts
@@ -17,3 +17,11 @@ dependencies {
     testImplementation("org.junit.jupiter:junit-jupiter:5.7.2")
 }
 
+// Configure a community plugin - example Spotless
+spotless {
+    format("buildFiles") {
+        target("build.gradle.kts")
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+}
diff --git a/...ic/java-plugins/src/main/kotlin/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.kt b/...ic/java-plugins/src/main/kotlin/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.kt
@@ -26,5 +26,13 @@ abstract class MyJavaBasePlugin : Plugin<Project> {
             it.testLogging.showStackTraces = true
         }
         dependencies.add(TEST_IMPLEMENTATION_CONFIGURATION_NAME, "org.junit.jupiter:junit-jupiter:5.7.2")
+
+        // Configure a community plugin - example Spotless
+        val spotless = extensions.getByType(SpotlessExtension::class.java)
+        spotless.format("buildFiles") {
+            it.target("build.gradle.kts")
+            it.trimTrailingWhitespace()
+            it.endWithNewline()
+        }
     }
 }
diff --git a/.../java-plugins/src/main/scala/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.scala b/.../java-plugins/src/main/scala/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.scala
@@ -23,5 +23,13 @@ abstract class MyJavaBasePlugin extends Plugin[Project] {
             test.getTestLogging.setShowStandardStreams(true)
         } : Unit)
         project.getDependencies.add(TEST_IMPLEMENTATION_CONFIGURATION_NAME, "org.junit.jupiter:junit-jupiter:5.7.2")
+
+        // Configure a community plugin - example Spotless
+        def spotless = project.getExtensions.getByType(classOf[SpotlessExtension])
+        spotless.format("buildFiles", (format: FormatExtension) => {
+            format.target("build.gradle.kts")
+            format.trimTrailingWhitespace()
+            format.endWithNewline()
+        })
     }
 }