Skip to content

[AURON #1879] Add maven checkstyle plugin #1880

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
cxzl25 merged 1 commit into from
Jan 19, 2026
+249 −1
Merged

[AURON #1879] Add maven checkstyle plugin #1880

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion auron-core/src/main/java/org/apache/auron/memory/OnHeapSpillManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public interface OnHeapSpillManager {
*
* @return the disabled on-heap spill manager instance
*/
public static OnHeapSpillManager getDisabledOnHeapSpillManager() {
static OnHeapSpillManager getDisabledOnHeapSpillManager() {
return new OnHeapSpillManager() {

@Override
Expand Down
29 changes: 29 additions & 0 deletions dev/checkstyle-suppressions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!--
~ Licensed to the Apache Software Foundation (ASF) under one or more
~ contributor license agreements. See the NOTICE file distributed with
~ this work for additional information regarding copyright ownership.
~ The ASF licenses this file to You under the Apache License, Version 2.0
~ (the "License"); you may not use this file except in compliance with
~ the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->

<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"https://checkstyle.org/dtds/suppressions_1_1.dtd">
<!--

This file contains suppression rules for Checkstyle checks.
Ideally only files that cannot be modified (e.g. third-party code)
should be added here. All other violations should be fixed.

-->
<suppressions>
</suppressions>
181 changes: 181 additions & 0 deletions dev/checkstyle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
<!--
~ Licensed to the Apache Software Foundation (ASF) under one or more
~ contributor license agreements. See the NOTICE file distributed with
~ this work for additional information regarding copyright ownership.
~ The ASF licenses this file to You under the Apache License, Version 2.0
~ (the "License"); you may not use this file except in compliance with
~ the License. You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->

<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">

<!--

Checkstyle configuration based on the Google coding conventions from:

- Google Java Style
https://google.github.io/styleguide/javaguide.html

with Spark-specific changes from:

https://spark.apache.org/contributing.html#code-style-guide

Checkstyle is very configurable. Be sure to read the documentation at
http://checkstyle.sf.net (or in your downloaded distribution).

Most Checks are configurable, be sure to consult the documentation.

To completely disable a check, just comment it out or delete it from the file.

Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.

-->

<module name = "Checker">
<property name="charset" value="UTF-8"/>

<property name="severity" value="error"/>

<property name="fileExtensions" value="java, properties, xml"/>

<module name="SuppressionFilter">
<property name="file" value="dev/checkstyle-suppressions.xml"/>
</module>

<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="FileTabCharacter">
<property name="eachLine" value="true"/>
</module>

<module name="RegexpSingleline">
<!-- \s matches whitespace character, $ matches end of line. -->
<property name="format" value="\s+$"/>
<property name="message" value="No trailing whitespace allowed."/>
</module>

<!-- <module name="LineLength">-->
<!-- <property name="max" value="100"/>-->
<!-- <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>-->
<!-- </module>-->

<module name="NewlineAtEndOfFile"/>

<module name="TreeWalker">
<!--
If you wish to turn off checking for a section of code, you can put a comment in the source
before and after the section, with the following syntax:

// checkstyle.off: XXX (such as checkstyle.off: NoFinalizer)
... // stuff that breaks the styles
// checkstyle.on: XXX (such as checkstyle.on: NoFinalizer)
-->
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="checkstyle\.off\: ([\w\|]+)"/>
<property name="onCommentFormat" value="checkstyle\.on\: ([\w\|]+)"/>
<property name="checkFormat" value="$1"/>
</module>
<module name="OuterTypeFilename"/>
<module name="IllegalTokenText">
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
<property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
<property name="message" value="Avoid using corresponding octal or Unicode escape."/>
</module>
<module name="AvoidEscapedUnicodeCharacters">
<property name="allowEscapesForControlCharacters" value="true"/>
<property name="allowByTailComment" value="true"/>
<property name="allowNonPrintableEscapes" value="true"/>
</module>
<module name="NoLineWrap"/>
<module name="EmptyBlock">
<property name="option" value="TEXT"/>
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
</module>
<module name="NeedBraces">
<property name="allowSingleLineStatement" value="true"/>
</module>
<module name="OneStatementPerLine"/>
<module name="ArrayTypeStyle"/>
<module name="FallThrough"/>
<module name="UpperEll"/>
<module name="ModifierOrder"/>
<module name="SeparatorWrap">
<property name="tokens" value="DOT"/>
<property name="option" value="nl"/>
</module>
<module name="SeparatorWrap">
<property name="tokens" value="COMMA"/>
<property name="option" value="EOL"/>
</module>
<module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
<message key="name.invalidPattern"
value="Package name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="ClassTypeParameterName">
<property name="format" value="([A-Z][a-zA-Z0-9]*$)"/>
<message key="name.invalidPattern"
value="Class type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="MethodTypeParameterName">
<property name="format" value="([A-Z][a-zA-Z0-9]*)"/>
<message key="name.invalidPattern"
value="Method type name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="GenericWhitespace">
<message key="ws.followed"
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
<message key="ws.preceded"
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
<message key="ws.illegalFollow"
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
<message key="ws.notPreceded"
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
</module>
<module name="MethodParamPad"/>
<module name="AnnotationLocation">
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
</module>
<module name="AnnotationLocation">
<property name="tokens" value="VARIABLE_DEF"/>
<property name="allowSamelineMultipleAnnotations" value="true"/>
</module>
<module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
<message key="name.invalidPattern"
value="Method name ''{0}'' must match pattern ''{1}''."/>
</module>
<module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="expected"/>
</module>
<module name="CommentsIndentation"/>
<module name="UnusedImports"/>
<module name="RedundantImport"/>
<module name="RedundantModifier"/>
<module name="RegexpSinglelineJava">
<property name="format" value="throw new \w+Error\("/>
<property name="message" value="Avoid throwing error in application code."/>
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="Objects\.toStringHelper"/>
<property name="message" value="Avoid using Object.toStringHelper. Use ToStringBuilder instead." />
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="new (java\.lang\.)?(Byte|Integer|Long|Short)\("/>
<property name="message" value="Use static factory 'valueOf' or 'parseXXX' instead of the deprecated constructors." />
</module>
<module name="IllegalImport">
<property name="illegalPkgs" value="org.apache.log4j" />
</module>
</module>
</module>
38 changes: 38 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
<maven.plugin.templating.version>3.0.0</maven.plugin.templating.version>
<maven-enforcer-plugin.version>3.5.0</maven-enforcer-plugin.version>

<checkstyle-plugin.version>3.6.0</checkstyle-plugin.version>
<scalamacros.paradise.version>2.1.1</scalamacros.paradise.version>
<junit.jupiter.version>5.13.4</junit.jupiter.version>
<restrict-imports.enforcer.version>2.6.0</restrict-imports.enforcer.version>
Expand Down Expand Up @@ -413,6 +414,43 @@
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
Copy link
Contributor

@cxzl25 cxzl25 Jan 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why we still need checkstyle? Because we have used spotless-maven-plugin.

auron/pom.xml

Lines 488 to 507 in 3264372

<artifactId>spotless-maven-plugin</artifactId>
<version>${spotless.plugin.version}</version>
<configuration>
<java>
<palantirJavaFormat />
<removeUnusedImports />
<licenseHeader>
<file>${maven.multiModuleProjectDirectory}/dev/license-header</file>
</licenseHeader>
</java>
<scala>
<scalafmt>
<version>${scalafmtVersion}</version>
<file>${maven.multiModuleProjectDirectory}/scalafmt.conf</file>
<scalaMajorVersion>${scalaVersion}</scalaMajorVersion>
</scalafmt>
<licenseHeader>
<file>${maven.multiModuleProjectDirectory}/dev/license-header</file>
</licenseHeader>
</scala>

Copy link
Contributor Author

@yew1eb yew1eb Jan 11, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add Checkstyle to complement Spotless — while both serve as quality gates, Spotless focuses on format consistency (auto-fixable) and Checkstyle on semantic style rules (readability/maintainability) that Spotless doesn’t address. This dual setup ensures comprehensive code standard enforcement, which is critical for project quality.

<version>${checkstyle-plugin.version}</version>
<configuration>
<failOnViolation>true</failOnViolation>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
<sourceDirectories>
<directory>${project.basedir}/src/main/java</directory>
<directory>${project.basedir}/src/main/scala</directory>
</sourceDirectories>
<testSourceDirectories>
<directory>${project.basedir}/src/test/java</directory>
</testSourceDirectories>
<suppressionsLocation>${maven.multiModuleProjectDirectory}/dev/checkstyle-suppressions.xml</suppressionsLocation>
<configLocation>${maven.multiModuleProjectDirectory}/dev/checkstyle.xml</configLocation>
<outputFile>${project.basedir}/target/checkstyle-output.xml</outputFile>
<inputEncoding>UTF-8</inputEncoding>
<outputEncoding>UTF-8</outputEncoding>
</configuration>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>8.29</version>
</dependency>
</dependencies>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
<phase>validate</phase>
</execution>
</executions>
</plugin>

<!-- disable surefire globally, only enable it on pure Java modules -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand Down
Loading