Skip to content

Commit

Permalink
Add Spring Checkstyle with all checks disabled
Browse files Browse the repository at this point in the history
Introduce checkstyle rules from spring-javaformat, but keep them
disabled so that fixes can be introduced one commit at a time.

Issue gh-8945
  • Loading branch information
philwebb authored and rwinch committed Aug 24, 2020
1 parent 71bc145 commit aea0fea
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 84 deletions.
15 changes: 14 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,22 @@ subprojects {

allprojects {
apply plugin: 'io.spring.javaformat'
apply plugin: 'checkstyle'

pluginManager.withPlugin("io.spring.convention.checkstyle", { plugin ->
configure(plugin) {
dependencies {
checkstyle "io.spring.javaformat:spring-javaformat-checkstyle:$springJavaformatVersion"
}
checkstyle {
toolVersion = '8.34'
}
}
})

if (project.name.contains('sample')) {
tasks.whenTaskAdded { task ->
if (task.name.contains('format') || task.name.contains('checkFormat')) {
if (task.name.contains('format') || task.name.contains('checkFormat') || task.name.contains("checkstyle")) {
task.enabled = false
}
}
Expand Down
47 changes: 47 additions & 0 deletions etc/checkstyle/checkstyle-suppressions.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
"https://checkstyle.org/dtds/suppressions_1_2.dtd">
<suppressions>
<suppress files=".*" checks="AnnotationUseStyle" />
<suppress files=".*" checks="ArrayTypeStyle" />
<suppress files=".*" checks="AtclauseOrder" />
<suppress files=".*" checks="AvoidStarImport" />
<suppress files=".*" checks="EmptyBlock" />
<suppress files=".*" checks="FinalClass" />
<suppress files=".*" checks="InnerAssignment" />
<suppress files=".*" checks="InnerTypeLast" />
<suppress files=".*" checks="InterfaceIsType" />
<suppress files=".*" checks="JavadocMethod" />
<suppress files=".*" checks="JavadocStyle" />
<suppress files=".*" checks="JavadocTagContinuationIndentation" />
<suppress files=".*" checks="JavadocType" />
<suppress files=".*" checks="JavadocVariable" />
<suppress files=".*" checks="ModifierOrder" />
<suppress files=".*" checks="MultipleVariableDeclarations" />
<suppress files=".*" checks="MutableException" />
<suppress files=".*" checks="NeedBraces" />
<suppress files=".*" checks="NestedIfDepth" />
<suppress files=".*" checks="NewlineAtEndOfFile" />
<suppress files=".*" checks="NonEmptyAtclauseDescription" />
<suppress files=".*" checks="NoWhitespaceBefore" />
<suppress files=".*" checks="OneTopLevelClass" />
<suppress files=".*" checks="ParenPad" />
<suppress files=".*" checks="RedundantImport" />
<suppress files=".*" checks="RegexpSinglelineJava" />
<suppress files=".*" checks="RequireThis" />
<suppress files=".*" checks="SimplifyBooleanExpression" />
<suppress files=".*" checks="SimplifyBooleanReturn" />
<suppress files=".*" checks="SpringAvoidStaticImport" />
<suppress files=".*" checks="SpringCatch" />
<suppress files=".*" checks="SpringHeader" />
<suppress files=".*" checks="SpringHideUtilityClassConstructor" />
<suppress files=".*" checks="SpringImportOrder" />
<suppress files=".*" checks="SpringJavadoc" />
<suppress files=".*" checks="SpringLambda" />
<suppress files=".*" checks="SpringMethodOrder" />
<suppress files=".*" checks="SpringMethodVisibility" />
<suppress files=".*" checks="SpringTernary" />
<suppress files=".*" checks="WhitespaceAfter" />
<suppress files=".*" checks="WhitespaceAround" />
</suppressions>
56 changes: 8 additions & 48 deletions etc/checkstyle/checkstyle.xml
Original file line number Diff line number Diff line change
@@ -1,51 +1,11 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"https://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
<!-- Suppressions -->
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="com.puppycrawl.tools.checkstyle.Checker">
<module name="SuppressionFilter">
<property name="file" value="${config_loc}/suppressions.xml"/>
<property name="file"
value="${config_loc}/checkstyle-suppressions.xml" />
</module>

<!-- Root Checks -->
<module name="RegexpHeader">
<property name="headerFile" value="${config_loc}/header.txt"/>
<property name="fileExtensions" value="java"/>
</module>

<!-- Root Checks -->
<module name="TreeWalker">
<!-- Annotations -->
<module name="MissingOverrideCheck" />

<!-- Coding -->
<module name="EmptyStatementCheck" />
<module name="RedundantModifier" />

<!-- Imports -->
<module name="UnusedImportsCheck">
<property name="processJavadoc" value="true" />
</module>

<!-- Regexp -->
<module name="RegexpSinglelineJava">
<property name="format" value="^\t* +\t*\S"/>
<property name="message" value="Line has leading space characters; indentation should be performed with tabs only."/>
<property name="ignoreComments" value="true"/>
</module>
<module name="RegexpSinglelineJava">
<property name="maximum" value="0"/>
<property name="format" value="org\.junit\.Assert\.assert"/>
<property name="message" value="Please use AssertJ imports."/>
<property name="ignoreComments" value="true"/>
</module>
<module name="Regexp">
<property name="format" value="[ \t]+$"/>
<property name="illegalPattern" value="true"/>
<property name="message" value="Trailing whitespace"/>
</module>

<!-- Whitespace -->
<module name="WhitespaceAfterCheck" />
</module>
</module>
<module name="io.spring.javaformat.checkstyle.SpringChecks" />
</module>
16 changes: 0 additions & 16 deletions etc/checkstyle/header.txt

This file was deleted.

19 changes: 0 additions & 19 deletions etc/checkstyle/suppressions.xml

This file was deleted.

0 comments on commit aea0fea

Please sign in to comment.