You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by cz...@apache.org on 2007/01/16 13:47:32 UTC

svn commit: r496671 - in /cocoon/trunk: ./ tools/ tools/cocoon-maven-reports/ tools/cocoon-maven-reports/src/ tools/cocoon-maven-reports/src/main/ tools/cocoon-maven-reports/src/main/resources/ tools/cocoon-maven-reports/src/main/resources/org/ tools/c...

Author: cziegeler
Date: Tue Jan 16 04:47:31 2007
New Revision: 496671

URL: http://svn.apache.org/viewvc?view=rev&rev=496671
Log:
Add support for checkstyle report generation

Added:
    cocoon/trunk/tools/cocoon-maven-reports/   (with props)
    cocoon/trunk/tools/cocoon-maven-reports/pom.xml   (with props)
    cocoon/trunk/tools/cocoon-maven-reports/src/
    cocoon/trunk/tools/cocoon-maven-reports/src/main/
    cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/
    cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/
    cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/
    cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/
    cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/
    cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/
    cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle-header.txt   (with props)
    cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle.xml   (with props)
Modified:
    cocoon/trunk/pom.xml
    cocoon/trunk/tools/pom.xml

Modified: cocoon/trunk/pom.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/pom.xml?view=diff&rev=496671&r1=496670&r2=496671
==============================================================================
--- cocoon/trunk/pom.xml (original)
+++ cocoon/trunk/pom.xml Tue Jan 16 04:47:31 2007
@@ -592,6 +592,11 @@
         <artifactId>wagon-ssh-external</artifactId>
         <version>1.0-alpha-6</version>
       </extension>
+      <extension>
+        <groupId>org.apache.cocoon</groupId>
+        <artifactId>cocoon-maven-reports</artifactId>
+        <version>1.0</version>
+      </extension>
     </extensions>
     
     <plugins>
@@ -681,8 +686,17 @@
               <report>changes-report</report>
             </reports>
           </reportSet>
-        </reportSets>        
+        </reportSets>
       </plugin>      
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <version>2.1</version>
+        <configuration>
+          <configLocation>org/apache/cocoon/maven/reports/checkstyle.xml</configLocation>
+          <headerLocation>org/apache/cocoon/maven/reports/checkstyle-header.txt</headerLocation>
+        </configuration>
+      </plugin>
     </plugins>
   </reporting>
 

Propchange: cocoon/trunk/tools/cocoon-maven-reports/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Tue Jan 16 04:47:31 2007
@@ -0,0 +1,6 @@
+target
+.classpath
+.project
+.wtpmodules
+*.iml
+.settings

Added: cocoon/trunk/tools/cocoon-maven-reports/pom.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/tools/cocoon-maven-reports/pom.xml?view=auto&rev=496671
==============================================================================
--- cocoon/trunk/tools/cocoon-maven-reports/pom.xml (added)
+++ cocoon/trunk/tools/cocoon-maven-reports/pom.xml Tue Jan 16 04:47:31 2007
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  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.
+-->
+<!--+
+    | @version $Id$
+    |
+    +-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>org.apache.cocoon</groupId>
+  <artifactId>cocoon-maven-reports</artifactId>
+  <version>1.0</version>
+  <packaging>jar</packaging>
+  <name>Cocoon Maven Reports</name>
+</project>

Propchange: cocoon/trunk/tools/cocoon-maven-reports/pom.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: cocoon/trunk/tools/cocoon-maven-reports/pom.xml
------------------------------------------------------------------------------
    svn:keywords = Id

Added: cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle-header.txt
URL: http://svn.apache.org/viewvc/cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle-header.txt?view=auto&rev=496671
==============================================================================
--- cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle-header.txt (added)
+++ cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle-header.txt Tue Jan 16 04:47:31 2007
@@ -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.
+ */
\ No newline at end of file

Propchange: cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle-header.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle-header.txt
------------------------------------------------------------------------------
    svn:keywords = Id

