Configure a comunity plugin by Extension

jjohannes · jjohannes · commit 39baa4d302a4 · 2022-01-06T10:53:06.000+01:00
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.
diff --git a/clojure/gradle-build-logic/java-plugins/src/main/clojure/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.clj b/clojure/gradle-build-logic/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/groovy-dsl/gradle-build-logic/java-plugins/src/main/groovy/software.onepiece.gradle.pluginshowto.java-base.gradle b/groovy-dsl/gradle-build-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/groovy/gradle-build-logic/java-plugins/src/main/groovy/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.groovy b/groovy/gradle-build-logic/java-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/java/gradle-build-logic/java-plugins/src/main/java/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.java b/java/gradle-build-logic/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/kotlin-dsl/gradle-build-logic/java-plugins/src/main/kotlin/software.onepiece.gradle.pluginshowto.java-base.gradle.kts b/kotlin-dsl/gradle-build-logic/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/kotlin/gradle-build-logic/java-plugins/src/main/kotlin/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.kt b/kotlin/gradle-build-logic/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/scala/gradle-build-logic/java-plugins/src/main/scala/software/onepiece/gradle/pluginshowto/MyJavaBasePlugin.scala b/scala/gradle-build-logic/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()
+        })
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -25,5 +25,12 @@`
`25`	`25`	`(.showStackTraces (.getTestLogging test) true)`
`26`	`26`	`))))`
`27`	`27`	`(.add (.getDependencies project) "implementation" "org.junit.jupiter:junit-jupiter:5.7.2")`
	`28`	`+`
	`29`	`+ ; Configure a community plugin - example Spotless`
	`30`	`+ (.format (.getByType (.getExtensions project) SpotlessExtension) "buildFiles" (reify Action (execute [this format] (do`
	`31`	`+ (.target format (into-array Object ["build.gradle.kts"]))`
	`32`	`+ (.trimTrailingWhitespace format)`
	`33`	`+ (.endWithNewline format)`
	`34`	`+ ))))`
`28`	`35`	`)`
`29`	`36`	`)`
Original file line number	Diff line number	Diff line change
`@@ -32,5 +32,13 @@ abstract class MyJavaBasePlugin implements Plugin<Project> {`
`32`	`32`	`it.testLogging.showStackTraces = true`
`33`	`33`	`}`
`34`	`34`	`project.dependencies.add(TEST_IMPLEMENTATION_CONFIGURATION_NAME, "org.junit.jupiter:junit-jupiter:5.7.2")`
	`35`	`+`
	`36`	`+ // Configure a community plugin - example Spotless`
	`37`	`+ def spotless = project.extensions.getByType(SpotlessExtension)`
	`38`	`+ spotless.format("buildFiles") {`
	`39`	`+ it.target("build.gradle.kts")`
	`40`	`+ it.trimTrailingWhitespace()`
	`41`	`+ it.endWithNewline()`
	`42`	`+ }`
`35`	`43`	`}`
`36`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,5 +31,13 @@ public void apply(Project project) {`
`31`	`31`	`test.getTestLogging().setShowStackTraces(true);`
`32`	`32`	`});`
`33`	`33`	`project.getDependencies().add(TEST_IMPLEMENTATION_CONFIGURATION_NAME, "org.junit.jupiter:junit-jupiter:5.7.2");`
	`34`	`+`
	`35`	`+ // Configure a community plugin - example Spotless`
	`36`	`+ SpotlessExtension spotless = project.getExtensions().getByType(SpotlessExtension.class);`
	`37`	`+ spotless.format("buildFiles", format -> {`
	`38`	`+ format.target("build.gradle.kts");`
	`39`	`+ format.trimTrailingWhitespace();`
	`40`	`+ format.endWithNewline();`
	`41`	`+ });`
`34`	`42`	`}`
`35`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,5 +26,13 @@ abstract class MyJavaBasePlugin : Plugin<Project> {`
`26`	`26`	`it.testLogging.showStackTraces = true`
`27`	`27`	`}`
`28`	`28`	`dependencies.add(TEST_IMPLEMENTATION_CONFIGURATION_NAME, "org.junit.jupiter:junit-jupiter:5.7.2")`
	`29`	`+`
	`30`	`+ // Configure a community plugin - example Spotless`
	`31`	`+ val spotless = extensions.getByType(SpotlessExtension::class.java)`
	`32`	`+ spotless.format("buildFiles") {`
	`33`	`+ it.target("build.gradle.kts")`
	`34`	`+ it.trimTrailingWhitespace()`
	`35`	`+ it.endWithNewline()`
	`36`	`+ }`
`29`	`37`	`}`
`30`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,13 @@ abstract class MyJavaBasePlugin extends Plugin[Project] {`
`23`	`23`	`test.getTestLogging.setShowStandardStreams(true)`
`24`	`24`	`} : Unit)`
`25`	`25`	`project.getDependencies.add(TEST_IMPLEMENTATION_CONFIGURATION_NAME, "org.junit.jupiter:junit-jupiter:5.7.2")`
	`26`	`+`
	`27`	`+ // Configure a community plugin - example Spotless`
	`28`	`+ def spotless = project.getExtensions.getByType(classOf[SpotlessExtension])`
	`29`	`+ spotless.format("buildFiles", (format: FormatExtension) => {`
	`30`	`+ format.target("build.gradle.kts")`
	`31`	`+ format.trimTrailingWhitespace()`
	`32`	`+ format.endWithNewline()`
	`33`	`+ })`
`26`	`34`	`}`
`27`	`35`	`}`