Author: ssievers
Date: Tue Feb 21 21:46:33 2012
New Revision: 1292048
URL: http://svn.apache.org/viewvc?rev=1292048&view=rev
Log:
SHINDIG-1710 | Enable CheckStyle plugin during maven build
Modified:
shindig/trunk/etc/checkstyle/checkstyle.xml
shindig/trunk/etc/checkstyle/java.header
shindig/trunk/pom.xml
Modified: shindig/trunk/etc/checkstyle/checkstyle.xml
URL:
http://svn.apache.org/viewvc/shindig/trunk/etc/checkstyle/checkstyle.xml?rev=1292048&r1=1292047&r2=1292048&view=diff
==============================================================================
--- shindig/trunk/etc/checkstyle/checkstyle.xml (original)
+++ shindig/trunk/etc/checkstyle/checkstyle.xml Tue Feb 21 21:46:33 2012
@@ -52,14 +52,11 @@ under the License.
<module name="Checker">
- <module name="LineLength">
- <property name="max" value="100"/>
- </module>
-
<!-- Checks that a package.html file exists for each package. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
- <module name="PackageHtml">
+ <module name="JavadocPackage">
<property name="severity" value="warning"/>
+ <property name="allowLegacy" value="true" />
</module>
<!-- Checks whether files end with a new line. -->
@@ -73,36 +70,52 @@ under the License.
<module name="Translation"/>
<module name="StrictDuplicateCode">
- <property name="charset" value="UTF-8"/>
<property name="min" value="30"/>
</module>
+ <!-- Defaults to 2000 lines -->
+ <module name="FileLength">
+ <property name="severity" value="warning"/>
+ </module>
+
+ <module name="FileTabCharacter" />
+
+ <!-- Following interprets the header file as regular expressions. -->
+ <module name="Header">
+ <property name="headerFile" value="${checkstyle.header.file}" />
+ </module>
<module name="TreeWalker">
<property name="cacheFile" value="${checkstyle.cache.file}"/>
- <!-- Checks for Javadoc comments. -->
- <!-- See http://checkstyle.sf.net/config_javadoc.html -->
- <module name="JavadocMethod" >
- <property name="severity" value="info"/>
- </module>
+ <!-- Checks for Javadoc comments. We try to limit the scope to
protected and public only. -->
+ <!-- See http://checkstyle.sf.net/config_javadoc.html
-->
+ <!-- See http://checkstyle.sf.net/property_types.html#scope
-->
<module name="JavadocType">
- <property name="severity" value="info"/>
- </module>
+ <property name="severity" value="info"/>
+ </module>
+ <module name="JavadocMethod" >
+ <property name="severity" value="info"/>
+ <property name="scope" value="protected"/>
+ <!-- If Javadoc is missing on getters and setters, ignore it -->
+ <property name="allowMissingPropertyJavadoc" value="true"/>
+ </module>
<module name="JavadocVariable">
- <property name="severity" value="info"/>
- </module>
+ <property name="severity" value="info"/>
+ <property name="scope" value="protected"/>
+ </module>
<module name="JavadocStyle">
- <property name="severity" value="info"/>
- </module>
+ <property name="severity" value="info"/>
+ <property name="scope" value="protected"/>
+ </module>
<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
<module name="ConstantName">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="LocalFinalVariableName" />
<module name="LocalVariableName"/>
<module name="MemberName"/>
@@ -112,27 +125,20 @@ under the License.
<module name="StaticVariableName"/>
<module name="TypeName"/>
- <!-- Following interprets the header file as regular expressions. -->
- <!-- <module name="RegexpHeader"/> -->
-
-
<!-- Checks for imports -->
<!-- See http://checkstyle.sf.net/config_import.html -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport" >
- <property name="severity" value="warning"/>
+ <property name="severity" value="warning"/>
</module>
<module name="UnusedImports">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
- <module name="FileLength">
- <property name="severity" value="warning"/>
- </module>
<module name="LineLength" >
<property name="max" value="100"/>
</module>
@@ -142,60 +148,61 @@ under the License.
<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
+ <module name="GenericWhitespace"/>
<module name="EmptyForIteratorPad">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="MethodParamPad">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="NoWhitespaceAfter">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="NoWhitespaceBefore">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="OperatorWrap">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="ParenPad">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="TypecastParenPad">
- <property name="severity" value="warning"/>
- </module>
- <module name="TabCharacter"/>
+ <property name="severity" value="warning"/>
+ </module>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround">
- <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR,
BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL,
GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO,
LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN,
MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST,
SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND"/>
+ <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR,
BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL,
GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO,
LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN,
MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST,
SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND"/>
</module>
<!-- Modifier Checks -->
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
<module name="ModifierOrder">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="RedundantModifier"/>
<!-- Checks for blocks. You know, those {}'s -->
<!-- See http://checkstyle.sf.net/config_blocks.html -->
<module name="AvoidNestedBlocks">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="EmptyBlock">
- <property name="severity" value="warning"/>
- </module>
- <module name="LeftCurly"/>
+ <property name="severity" value="warning"/>
+ </module>
+ <module name="LeftCurly">
+ <property name="maxLineLength" value="100"/>
+ </module>
<module name="NeedBraces"/>
<module name="RightCurly"/>
-
<!-- Checks for common coding problems -->
<!-- See http://checkstyle.sf.net/config_coding.html -->
<module name="AvoidInlineConditionals">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="DoubleCheckedLocking"/> <!-- MY FAVOURITE -->
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
@@ -214,12 +221,12 @@ under the License.
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType">
- <property name="severity" value="warning"/>
- </module>
+ <property name="severity" value="warning"/>
+ </module>
<module name="VisibilityModifier"/>
-
-
+ <!-- Checks code complexity metrics -->
+ <!-- See http://checkstyle.sf.net/config_metrics.html -->
<module name="ClassFanOutComplexity">
<property name="max" value="10"/>
<property name="severity" value="warning"/>
@@ -237,27 +244,27 @@ under the License.
<module name="NPathComplexity" >
<property name="severity" value="warning"/>
</module>
-
<module name="JavaNCSS">
<property name="severity" value="warning"/>
</module>
-
+
<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle.sf.net/config_misc.html -->
<module name="ArrayTypeStyle"/>
- <!--
+ <!--
<module name="FinalParameters"/>
-->
- <module name="GenericIllegalRegexp">
- <property name="format" value="\s+$"/>
+ <module name="Regexp">
+ <property name="format" value="[ \t]+$"/>
+ <property name="illegalPattern" value="true"/>
<property name="message" value="Line has trailing spaces."/>
</module>
-<!--
+ <!-- There are other Jenkins addons to count TODOs and we can make use
of those
<module name="TodoComment">
<property name="severity" value="info"/>
</module>
--->
-
+ -->
+
<module name="UpperEll"/>
</module>
Modified: shindig/trunk/etc/checkstyle/java.header
URL:
http://svn.apache.org/viewvc/shindig/trunk/etc/checkstyle/java.header?rev=1292048&r1=1292047&r2=1292048&view=diff
==============================================================================
--- shindig/trunk/etc/checkstyle/java.header (original)
+++ shindig/trunk/etc/checkstyle/java.header Tue Feb 21 21:46:33 2012
@@ -1,17 +1,18 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
+ * or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
+ * 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
+ * with the License. You may obtain a copy of the License at
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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.
- */
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
\ No newline at end of file
Modified: shindig/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/shindig/trunk/pom.xml?rev=1292048&r1=1292047&r2=1292048&view=diff
==============================================================================
--- shindig/trunk/pom.xml (original)
+++ shindig/trunk/pom.xml Tue Feb 21 21:46:33 2012
@@ -647,25 +647,32 @@
<groupId>org.apache.rat</groupId>
<artifactId>apache-rat-plugin</artifactId>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.8</version>
+ <configuration>
+ <configLocation>etc/checkstyle/checkstyle.xml</configLocation>
+ <headerLocation>etc/checkstyle/java.header</headerLocation>
+ <encoding>${project.build.sourceEncoding}</encoding>
+ </configuration>
+ </plugin>
</plugins>
</build>
<reporting>
<!-- ordered alphabetically by owner -->
<plugins>
- <!--
- TODO(lindner): re-add once maven-site plugin works with checkstyle
again..
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
- <version>2.5</version>
+ <version>2.8</version>
<configuration>
-
<configLocation>http://svn.apache.org/repos/asf/shindig/trunk/etc/checkstyle/checkstyle.xml</configLocation>
-
<headerLocation>http://svn.apache.org/repos/asf/shindig/trunk/etc/checkstyle/java.header</headerLocation>
+ <configLocation>etc/checkstyle/checkstyle.xml</configLocation>
+ <headerLocation>etc/checkstyle/java.header</headerLocation>
<encoding>${project.build.sourceEncoding}</encoding>
</configuration>
</plugin>
- -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
@@ -1095,7 +1102,7 @@
<requireJavaVersion>
<version>[1.5,)</version>
</requireJavaVersion>
- </rules>
+ </rules>
</configuration>
</plugin>
<plugin>
@@ -1562,11 +1569,11 @@
<scope>test</scope>
</dependency>
- <dependency>
- <groupId>com.google.inject</groupId>
- <artifactId>guice</artifactId>
+ <dependency>
+ <groupId>com.google.inject</groupId>
+ <artifactId>guice</artifactId>
<version>3.0</version>
- </dependency>
+ </dependency>
<dependency>
<groupId>com.google.inject.extensions</groupId>
@@ -1753,7 +1760,7 @@
<version>2.2.4</version>
<exclusions>
<exclusion>
- <groupId>de.odysseus.juel</groupId>
+ <groupId>de.odysseus.juel</groupId>
<artifactId>juel-api</artifactId>
</exclusion>
</exclusions>