Added: cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle.xml?view=auto&rev=496671
==============================================================================
--- cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle.xml (added)
+++ cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle.xml Tue Jan 16 04:47:31 2007
@@ -0,0 +1,199 @@
+<?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 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.1//EN"
+    "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">
+
+<!--
+
+  Checkstyle configuration that checks the sun coding conventions from:
+
+    - the Java Language Specification at
+      http://java.sun.com/docs/books/jls/second_edition/html/index.html
+
+    - the Sun Code Conventions at http://java.sun.com/docs/codeconv/
+
+    - the Javadoc guidelines at
+      http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
+
+    - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
+
+    - some best practices
+
+  Checkstyle is very configurable. Be sure to read the documentation at
+  http://checkstyle.sf.net (or in your downloaded distribution).
+
+  Most Checks are configurable, be sure to consult the documentation.
+
+  To completely disable a check, just comment it out or delete it from the file.
+
+  Finally, it is worth reading the documentation.
+
+-->
+
+<module name="Checker">
+
+    <!-- Checks that a package.html file exists for each package.     -->
+    <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
+    <!-- module name="PackageHtml"/ -->
+
+    <!-- Checks whether files end with a new line.                        -->
+    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
+    <module name="NewlineAtEndOfFile"/>
+
+    <!-- Checks that property files contain the same keys.         -->
+    <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
+    <module name="Translation"/>
+
+
+    <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"/>
+        <module name="JavadocType"/>
+        <module name="JavadocVariable"/>
+        <module name="JavadocStyle"/>
+
+
+        <!-- Checks for Naming Conventions.                  -->
+        <!-- See http://checkstyle.sf.net/config_naming.html -->
+        <module name="ConstantName"/>
+        <module name="LocalFinalVariableName"/>
+        <module name="LocalVariableName"/>
+        <module name="MemberName"/>
+        <module name="MethodName"/>
+        <module name="PackageName"/>
+        <module name="ParameterName"/>
+        <module name="StaticVariableName"/>
+        <module name="TypeName"/>
+
+
+        <!-- Checks for Headers                              -->
+        <!-- See http://checkstyle.sf.net/config_header.html -->
+        <module name="Header">
+            <!-- The follow property value demonstrates the ability     -->
+            <!-- to have access to ANT properties. In this case it uses -->
+            <!-- the ${basedir} property to allow Checkstyle to be run  -->
+            <!-- from any directory within a project. See property      -->
+            <!-- expansion,                                             -->
+            <!-- http://checkstyle.sf.net/config.html#properties        -->
+            <!-- <property                                              -->
+            <!--     name="headerFile"                                  -->
+            <!--     value="${basedir}/java.header"/>                   -->
+            <property name="headerFile" value="${checkstyle.header.file}"/>
+        </module>
+
+        <!-- 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"/>
+        <module name="UnusedImports"/>
+
+
+        <!-- Checks for Size Violations.                    -->
+        <!-- See http://checkstyle.sf.net/config_sizes.html -->
+        <module name="FileLength"/>
+        <module name="LineLength">
+          <property name="ignorePattern" value="^ *\* *@(inheritDoc|version|see)(\w|\W)+"/>
+          <property name="max" value="100"/>
+        </module>
+        <module name="MethodLength"/>
+        <module name="ParameterNumber"/>
+
+
+        <!-- Checks for whitespace                               -->
+        <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+        <module name="EmptyForIteratorPad"/>
+        <!-- module name="NoWhitespaceAfter"/ -->
+        <!-- module name="NoWhitespaceBefore"/ -->
+        <!-- module name="OperatorWrap"/ -->
+        <!-- module name="ParenPad"/ -->
+        <!-- module name="TypecastParenPad"/ -->
+        <module name="TabCharacter"/>
+        <!-- module name="WhitespaceAfter"/ -->
+        <!-- module name="WhitespaceAround"/ -->
+
+
+        <!-- Modifier Checks                                    -->
+        <!-- See http://checkstyle.sf.net/config_modifiers.html -->
+        <module name="ModifierOrder"/>
+        <module name="RedundantModifier"/>
+
+
+        <!-- Checks for blocks. You know, those {}'s         -->
+        <!-- See http://checkstyle.sf.net/config_blocks.html -->
+        <module name="AvoidNestedBlocks"/>
+        <module name="EmptyBlock"/>
+        <module name="LeftCurly"/>
+        <module name="NeedBraces"/>
+        <module name="RightCurly"/>
+
+
+        <!-- Checks for common coding problems               -->
+        <!-- See http://checkstyle.sf.net/config_coding.html -->
+        <module name="AvoidInlineConditionals"/>
+        <module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->
+        <module name="EmptyStatement"/>
+        <module name="EqualsHashCode"/>
+        <module name="HiddenField"/>
+        <module name="IllegalInstantiation"/>
+        <module name="InnerAssignment"/>
+        <module name="MagicNumber"/>
+        <module name="MissingSwitchDefault"/>
+        <module name="RedundantThrows"/>
+        <module name="SimplifyBooleanExpression"/>
+        <module name="SimplifyBooleanReturn"/>
+
+        <!-- Checks for class design                         -->
+        <!-- See http://checkstyle.sf.net/config_design.html -->
+        <!--
+          <module name="DesignForExtension"/>
+        -->
+        <module name="FinalClass"/>
+        <module name="HideUtilityClassConstructor"/>
+        <module name="InterfaceIsType"/>
+        <module name="VisibilityModifier">
+          <property name="protectedAllowed" value="true"/>
+        </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+$"/>
+            <property name="message" value="Line has trailing spaces."/>
+        </module>
+        <module name="TodoComment"/>
+        <module name="UpperEll"/>
+
+    </module>
+
+</module>

Propchange: cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: cocoon/trunk/tools/cocoon-maven-reports/src/main/resources/org/apache/cocoon/maven/reports/checkstyle.xml
------------------------------------------------------------------------------
    svn:keywords = Id

Modified: cocoon/trunk/tools/pom.xml
URL: http://svn.apache.org/viewvc/cocoon/trunk/tools/pom.xml?view=diff&rev=496671&r1=496670&r2=496671
==============================================================================
--- cocoon/trunk/tools/pom.xml (original)
+++ cocoon/trunk/tools/pom.xml Tue Jan 16 04:47:31 2007
@@ -35,6 +35,7 @@
   <modules>
     <module>archetypes</module>
     <module>cocoon-block-deployer</module>
+    <module>cocoon-maven-reports</module>
     <module>cocoon-rcl</module>    
   </modules>
   <scm>