Skip to content

Commit d3729ca

Browse files
grgrzybekgrgrzybek
committed
[build] Add checkstyle configuration
1 parent 2cd4a66 commit d3729ca

File tree

5 files changed

+255
-50
lines changed

5 files changed

+255
-50
lines changed

‎maven/osgi-report-maven-plugin/src/it/osgi-report-activator/pom.xml

-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@
6161
<groupId>org.ops4j.tools.maven</groupId>
6262
<artifactId>osgi-report-maven-plugin</artifactId>
6363
<version>0.1.0-SNAPSHOT</version>
64-
<extensions>true</extensions>
6564
<executions>
6665
<execution>
6766
<id>default-manifest-summary</id>

‎maven/osgi-report-maven-plugin/src/it/osgi-report-multi-simple/pom.xml

-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@
4646
<groupId>org.ops4j.tools.maven</groupId>
4747
<artifactId>osgi-report-maven-plugin</artifactId>
4848
<version>0.1.0-SNAPSHOT</version>
49-
<extensions>true</extensions>
5049
<executions>
5150
<execution>
5251
<id>default-manifest-summary</id>

‎ops4j-tools-checks.xml

+209
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,209 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
4+
Licensed to the Apache Software Foundation (ASF) under one
5+
or more contributor license agreements. See the NOTICE file
6+
distributed with this work for additional information
7+
regarding copyright ownership. The ASF licenses this file
8+
to you under the Apache License, Version 2.0 (the
9+
"License"); you may not use this file except in compliance
10+
with the License. You may obtain a copy of the License at
11+
12+
http://www.apache.org/licenses/LICENSE-2.0
13+
14+
Unless required by applicable law or agreed to in writing,
15+
software distributed under the License is distributed on an
16+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17+
KIND, either express or implied. See the License for the
18+
specific language governing permissions and limitations
19+
under the License.
20+
21+
-->
22+
<!DOCTYPE module PUBLIC
23+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
24+
"http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd">
25+
26+
<!--
27+
Checkstyle configuration that checks the Pax Web coding conventions.
28+
-->
29+
30+
<module name="Checker">
31+
32+
<!-- We want yellow markers in Eclipse by default, not red ones. -->
33+
<property name="severity" value="warning" />
34+
35+
<property name="fileExtensions" value="java, properties, xml" />
36+
37+
<!-- Checks whether files end with a new line. -->
38+
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
39+
<!-- module name="NewlineAtEndOfFile"/ -->
40+
41+
<!-- Checks for Size Violations. -->
42+
<!-- See http://checkstyle.sf.net/config_sizes.html -->
43+
<module name="FileLength">
44+
<property name="max" value="3500" />
45+
<property name="fileExtensions" value="java" />
46+
</module>
47+
48+
<!-- Checks for whitespace -->
49+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
50+
<!--<module name="FileTabCharacter">-->
51+
<!--<property name="fileExtensions" value="java" />-->
52+
<!--</module>-->
53+
54+
<module name="TreeWalker">
55+
56+
<property name="cacheFile" value="${checkstyle.cache.file}" />
57+
58+
<!-- Checks for Javadoc comments. -->
59+
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
60+
<!-- module name="JavadocMethod"/ -->
61+
<!-- module name="JavadocType"/ -->
62+
<!-- module name="JavadocVariable"/ -->
63+
64+
65+
<!-- Checks for Naming Conventions. -->
66+
<!-- See http://checkstyle.sf.net/config_naming.html -->
67+
<module name="MemberName"/>
68+
<module name="ConstantName"/>
69+
<module name="LocalVariableName" />
70+
<module name="MethodName" />
71+
<module name="PackageName" />
72+
<module name="LocalFinalVariableName" />
73+
<module name="StaticVariableName" />
74+
75+
<!-- allow leading underscore on parameters to avoid variable hiding -->
76+
<module name="ParameterName">
77+
<property name="format" value="^_?[a-z][a-zA-Z0-9]*$" />
78+
</module>
79+
80+
<!-- Allow an optional prefix of "_24" or "_24t" -->
81+
<module name="TypeName">
82+
<property name="format" value="^(((_24(t)?)?[A-Z][A-Za-z0-9]*))$" />
83+
</module>
84+
85+
<!-- Checks for imports -->
86+
<!-- See http://checkstyle.sf.net/config_import.html -->
87+
<module name="AvoidStarImport" />
88+
<module name="IllegalImport" />
89+
<module name="RedundantImport" />
90+
<module name="UnusedImports">
91+
<property name="processJavadoc" value="true" />
92+
</module>
93+
94+
<!-- Disabled, not compatible with Eclipse formatter -->
95+
<!-- <module name="LineLength"> <property name="max" value="100" /> <property
96+
name="ignorePattern" value="@version|@see|http://"/> </module> -->
97+
98+
99+
<!-- Disabled, not compatible with Eclipse formatter -->
100+
<!-- <module name="Indentation"> <property name="caseIndent" value="0"/> </module> -->
101+
102+
103+
<module name="MethodLength">
104+
<property name="max" value="200" />
105+
</module>
106+
<module name="ParameterNumber">
107+
<property name="max" value="10" />
108+
</module>
109+
110+
111+
<!-- Checks for blocks. You know, those {}'s -->
112+
<!-- See http://checkstyle.sf.net/config_blocks.html -->
113+
<!-- module name="EmptyBlock"/ -->
114+
<module name="NeedBraces" />
115+
<module name="LeftCurly">
116+
<property name="option" value="eol" />
117+
</module>
118+
<module name="RightCurly" />
119+
120+
<!-- Checks for common coding problems -->
121+
<!-- See http://checkstyle.sf.net/config_coding.html -->
122+
<module name="EmptyStatement" />
123+
<module name="EqualsHashCode" />
124+
<module name="InnerAssignment"/>
125+
<module name="DefaultComesLast" />
126+
<module name="MissingSwitchDefault" />
127+
<module name="FallThrough" />
128+
<module name="MultipleVariableDeclarations" />
129+
130+
<!-- Checks for class design -->
131+
<!-- See http://checkstyle.sf.net/config_design.html -->
132+
<!-- module name="DesignForExtension"/ -->
133+
<module
134+
name="com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck">
135+
<property name="severity" value="ignore" />
136+
</module>
137+
138+
<!-- module name="FinalClass"/ -->
139+
<module name="InterfaceIsType"/>
140+
141+
<!-- allow public members fooRule for JUnit rules -->
142+
<module name="VisibilityModifier">
143+
<property name="packageAllowed" value="true" />
144+
<property name="protectedAllowed" value="true" />
145+
<property name="publicMemberPattern" value="^serialVersionUID|.*Rule$" />
146+
<property name="severity" value="warning" />
147+
</module>
148+
149+
150+
<!-- Miscellaneous other checks. -->
151+
<!-- See http://checkstyle.sf.net/config_misc.html -->
152+
<!-- module name="ArrayTypeStyle"/ -->
153+
<!-- module name="FinalParameters"/ -->
154+
<!-- Line with Trailing Spaces (disabled as it's to noisy) <module name="GenericIllegalRegexp">
155+
<property name="format" value="\s+$"/> <property name="message" value="Line has trailing
156+
spaces."/> </module> -->
157+
<module name="UpperEll" />
158+
159+
<module name="WhitespaceAround">
160+
<property name="tokens" value="" />
161+
</module>
162+
<module name="StringLiteralEquality" />
163+
<module name="NoFinalizer" />
164+
<module name="MissingOverride" />
165+
<module name="HideUtilityClassConstructor" />
166+
<!-- module name="EqualsAvoidNull"/ -->
167+
<module name="ModifiedControlVariable" />
168+
<module name="DeclarationOrder" />
169+
<!--module name="MultipleStringLiterals"/ -->
170+
<module name="OneStatementPerLine" />
171+
<module name="ExplicitInitialization" />
172+
<module name="ModifierOrder" />
173+
<module name="RedundantModifier" />
174+
175+
<module name="HiddenField">
176+
<property name="ignoreConstructorParameter" value="true" />
177+
<property name="ignoreSetter" value="true" />
178+
</module>
179+
180+
181+
<module name="IllegalCatch" />
182+
<module name="IllegalInstantiation" />
183+
<module name="IllegalThrows" />
184+
<module name="MultipleVariableDeclarations" />
185+
<module name="PackageDeclaration" />
186+
<module name="ParameterAssignment" />
187+
<module name="SimplifyBooleanExpression" />
188+
<module name="SimplifyBooleanReturn" />
189+
190+
<module name="NestedIfDepth">
191+
<property name="max" value="3" />
192+
</module>
193+
194+
<module name="NestedTryDepth" />
195+
<module name="SuperClone" />
196+
<module name="SuperFinalize" />
197+
198+
<!-- allow usage of CHECKSTYLE:OFF and CHECKSTYLE:ON -->
199+
<module name="SuppressionCommentFilter" />
200+
201+
<module name="SuppressWithNearbyCommentFilter">
202+
<property name="commentFormat" value="CHECKSTYLE:SKIP" />
203+
<property name="checkFormat" value=".*" />
204+
<property name="influenceFormat" value="1" />
205+
</module>
206+
207+
</module>
208+
209+
</module>

‎pom.xml

+41-47
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@
8484
<!-- versions of Maven plugins -->
8585

8686
<!-- Plugins from org.apache.maven.plugins -->
87-
<!--<version.plugin.maven-checkstyle-plugin>3.0.0</version.plugin.maven-checkstyle-plugin>-->
88-
<!--<version.com.puppycrawl.tools.checkstyle>8.9</version.com.puppycrawl.tools.checkstyle>-->
87+
<version.plugin.maven-checkstyle-plugin>3.0.0</version.plugin.maven-checkstyle-plugin>
88+
<version.com.puppycrawl.tools.checkstyle>8.17</version.com.puppycrawl.tools.checkstyle>
8989
<version.plugin.maven-clean-plugin>3.1.0</version.plugin.maven-clean-plugin>
9090
<version.plugin.maven-checkstyle-plugin>3.0.0</version.plugin.maven-checkstyle-plugin>
9191
<version.plugin.maven-compiler-plugin>3.8.0</version.plugin.maven-compiler-plugin>
@@ -330,51 +330,45 @@
330330
</build>
331331

332332
<profiles>
333-
<!--&lt;!&ndash; Checkstyle: `mvn -Pcs validate` &ndash;&gt;-->
334-
<!--<profile>-->
335-
<!--<id>cs</id>-->
336-
<!--<build>-->
337-
<!--<plugins>-->
338-
<!--<plugin>-->
339-
<!--<groupId>org.apache.maven.plugins</groupId>-->
340-
<!--<artifactId>maven-checkstyle-plugin</artifactId>-->
341-
<!--<executions>-->
342-
<!--<execution>-->
343-
<!--<id>verify-style</id>-->
344-
<!--<phase>validate</phase>-->
345-
<!--<goals>-->
346-
<!--<goal>check</goal>-->
347-
<!--</goals>-->
348-
<!--<configuration>-->
349-
<!--<configLocation>checkstyle/pax-jms-checks.xml</configLocation>-->
350-
<!--<suppressionsLocation>checkstyle/pax-jms-checks-suppressions.xml</suppressionsLocation>-->
351-
<!--<includes>org/ops4j/pax/jms/**/*.java</includes>-->
352-
<!--<encoding>UTF-8</encoding>-->
353-
<!--<consoleOutput>true</consoleOutput>-->
354-
<!--<failsOnError>true</failsOnError>-->
355-
<!--<failOnViolation>true</failOnViolation>-->
356-
<!--<logViolationsToConsole>true</logViolationsToConsole>-->
357-
<!--<includeTestSourceDirectory>true</includeTestSourceDirectory>-->
358-
<!--<violationSeverity>warning</violationSeverity>-->
359-
<!--</configuration>-->
360-
<!--</execution>-->
361-
<!--</executions>-->
362-
<!--<dependencies>-->
363-
<!--<dependency>-->
364-
<!--<groupId>com.puppycrawl.tools</groupId>-->
365-
<!--<artifactId>checkstyle</artifactId>-->
366-
<!--<version>${version.com.puppycrawl.tools.checkstyle}</version>-->
367-
<!--</dependency>-->
368-
<!--<dependency>-->
369-
<!--<groupId>org.ops4j.pax.jms</groupId>-->
370-
<!--<artifactId>pax-jms-checkstyle-rules</artifactId>-->
371-
<!--<version>${project.version}</version>-->
372-
<!--</dependency>-->
373-
<!--</dependencies>-->
374-
<!--</plugin>-->
375-
<!--</plugins>-->
376-
<!--</build>-->
377-
<!--</profile>-->
333+
<!-- Checkstyle: `mvn -Pcs validate` -->
334+
<profile>
335+
<id>cs</id>
336+
<build>
337+
<plugins>
338+
<plugin>
339+
<groupId>org.apache.maven.plugins</groupId>
340+
<artifactId>maven-checkstyle-plugin</artifactId>
341+
<executions>
342+
<execution>
343+
<id>verify-style</id>
344+
<phase>validate</phase>
345+
<goals>
346+
<goal>check</goal>
347+
</goals>
348+
<configuration>
349+
<configLocation>ops4j-tools-checks.xml</configLocation>
350+
<includes>org/ops4j/tools/**/*.java</includes>
351+
<encoding>UTF-8</encoding>
352+
<consoleOutput>true</consoleOutput>
353+
<failsOnError>true</failsOnError>
354+
<failOnViolation>true</failOnViolation>
355+
<logViolationsToConsole>true</logViolationsToConsole>
356+
<includeTestSourceDirectory>true</includeTestSourceDirectory>
357+
<violationSeverity>warning</violationSeverity>
358+
</configuration>
359+
</execution>
360+
</executions>
361+
<dependencies>
362+
<dependency>
363+
<groupId>com.puppycrawl.tools</groupId>
364+
<artifactId>checkstyle</artifactId>
365+
<version>${version.com.puppycrawl.tools.checkstyle}</version>
366+
</dependency>
367+
</dependencies>
368+
</plugin>
369+
</plugins>
370+
</build>
371+
</profile>
378372

379373
<!-- License generation: `mvn -Plicense process-sources` -->
380374
<profile>

‎readme.adoc

+5-1
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@ Here are some typical maven invocations
99

1010
.Generate licenese headers in source files
1111

12-
mvn -Plicense process-sources
12+
mvn -Plicense process-sources -Pit-maven-projects -Denforcer.skip
1313

1414
.Build project
1515

1616
mvn clean install
17+
18+
.Perform checkstyle
19+
20+
mvn -Pcs validate -Pit-maven-projects -Denforcer.skip

0 commit comments

Comments
 (0)