Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update checkstyle configuration. 

Configuration has been added based on commons-lang.

The Apache licence header has been added to the checkstyle config.
This commit is contained in:
Alex Herbert 2020-02-18 21:38:53 +00:00
parent 6ad69bedd3
commit 72f45156d3
3 changed files with 82 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
pom.xml
View File

@ -532,7 +532,8 @@
<commons.jira.pid>12310465</commons.jira.pid> <commons.jira.pid>12310465</commons.jira.pid>
<!-- The RC version used in the staging repository URL. --> <!-- The RC version used in the staging repository URL. -->
<commons.rc.version>RC1</commons.rc.version> <commons.rc.version>RC1</commons.rc.version>
<checkstyle.version>3.0.0</checkstyle.version> <checkstyle.version>3.1.0</checkstyle.version>
<checkstyle.dep.version>8.29</checkstyle.dep.version>
<commons.site.path>collections</commons.site.path> <commons.site.path>collections</commons.site.path>
<commons.scmPubUrl>https://svn.apache.org/repos/infra/websites/production/commons/content/proper/commons-collections</commons.scmPubUrl> <commons.scmPubUrl>https://svn.apache.org/repos/infra/websites/production/commons/content/proper/commons-collections</commons.scmPubUrl>
@ -592,10 +593,18 @@
<plugin> <plugin>
<artifactId>maven-checkstyle-plugin</artifactId> <artifactId>maven-checkstyle-plugin</artifactId>
<version>${checkstyle.version}</version> <version>${checkstyle.version}</version>
<dependencies>
<dependency>
<groupId>com.puppycrawl.tools</groupId>
<artifactId>checkstyle</artifactId>
<version>${checkstyle.dep.version}</version>
</dependency>
</dependencies>
<configuration> <configuration>
<configLocation>${basedir}/src/conf/checkstyle.xml</configLocation> <configLocation>${basedir}/src/conf/checkstyle.xml</configLocation>
<enableRulesSummary>false</enableRulesSummary> <headerLocation>${basedir}/src/conf/license-header.txt</headerLocation>
<suppressionsLocation>${basedir}/src/conf/checkstyle-suppressions.xml</suppressionsLocation> <suppressionsLocation>${basedir}/src/conf/checkstyle-suppressions.xml</suppressionsLocation>
<enableRulesSummary>false</enableRulesSummary>
</configuration> </configuration>
</plugin> </plugin>
<plugin> <plugin>

132
src/conf/checkstyle.xml
View File

@ -1,85 +1,63 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor <!--
license agreements. See the NOTICE file distributed with this work for additional Licensed to the Apache Software Foundation (ASF) under one or more
information regarding copyright ownership. The ASF licenses this file to contributor license agreements. See the NOTICE file distributed with
You under the Apache License, Version 2.0 (the "License"); you may not use this work for additional information regarding copyright ownership.
this file except in compliance with the License. You may obtain a copy of The ASF licenses this file to You under the Apache License, Version 2.0
the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required (the "License"); you may not use this file except in compliance with
by applicable law or agreed to in writing, software distributed under the the License. You may obtain a copy of the License at
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 http://www.apache.org/licenses/LICENSE-2.0
language governing permissions and limitations under the License. -->
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 <!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.1//EN" "-//Puppy Crawl//DTD Check Configuration 1.1//EN"
"http://www.puppycrawl.com/dtds/configuration_1_1.dtd"> "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">
<!-- commons lang customization of default Checkstyle behavior --> <!-- Apache Commons Lang customization of default Checkstyle behavior -->
<module name="Checker"> <module name="Checker">
<property name="localeLanguage" value="en" /> <property name="localeLanguage" value="en"/>
<property name="severity" value="warning" /> <module name="JavadocPackage"/>
<module name="NewlineAtEndOfFile">
<module name="SuppressionFilter"> <property name="lineSeparator" value="lf" />
<property name="file" value="${checkstyle.suppressions.file}"/> </module>
</module> <module name="FileTabCharacter">
<property name="fileExtensions" value="java,xml"/>
<module name="JavadocPackage"> </module>
<property name="allowLegacy" value="true" /> <module name="RegexpSingleline">
</module> <!-- \s matches whitespace character, $ matches end of line. -->
<property name="format" value="\s+$"/>
<!-- No tabs allowed! --> <property name="message" value="Line has trailing spaces."/>
<module name="FileTabCharacter" /> </module>
<module name="SuppressionFilter">
<!-- Require files to end with newline characters --> <property name="file" value="${checkstyle.suppressions.file}"/>
<module name="NewlineAtEndOfFile"/> </module>
<module name="Header">
<module name="TreeWalker"> <property name="headerFile" value="${checkstyle.header.file}"/>
<module name="AvoidStarImport" /> </module>
<module name="RedundantImport" /> <module name="TreeWalker">
<module name="UnusedImports" /> <module name="AvoidStarImport"/>
<module name="NeedBraces" /> <module name="IllegalImport"/>
<module name="LineLength"> <module name="RedundantImport"/>
<property name="max" value="120" /> <module name="UnusedImports"/>
</module> <module name="NeedBraces"/>
<module name="JavadocMethod">
<!-- Must have class / interface header comments including scm version --> <property name="scope" value="public" />
<!-- Disable by now as it also enforces generic type parameters in type javadoc --> </module>
<!-- <module name="JavadocType"> --> <module name="ModifierOrder"/>
<!-- <property name="versionFormat" value="\$Id.*\$"/> --> <module name="RedundantModifier"/>
<!-- </module> --> <module name="UpperEll" />
<module name="LeftCurly"/>
<!-- Require method javadocs, allow undeclared RTE --> <module name="NeedBraces"/>
<module name="JavadocMethod"> <module name="RightCurly"/>
<property name="allowUndeclaredRTE" value="true" /> <module name="GenericWhitespace"/>
<property name="allowMissingJavadoc" value="true" /> <module name="WhitespaceAfter"/>
<property name="scope" value="protected" /> <module name="NoWhitespaceBefore"/>
</module> </module>
<!-- Require hash code override when equals is -->
<module name="EqualsHashCode" />
<!-- Switch statements should be complete and with independent cases -->
<module name="FallThrough" />
<module name="MissingSwitchDefault" />
<!-- Constant names should obey the traditional all uppercase naming convention -->
<module name="ConstantName" />
<!-- No trailing whitespace -->
<module name="Regexp">
<property name="format" value="[ \t]+$"/>
<property name="illegalPattern" value="true"/>
<property name="message" value="Trailing whitespace"/>
</module>
<!-- Authors should be in pom.xml file -->
<module name="Regexp">
<property name="format" value="@author"/>
<property name="illegalPattern" value="true"/>
<property name="message" value="developers names should be in pom file"/>
</module>
</module>
</module> </module>

16
src/conf/license-header.txt Normal file
View File

@ -0,0 +1,16 @@
/*
* 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.
*/