Skip to content

build: replace Checkstyle with Spotless (google-java-format) #1237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ehsavoie merged 1 commit into from
Oct 23, 2026
Merged

build: replace Checkstyle with Spotless (google-java-format) #1237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 91 additions & 21 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,12 @@
<logback.version>1.6.3</logback.version>
<version.testcontainers>2.0.5</version.testcontainers>
<error-prone.version>2.50.0</error-prone.version>
<spotless-maven-plugin.version>3.10.4</spotless-maven-plugin.version>
<google-java-format.version>1.37.0</google-java-format.version>
<nullaway.version>0.14.1</nullaway.version>
<error-prone.flag>-XDaddTypeAnnotationsToSymbol=true</error-prone.flag>
<nullaway.args>-Xplugin:ErrorProne -XepDisableAllChecks -Xep:NullAway:ERROR -Xep:RequireExplicitNullMarking:WARN -XepOpt:NullAway:ExhaustiveOverride=true -XepOpt:NullAway:OnlyNullMarked=true -XepOpt:NullAway:JSpecifyMode=true -XepExcludedPaths:.*/src/test/.* -XepDisableWarningsInGeneratedCode</nullaway.args>
<skip.spotless>true</skip.spotless>

<!-- Redirect test output to file -->
<maven.test.redirectTestOutputToFile>true</maven.test.redirectTestOutputToFile>
Expand Down Expand Up @@ -588,6 +591,11 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>com.diffplug.spotless</groupId>
<artifactId>spotless-maven-plugin</artifactId>
<version>${spotless-maven-plugin.version}</version>
</plugin>
</plugins>
</pluginManagement>
<plugins>
Expand All @@ -604,32 +612,94 @@
<artifactId>central-publishing-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${maven-checkstyle-plugin.version}</version>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>${checkstyle.version}</version>
</dependency>
</dependencies>
<groupId>com.diffplug.spotless</groupId>
<artifactId>spotless-maven-plugin</artifactId>
<configuration>
<skip>${skip.spotless}</skip>
<formats>
<!-- you can define as many formats as you want, each is independent -->
<format>
<!-- define the files to apply to -->
<includes>
<include>.gitignore</include>
</includes>
<!-- define the steps to apply to those files -->
<trimTrailingWhitespace/>
<endWithNewline/>
<indent>
<spaces>true</spaces>
<spacesPerTab>4</spacesPerTab>
</indent>
</format>
</formats>
<!-- define a language-specific format -->
<java>
<includes>
<include>**/src/main/java/**/*.java</include>
<include>**/src/test/java/**/*.java</include>
</includes>
<googleJavaFormat>
<version>1.36.1</version>
<style>AOSP</style>
<reflowLongStrings>true</reflowLongStrings>
<formatJavadoc>false</formatJavadoc>
</googleJavaFormat>
<importOrder/>
<shortenFullyQualifiedTypes/>
<importOrder/>
<removeUnusedImports/>
<indent>
<spaces>true</spaces>
<spacesPerTab>4</spacesPerTab>
</indent>
</java>
<pom>
<includes>
<include>pom.xml</include>
<include>**/pom.xml</include>
</includes>
<sortPom>
<encoding>UTF-8</encoding>
<expandEmptyElements>false</expandEmptyElements>
<spaceBeforeCloseEmptyElement>true</spaceBeforeCloseEmptyElement>
<keepBlankLines>true</keepBlankLines>
<nrOfIndentSpace>4</nrOfIndentSpace>
<indentBlankLines>false</indentBlankLines>
<indentSchemaLocation>false</indentSchemaLocation>
<predefinedSortOrder>recommended_2008_06</predefinedSortOrder>
<sortPlugins>groupId,artifactId</sortPlugins>
<sortProperties>true</sortProperties>
<sortModules>false</sortModules>
<sortExecutions>false</sortExecutions>
</sortPom>
</pom>
<markdown>
<includes>
<!-- You have to set the target manually -->
<include>docs/**/*.md</include>
<include>CODE_OF_CONDUCT.md</include>
<include>CONTRIBUTING.md</include>
<include>CONTRIBUTING_INTEGRATIONS.md</include>
<include>README.md</include>
<include>RELEASE.md</include>
<include>SECURITY.md</include>
</includes>
<flexmark>
<emulationProfile>COMMONMARK</emulationProfile>
<pegdownExtensions>ALL,TOC</pegdownExtensions>
<extensions>YamlFrontMatter,Emoji</extensions>
<formatterOptions>
<rightMargin>120</rightMargin>
</formatterOptions>
</flexmark>
</markdown>
</configuration>
<executions>
<execution>
<id>checkstyle-validation</id>
<phase>validate</phase>
<inherited>true</inherited>
<configuration>
<skip>false</skip>
<configLocation>src/checkstyle/checkstyle.xml</configLocation>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
<consoleOutput>true</consoleOutput>
<failsOnError>false</failsOnError>
<failOnViolation>${checkstyle.failOnViolation}</failOnViolation>
</configuration>
<goals>
<goal>check</goal>
</goals>
<phase>compile</phase>
</execution>
</executions>
</plugin>
Expand Down
Loading