spotless

Author: sebersole

build.gradle

@@ -1,6 +1,7 @@
 plugins {
 	id "io.github.gradle-nexus.publish-plugin"
 	id "release-process"
+	id 'com.diffplug.spotless' version '6.25.0' apply false
 }
 
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

buildSrc/src/main/groovy/java-module.gradle

@@ -2,7 +2,9 @@ plugins {
 	id "base-information"
 	id "java-library"
 
+	id "com.diffplug.spotless"
 	id "checkstyle"
+
 	id "jacoco"
 }
 
@@ -50,6 +52,9 @@ tasks.withType( JavaCompile ).configureEach {javaCompile->
 	options.warnings false
 }
 
+tasks.named( "checkstyleMain" ) {
+	dependsOn( tasks.named( "spotlessJavaApply" ) )
+}
 
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 // Javadoc
@@ -72,6 +77,23 @@ tasks.named( "javadoc", Javadoc ) {
 }
 
 
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+// Spotless
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+spotless {
+	//Don't fail during the check: rather than enforcing guidelines, we use this plugin to fix mistakes automatically.
+	enforceCheck false
+	java {
+		licenseHeaderFile rootProject.file( 'config/spotless/license.java' )
+		removeUnusedImports()
+		indentWithTabs( 4 )
+		trimTrailingWhitespace()
+		endWithNewline()
+	}
+}
+
+
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 // Checkstyle
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

config/checkstyle/checkstyle.xml

@@ -8,49 +8,20 @@
 <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.1//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
 <module name="Checker">
 
-    <module name="Header">
-        <property name="headerFile" value="${config_loc}/headers/header-java.txt"/>
-        <property name="fileExtensions" value="java,gradle,groovy"/>
-    </module>
-
-    <module name="Header">
-        <property name="headerFile" value="${config_loc}/headers/header-xml.txt"/>
-        <property name="fileExtensions" value="xml,xsd,xjb"/>
-    </module>
-
     <module name="TreeWalker">
-        <module name="RegexpSinglelineJava">
-            <property name="ignoreComments" value="true" />
-            <property name="format" value="^\t* +\t*\S" />
-            <property name="message" value="Line has leading space characters; indentation should be performed with tabs only." />
-        </module>
-
-        <module name="Regexp">
-            <property name="format" value="/^(master|slave)$/"/>
-            <property name="illegalPattern" value="true"/>
-            <property name="message" value="Conscious Language (use of terms 'master' or 'slave' not allowed)"/>
-        </module>
-
         <module name="MissingDeprecated" />
-
         <module name="MissingOverride" />
 
-        <module name="PackageAnnotation" />
-
         <module name="NeedBraces" />
-
         <module name="LeftCurly">
             <property name="option" value="eol" />
         </module>
-
         <module name="RightCurly">
             <property name="option" value="alone" />
         </module>
 
         <module name="EqualsHashCode" />
-
         <module name="StringLiteralEquality" />
-
         <module name="NoFinalizer" />
 
         <module name="OneStatementPerLine" />

config/spotless/license.java

@@ -0,0 +1,4 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright: Red Hat Inc. and Hibernate Authors
+ */

hibernate-models-jandex/src/main/java/org/hibernate/models/jandex/internal/AbstractAnnotationTarget.java

@@ -1,6 +1,4 @@
 /*
- * Hibernate, Relational Persistence for Idiomatic Java
- *
  * SPDX-License-Identifier: Apache-2.0
  * Copyright: Red Hat Inc. and Hibernate Authors
  */

hibernate-models-jandex/src/main/java/org/hibernate/models/jandex/internal/AbstractValueExtractor.java

@@ -1,6 +1,4 @@
 /*
- * Hibernate, Relational Persistence for Idiomatic Java
- *
  * SPDX-License-Identifier: Apache-2.0
  * Copyright: Red Hat Inc. and Hibernate Authors
  */

hibernate-models-jandex/src/main/java/org/hibernate/models/jandex/internal/AnnotationUsageBuilder.java

@@ -1,6 +1,4 @@
 /*
- * Hibernate, Relational Persistence for Idiomatic Java
- *
  * SPDX-License-Identifier: Apache-2.0
  * Copyright: Red Hat Inc. and Hibernate Authors
  */

hibernate-models-jandex/src/main/java/org/hibernate/models/jandex/internal/ArrayValueConverter.java

@@ -1,6 +1,4 @@
 /*
- * Hibernate, Relational Persistence for Idiomatic Java
- *
  * SPDX-License-Identifier: Apache-2.0
  * Copyright: Red Hat Inc. and Hibernate Authors
  */

hibernate-models-jandex/src/main/java/org/hibernate/models/jandex/internal/ArrayValueExtractor.java

@@ -1,6 +1,4 @@
 /*
- * Hibernate, Relational Persistence for Idiomatic Java
- *
  * SPDX-License-Identifier: Apache-2.0
  * Copyright: Red Hat Inc. and Hibernate Authors
  */

hibernate-models-jandex/src/main/java/org/hibernate/models/jandex/internal/BooleanValueConverter.java

@@ -1,6 +1,4 @@
 /*
- * Hibernate, Relational Persistence for Idiomatic Java
- *
  * SPDX-License-Identifier: Apache-2.0
  * Copyright: Red Hat Inc. and Hibernate Authors
  */