Repository: incubator-tamaya Updated Branches: refs/heads/master 449b752ea -> 4be64f1ce
TAMAYA-53 Moved also the CheckStyle configuration to an external file. This allows us to use the same CheckStyle configuration also in our IDE. Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/4be64f1c Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/4be64f1c Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/4be64f1c Branch: refs/heads/master Commit: 4be64f1cea21bb8a65d22ca13a44c6a571dab361 Parents: 449b752 Author: Oliver B. Fischer <[email protected]> Authored: Sun Jan 18 14:16:56 2015 +0100 Committer: Oliver B. Fischer <[email protected]> Committed: Sun Jan 18 14:18:20 2015 +0100 ---------------------------------------------------------------------- .../src/main/resources/checkstyle/style.xml | 169 +++++++++++++++ java7/pom.xml | 17 ++ java8/pom.xml | 16 ++ modules/pom.xml | 17 ++ pom.xml | 206 +++---------------- 5 files changed, 251 insertions(+), 174 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4be64f1c/buildconfigurations/src/main/resources/checkstyle/style.xml ---------------------------------------------------------------------- diff --git a/buildconfigurations/src/main/resources/checkstyle/style.xml b/buildconfigurations/src/main/resources/checkstyle/style.xml new file mode 100644 index 0000000..b96b02c --- /dev/null +++ b/buildconfigurations/src/main/resources/checkstyle/style.xml @@ -0,0 +1,169 @@ +<!-- +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" + "http://www.puppycrawl.com/dtds/configuration_1_3.dtd";> +<module name="Checker"> + <module name="SuppressionCommentFilter"/> + + <!-- Checks for Size Violations. --> + <!-- See http://checkstyle.sf.net/config_sizes.html --> + <module name="FileLength"> + <property name="max" value="3500"/> + <property name="fileExtensions" value="java"/> + </module> + + <!-- Checks for whitespace --> + <!-- See http://checkstyle.sf.net/config_whitespace.html --> + <module name="FileTabCharacter"/> + + + <module name="TreeWalker"> + <!-- needed for the SuppressionCommentFilter --> + <module name="FileContentsHolder"/> + + <!-- Checks for Javadoc comments. --> + <!-- See http://checkstyle.sf.net/config_javadoc.html --> + <!-- module name="JavadocMethod"/ --> + <!-- module name="JavadocType"/ --> + <!-- module name="JavadocVariable"/ --> + + + <!-- Checks for Naming Conventions. --> + <!-- See http://checkstyle.sf.net/config_naming.html --> + <!-- + <module name="MemberName"> + <property name="format" value="^_[a-z][a-zA-Z0-9]*$" /> + </module> + --> + + <module name="ConstantName"> + <!-- Normal rules, except that: + - * any name can start with an underscore. + - * "log" is allowed; this is a traditional name for log objects + - * names ending with "ThreadLocal" are allowed so that threadlocal vars don't have to be + - all-caps. They are static final, but are not really constants. Yes, type prefixes + - on variable names sucks ("hungarian notation") but checkstyle doesn't allow + - name rules to vary by the type of the constant, and no other alternative seems + - any better. + --> + <property name="format" + value="^_?((log)|(logger)|([a-z][a-zA-Z]*ThreadLocal)|([A-Z][A-Z0-9]*(_[A-Z0-9]+)*))$"/> + </module> + + <module name="LocalVariableName"/> + <module name="MethodName"> + <property name="format" + value="^_?[a-z][a-zA-Z0-9]*$"/> + </module> + <module name="PackageName"/> + <module name="LocalFinalVariableName"/> + <module name="ParameterName"/> + <module name="StaticVariableName"/> + <module name="TypeName"> + <property name="format" + value="^_?[A-Z][a-zA-Z0-9]*$"/> + </module> + + <!-- Checks for imports --> + <!-- See http://checkstyle.sf.net/config_import.html --> + <module name="AvoidStarImport"> + <property name="excludes" + value="java.io,java.net,java.util"/> + </module> + <module name="IllegalImport"/> + <module name="RedundantImport"/> + <module name="UnusedImports"/> + + + <module name="LineLength"> + <property name="max" value="180"/> + <property name="ignorePattern" + value="@version|@see"/> + </module> + <module name="MethodLength"> + <property name="max" value="250"/> + </module> + <module name="ParameterNumber"> + <property name="max" value="10"/> + </module> + + <!-- Checks for blocks. You know, those {}'s --> + <!-- See http://checkstyle.sf.net/config_blocks.html --> + <module name="EmptyBlock"> + <property name="option" value="text"/> + </module> + + <module name="NeedBraces"/> + <module name="LeftCurly"> + <property name="option" value="EOL"/> + </module> + <module name="RightCurly"> + <property name="option" value="SAME"/> + </module> + + <!-- Checks for common coding problems --> + <!-- See http://checkstyle.sf.net/config_coding.html --> + <module name="EmptyStatement"/> + <module name="EqualsHashCode"/> + <module name="DefaultComesLast"/> + <module name="MissingSwitchDefault"/> + <module name="FallThrough"/> + <module name="MultipleVariableDeclarations"/> + + <!-- Checks for class design --> + <!-- See http://checkstyle.sf.net/config_design.html --> + <!-- module name="DesignForExtension"/ --> + <module + name="com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck"> + <property name="severity" value="ignore"/> + </module> + + <!-- module name="FinalClass"/ --> + + <module name="HideUtilityClassConstructor"/> + + <!-- module name="InterfaceIsType"/ --> + <!-- module name="VisibilityModifier"/ --> + + <module + name="com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck"> + <property name="packageAllowed" value="false"/> + <property name="protectedAllowed" value="true"/> + <property name="publicMemberPattern" + value="^serialVersionUID"/> + <property name="severity" value="warning"/> + </module> + + + <!-- Miscellaneous other checks. --> + <!-- See http://checkstyle.sf.net/config_misc.html --> + <!-- module name="ArrayTypeStyle"/ --> + <!-- module name="FinalParameters"/ --> + <!-- Line with Trailing Spaces (disabled as it's to noisy) + <module name="GenericIllegalRegexp"> + <property name="format" value="\s+$" /> + <property name="message" value="Line has trailing spaces." /> + </module> + --> + <module name="UpperEll"/> + + </module> + +</module> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4be64f1c/java7/pom.xml ---------------------------------------------------------------------- diff --git a/java7/pom.xml b/java7/pom.xml index 502cf22..d4a8c7b 100644 --- a/java7/pom.xml +++ b/java7/pom.xml @@ -47,6 +47,23 @@ under the License. <pluginManagement> <plugins> <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <configuration> + <logViolationsToConsole>true</logViolationsToConsole> + <configLocation>checkstyle/style.xml</configLocation> + </configuration> + + <dependencies> + <dependency> + <groupId>org.apache.tamaya</groupId> + <artifactId>buildconfigurations</artifactId> + <version>${project.version}</version> + </dependency> + </dependencies> + </plugin> + + <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> <configuration> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4be64f1c/java8/pom.xml ---------------------------------------------------------------------- diff --git a/java8/pom.xml b/java8/pom.xml index a338b42..849f654 100644 --- a/java8/pom.xml +++ b/java8/pom.xml @@ -71,6 +71,22 @@ under the License. </dependency> </dependencies> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <configuration> + <logViolationsToConsole>true</logViolationsToConsole> + <configLocation>checkstyle/style.xml</configLocation> + </configuration> + + <dependencies> + <dependency> + <groupId>org.apache.tamaya</groupId> + <artifactId>buildconfigurations</artifactId> + <version>${project.version}</version> + </dependency> + </dependencies> + </plugin> </plugins> </build> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4be64f1c/modules/pom.xml ---------------------------------------------------------------------- diff --git a/modules/pom.xml b/modules/pom.xml index 18345ed..cda14ad 100644 --- a/modules/pom.xml +++ b/modules/pom.xml @@ -47,6 +47,23 @@ under the License. <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <configuration> + <logViolationsToConsole>true</logViolationsToConsole> + <configLocation>checkstyle/style.xml</configLocation> + </configuration> + + <dependencies> + <dependency> + <groupId>org.apache.tamaya</groupId> + <artifactId>buildconfigurations</artifactId> + <version>${project.version}</version> + </dependency> + </dependencies> + </plugin> + + <plugin> + <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-enforcer-plugin</artifactId> <executions> <execution> http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/4be64f1c/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 1a38461..8f1f46f 100644 --- a/pom.xml +++ b/pom.xml @@ -265,6 +265,38 @@ under the License. <plugin> <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <version>2.13</version> + <executions> + <execution> + <id>verify-style</id> + <phase>process-classes</phase> + <goals> + <goal>check</goal> + </goals> + </execution> + </executions> + <configuration> + <logViolationsToConsole>true</logViolationsToConsole> + </configuration> + + <dependencies> + <dependency> + <groupId>com.puppycrawl.tools</groupId> + <artifactId>checkstyle</artifactId> + <version>6.2</version> + <exclusions><!-- MCHECKSTYLE-156 --> + <exclusion> + <groupId>com.sun</groupId> + <artifactId>tools</artifactId> + </exclusion> + </exclusions> + </dependency> + </dependencies> + </plugin> + + <plugin> + <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-toolchains-plugin</artifactId> <version>${toolchains.plugin}</version> </plugin> @@ -410,180 +442,6 @@ under the License. </plugin> <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-checkstyle-plugin</artifactId> - <version>2.13</version> - <executions> - <execution> - <id>verify-style</id> - <phase>process-classes</phase> - <goals> - <goal>check</goal> - </goals> - </execution> - </executions> - <configuration> - <logViolationsToConsole>true</logViolationsToConsole> - <checkstyleRules> - <module name="Checker"> - <module name="SuppressionCommentFilter" /> - - <!-- Checks for Size Violations. --> - <!-- See http://checkstyle.sf.net/config_sizes.html --> - <module name="FileLength"> - <property name="max" value="3500" /> - <property name="fileExtensions" value="java" /> - </module> - - <!-- Checks for whitespace --> - <!-- See http://checkstyle.sf.net/config_whitespace.html --> - <module name="FileTabCharacter" /> - - - <module name="TreeWalker"> - <!-- needed for the SuppressionCommentFilter --> - <module name="FileContentsHolder" /> - - <!-- Checks for Javadoc comments. --> - <!-- See http://checkstyle.sf.net/config_javadoc.html --> - <!-- module name="JavadocMethod"/ --> - <!-- module name="JavadocType"/ --> - <!-- module name="JavadocVariable"/ --> - - - <!-- Checks for Naming Conventions. --> - <!-- See http://checkstyle.sf.net/config_naming.html --> - <!-- - <module name="MemberName"> - <property name="format" value="^_[a-z][a-zA-Z0-9]*$" /> - </module> - --> - - <module name="ConstantName"> - <!-- Normal rules, except that: - - * any name can start with an underscore. - - * "log" is allowed; this is a traditional name for log objects - - * names ending with "ThreadLocal" are allowed so that threadlocal vars don't have to be - - all-caps. They are static final, but are not really constants. Yes, type prefixes - - on variable names sucks ("hungarian notation") but checkstyle doesn't allow - - name rules to vary by the type of the constant, and no other alternative seems - - any better. - --> - <property name="format" value="^_?((log)|(logger)|([a-z][a-zA-Z]*ThreadLocal)|([A-Z][A-Z0-9]*(_[A-Z0-9]+)*))$" /> - </module> - - <module name="LocalVariableName" /> - <module name="MethodName"> - <property name="format" value="^_?[a-z][a-zA-Z0-9]*$" /> - </module> - <module name="PackageName" /> - <module name="LocalFinalVariableName" /> - <module name="ParameterName" /> - <module name="StaticVariableName" /> - <module name="TypeName"> - <property name="format" value="^_?[A-Z][a-zA-Z0-9]*$" /> - </module> - - <!-- Checks for imports --> - <!-- See http://checkstyle.sf.net/config_import.html --> - <module name="AvoidStarImport"> - <property name="excludes" value="java.io,java.net,java.util" /> - </module> - <module name="IllegalImport" /> - <module name="RedundantImport" /> - <module name="UnusedImports" /> - - - <module name="LineLength"> - <property name="max" value="180" /> - <property name="ignorePattern" value="@version|@see" /> - </module> - <module name="MethodLength"> - <property name="max" value="250" /> - </module> - <module name="ParameterNumber"> - <property name="max" value="10" /> - </module> - - <!-- Checks for blocks. You know, those {}'s --> - <!-- See http://checkstyle.sf.net/config_blocks.html --> - <module name="EmptyBlock"> - <property name="option" value="text" /> - </module> - - <module name="NeedBraces" /> - <module name="LeftCurly"> - <property name="option" value="EOL" /> - </module> - <module name="RightCurly"> - <property name="option" value="SAME" /> - </module> - - <!-- Checks for common coding problems --> - <!-- See http://checkstyle.sf.net/config_coding.html --> - <module name="EmptyStatement" /> - <module name="EqualsHashCode" /> - <module name="DefaultComesLast" /> - <module name="MissingSwitchDefault" /> - <module name="FallThrough" /> - <module name="MultipleVariableDeclarations" /> - - <!-- Checks for class design --> - <!-- See http://checkstyle.sf.net/config_design.html --> - <!-- module name="DesignForExtension"/ --> - <module name="com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck"> - <property name="severity" value="ignore" /> - </module> - - <!-- module name="FinalClass"/ --> - - <module name="HideUtilityClassConstructor" /> - - <!-- module name="InterfaceIsType"/ --> - <!-- module name="VisibilityModifier"/ --> - - <module name="com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck"> - <property name="packageAllowed" value="false" /> - <property name="protectedAllowed" value="true" /> - <property name="publicMemberPattern" value="^serialVersionUID" /> - <property name="severity" value="warning" /> - </module> - - - <!-- Miscellaneous other checks. --> - <!-- See http://checkstyle.sf.net/config_misc.html --> - <!-- module name="ArrayTypeStyle"/ --> - <!-- module name="FinalParameters"/ --> - <!-- Line with Trailing Spaces (disabled as it's to noisy) - <module name="GenericIllegalRegexp"> - <property name="format" value="\s+$" /> - <property name="message" value="Line has trailing spaces." /> - </module> - --> - <module name="UpperEll" /> - - </module> - - </module> - </checkstyleRules> - </configuration> - - <dependencies> - <dependency> - <groupId>com.puppycrawl.tools</groupId> - <artifactId>checkstyle</artifactId> - <version>6.2</version> - <exclusions><!-- MCHECKSTYLE-156 --> - <exclusion> - <groupId>com.sun</groupId> - <artifactId>tools</artifactId> - </exclusion> - </exclusions> - </dependency> - </dependencies> - </plugin> - - <plugin> <groupId>org.apache.rat</groupId> <artifactId>apache-rat-plugin</artifactId> <version>${rat.version}</version>
