Skip to content

Commit 419a7a1

Browse files
jonathanaustinjonathanaustin
committed
Added a new checkstyle config file bt-checkstyle-format-only.xml for projects that only want to check basic code formatting
1 parent 1d8985b commit 419a7a1

File tree

2 files changed

+127
-0
lines changed

2 files changed

+127
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
* Changed tab indention check to no longer allow any violations by removing the maximum property which was set to 10
99
* Changed JavadocPackage check to warning
1010
* Changed EmptyForIteratorPad check to warning as IntelliJ code formatting does not currently allow for this
11+
* Added a new checkstyle config file bt-checkstyle-format-only.xml for projects that only want to check basic code formatting.
1112

1213
## 1.0.19
1314
* Added bt.qa.fail property as a convenience property to allow projects to fail builds or only report QA violations. #84

‎build-tools/src/main/resources/bordertech/bt-checkstyle-format-only.xml‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
4+
"https://checkstyle.org/dtds/configuration_1_3.dtd">
5+
6+
<!-- This checkstyle file is setup just for code format rules. It has been extracted from the code style rules from bt-checkstyle. -->
7+
8+
<module name="Checker">
9+
10+
<property name="severity" value="error"/>
11+
12+
<!-- BorderTech: Override for how many spaces a tab takes from 8 to 4 when Checkstyle prints messages. -->
13+
<property name="tabWidth" value="4"/>
14+
15+
<!-- BorderTech: Filter out Checkstyle warnings that have been suppressed with the @SuppressWarnings annotation. -->
16+
<!-- SuppressWarningsFilter and SuppressWarningsHolder have to be used together. -->
17+
<module name="SuppressWarningsFilter"/>
18+
19+
<!-- BorderTech: only check java files
20+
<property name="fileExtensions" value="java, properties, xml"/>
21+
-->
22+
<property name="fileExtensions" value="java"/>
23+
24+
<!-- Excludes all 'module-info.java' files -->
25+
<!-- See https://checkstyle.org/config_filefilters.html -->
26+
<module name="BeforeExecutionExclusionFileFilter">
27+
<property name="fileNamePattern" value="module\-info\.java$"/>
28+
</module>
29+
30+
<!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
31+
<module name="SuppressionFilter">
32+
<property name="file" value="${org.checkstyle.sun.suppressionfilter.config}"
33+
default="checkstyle-suppressions.xml"/>
34+
<property name="optional" value="true"/>
35+
</module>
36+
37+
<!-- Checks whether files end with a new line. -->
38+
<!-- See https://checkstyle.org/config_misc.html#NewlineAtEndOfFile -->
39+
<module name="NewlineAtEndOfFile"/>
40+
41+
<!-- Checks for Size Violations. -->
42+
<!-- See https://checkstyle.org/config_sizes.html -->
43+
<module name="FileLength">
44+
<!-- BorderTech: Override to warning -->
45+
<property name="severity" value="warning"/>
46+
</module>
47+
<module name="LineLength">
48+
<property name="fileExtensions" value="java"/>
49+
<!-- BorderTech: Override from 80 to 150 -->
50+
<property name="max" value="150"/>
51+
<!-- BorderTech: Override to warning -->
52+
<property name="severity" value="warning"/>
53+
</module>
54+
55+
<!-- BorderTech: Use tabs for indenting -->
56+
<module name="RegexpSingleline">
57+
<property name="format" value="^(\t*( +\t*(?! \*|\S))|( ))"/>
58+
<property name="message" value="Indentation should be tabs."/>
59+
</module>
60+
61+
<!-- Miscellaneous other checks. -->
62+
<!-- See https://checkstyle.org/config_misc.html -->
63+
<module name="RegexpSingleline">
64+
<property name="format" value="\s+$"/>
65+
<property name="minimum" value="0"/>
66+
<property name="maximum" value="0"/>
67+
<property name="message" value="Line has trailing spaces."/>
68+
<!-- BorderTech: Override to warning -->
69+
<property name="severity" value="warning"/>
70+
</module>
71+
72+
<module name="TreeWalker">
73+
74+
<!-- BorderTech: Make the @SuppressWarnings annotations available to Checkstyle -->
75+
<!-- SuppressWarningsFilter and SuppressWarningsHolder have to be used together. -->
76+
<module name="SuppressWarningsHolder"/>
77+
78+
<!-- Checks for imports -->
79+
<!-- See https://checkstyle.org/config_imports.html -->
80+
<module name="AvoidStarImport"/>
81+
<module name="IllegalImport">
82+
<!-- BorderTech: Override to warning as focusing on formatting issues -->
83+
<property name="severity" value="warning"/>
84+
</module><!-- defaults to sun.* packages -->
85+
<module name="RedundantImport"/>
86+
<module name="UnusedImports">
87+
<!-- BorderTech: Check javadoc as well -->
88+
<property name="processJavadoc" value="true"/>
89+
</module>
90+
91+
<!-- Checks for whitespace -->
92+
<!-- See https://checkstyle.org/config_whitespace.html -->
93+
<module name="EmptyForIteratorPad">
94+
<!-- BorderTech: Override to warning as IntelliJ does not currently allow for this-->
95+
<property name="severity" value="warning"/>
96+
</module>
97+
<module name="GenericWhitespace"/>
98+
<module name="MethodParamPad"/>
99+
<module name="NoWhitespaceAfter">
100+
<!-- BorderTech: Tokens to check -->
101+
<property name="tokens" value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS"/>
102+
</module>
103+
<module name="NoWhitespaceBefore"/>
104+
<module name="OperatorWrap"/>
105+
<module name="ParenPad"/>
106+
<module name="TypecastParenPad"/>
107+
<module name="WhitespaceAfter"/>
108+
<module name="WhitespaceAround"/>
109+
110+
<!-- Checks for blocks. You know, those {}'s -->
111+
<!-- See http://checkstyle.sourceforge.net/config_blocks.html -->
112+
<module name="AvoidNestedBlocks">
113+
<!-- BorderTech: Allow a nested block in a switch -->
114+
<property name="allowInSwitchCase" value="true"/>
115+
</module>
116+
<module name="EmptyBlock">
117+
<!-- BorderTech: Override to warning -->
118+
<property name="severity" value="warning"/>
119+
</module>
120+
<module name="LeftCurly"/>
121+
<module name="NeedBraces"/>
122+
<module name="RightCurly"/>
123+
124+
</module>
125+
126+
</module>

0 commit comments

Comments
 (0)