Converted to Java Plugin

Author: mfriesen

build.gradle

@@ -1,14 +1,18 @@
 plugins {
-  id 'groovy-gradle-plugin'
+  id 'java-gradle-plugin'
+  id "com.gradle.plugin-publish" version "2.0.0"
   id 'com.diffplug.spotless' version '7.2.1'
 }
 
+group   'com.formkiq.gradle'
+version '1.0.0'
+
 allprojects {
   apply plugin: 'com.diffplug.spotless'
 }
 
 repositories {
-  gradlePluginPortal() // so that external plugins can be resolved in dependencies section
+  gradlePluginPortal()
 }
 
 dependencies {
@@ -35,3 +39,32 @@ spotless {
 }
 
 spotlessCheck.dependsOn spotlessApply
+
+gradlePlugin {
+  website = 'https://github.com/formkiq/java-base-plugin'
+  vcsUrl  = 'https://github.com/formkiq/java-base-plugin'
+  plugins {
+    javaBase {
+      id = "com.formkiq.gradle.java-base"
+      displayName = "FormKiQ Java Base Conventions"
+      description = "Applies Java 17 toolchain, Spotless, SpotBugs, Checkstyle, Versions plugin, and standard repos."
+      implementationClass = "com.formkiq.gradle.JavaBasePlugin"
+      tags = [
+        "java",
+        "conventions",
+        "spotless",
+        "spotbugs",
+        "checkstyle"
+      ]
+    }
+  }
+}
+
+publishing {
+  publications {
+    pluginMaven(MavenPublication) {
+    }
+  }
+}
+
+check.dependsOn(tasks.publishToMavenLocal)

src/main/groovy/com.formkiq.gradle.java-base.gradle

@@ -0,0 +1,111 @@
+package com.formkiq.gradle;
+
+import com.diffplug.gradle.spotless.SpotlessExtension;
+import com.github.spotbugs.snom.SpotBugsExtension;
+import org.gradle.api.Plugin;
+import org.gradle.api.Project;
+import org.gradle.api.plugins.JavaPluginExtension;
+import org.gradle.api.plugins.quality.CheckstyleExtension;
+import org.gradle.api.tasks.compile.JavaCompile;
+import org.gradle.api.tasks.testing.Test;
+import org.gradle.jvm.toolchain.JavaLanguageVersion;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+/**
+ * {@link Plugin} for FormKiQ Gradle Conventions.
+ */
+public class JavaBasePlugin implements Plugin<Project> {
+
+  /** Checkstyle Version. */
+  private static final String CHECKSTYLE_TOOL_VERSION = "10.12.4";
+
+  @Override
+  public void apply(Project root) {
+    root.getRepositories().mavenCentral();
+
+    // configure root + all subprojects
+    root.getAllprojects().forEach(p -> {
+      // Apply plugins
+      p.getPluginManager().apply("com.diffplug.spotless");
+      p.getPluginManager().apply("java-library");
+      p.getPluginManager().apply("checkstyle");
+      p.getPluginManager().apply("com.github.spotbugs");
+      p.getPluginManager().apply("com.github.ben-manes.versions");
+      p.getPluginManager().apply("com.formkiq.gradle.graalvm-native-plugin");
+      p.getPluginManager().apply("distribution");
+
+      // Repositories
+      p.getRepositories().mavenLocal();
+      p.getRepositories().mavenCentral();
+       p.getRepositories().maven(repo -> repo.setUrl("https://central.sonatype.com/repository/maven-snapshots/"));
+
+      // Java toolchain 17
+      JavaPluginExtension java = p.getExtensions().getByType(JavaPluginExtension.class);
+      java.getToolchain().getLanguageVersion().set(JavaLanguageVersion.of(17));
+
+      // Spotless
+      p.getExtensions().configure(SpotlessExtension.class, (SpotlessExtension s) -> {
+        s.java(j -> {
+          j.eclipse().sortMembersEnabled(true).configFile(p.getRootProject().file("spotless.eclipseformat.xml"));
+          j.removeUnusedImports();
+          j.removeWildcardImports();
+          j.licenseHeaderFile(p.getRootProject().file("LICENSE"));
+        });
+        s.groovyGradle(g -> {
+          g.target("*.gradle", "**/*.gradle");
+          g.greclipse();
+          g.leadingTabsToSpaces(2);
+          g.trimTrailingWhitespace();
+          g.endWithNewline();
+        });
+      });
+
+      // SpotBugs
+      p.getExtensions().configure(SpotBugsExtension.class, sb ->
+          sb.getExcludeFilter().set(p.file(p.getRootDir() + "/config/gradle/spotbugs-exclude.xml"))
+      );
+
+      p.getTasks().withType(com.github.spotbugs.snom.SpotBugsTask.class).configureEach(t -> {
+        if (t.getReports().findByName("html") == null) {
+          t.getReports().create("html");
+        }
+
+        t.getReports().getByName("html").getRequired().set(true);
+        if (t.getReports().findByName("xml") != null) {
+          t.getReports().getByName("xml").getRequired().set(false);
+        }
+      });
+
+      // Checkstyle
+      p.getExtensions().configure(CheckstyleExtension.class, cs -> {
+        cs.setToolVersion(CHECKSTYLE_TOOL_VERSION);
+        cs.setConfigFile(p.file("config/checkstyle/checkstyle.xml"));
+        Map<String, Object> props = new LinkedHashMap<>();
+        props.put("project_loc", p.getProjectDir());
+        cs.setConfigProperties(props);
+        cs.setMaxWarnings(0);
+        cs.setMaxErrors(0);
+      });
+
+      // Compiler flags
+      p.getTasks().withType(JavaCompile.class).configureEach(jc ->
+          jc.getOptions().getCompilerArgs().add("-Xlint:deprecation")
+      );
+
+      // Tests
+      p.getTasks().withType(Test.class).configureEach(t -> {
+        t.useJUnitPlatform();
+        t.setFailFast(true);
+      });
+
+      p.afterEvaluate(prj -> {
+        if (!prj.file("config/checkstyle/checkstyle.xml").exists()) {
+          prj.getLogger().warn("Checkstyle config not found at config/checkstyle/checkstyle.xml");
+        }
+      });
+    });
+
+  }
+}