Use simple checkstyle rules since spotless is executed by default

mojohaus · Feb 21, 2024 · 259b35b · 259b35b
1 parent d5330b2
commit 259b35b
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 16 deletions.
diff --git a/pom.xml b/pom.xml
@@ -238,8 +238,8 @@
     <junit5.version>5.10.2</junit5.version>
     <!-- 10.x requires Java 11 -->
     <checkstyle.version>9.3</checkstyle.version>
-    <!-- configuration for checkstyle to use with spotless -->
-    <checkstyle.spotless.config>config/maven_checks_nocodestyle.xml</checkstyle.spotless.config>
+    <!-- by default use simple configuration for checkstyle rules to use with spotless -->
+    <checkstyle.config.location>config/maven_checks_nocodestyle.xml</checkstyle.config.location>
 
     <invoker.streamLogsOnFailures>true</invoker.streamLogsOnFailures>
   </properties>
@@ -300,7 +300,7 @@
               <testSourceDirectory>src/test/java</testSourceDirectory>
             </testSourceDirectories>
             <includeTestSourceDirectory>true</includeTestSourceDirectory>
-            <configLocation>config/maven_checks.xml</configLocation>
+            <configLocation>${checkstyle.config.location}</configLocation>
             <!-- by default don't check headers -->
             <headerLocation>mojohaus/config/checkstyle/empty-header.txt</headerLocation>
           </configuration>

diff --git a/src/site/markdown/index.md.vm b/src/site/markdown/index.md.vm
@@ -71,19 +71,6 @@ Checkstyle can be enabled by adding to build/plugins`:
 </plugin>
 ```
 
-When you want to use `checkstyle` together with `spotless`, please add:
-
-```xml
-<plugin>
-   <groupId>org.apache.maven.plugins</groupId>
-   <artifactId>maven-checkstyle-plugin</artifactId>
-   <configuration>
-      <configLocation>${checkstyle.spotless.config}</configLocation>
-   </configuration>
-</plugin>
-```
-
-
 Big code reformat
 -----------------