[Plexus-svn] SF.net SVN: plexus:[870] trunk/plexus-graph/src/main

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 870
          http://plexus.svn.sourceforge.net/plexus/?rev=870&view=rev
Author:   rconner
Date:     2010-09-10 20:13:54 +0000 (Fri, 10 Sep 2010)

Log Message:
-----------
adding initial checkstyle and pmd configurations

Added Paths:
-----------
    trunk/plexus-graph/src/main/config/
    trunk/plexus-graph/src/main/config/checkstyle/
    trunk/plexus-graph/src/main/config/checkstyle/checkstyle-header.txt
    trunk/plexus-graph/src/main/config/checkstyle/checkstyle.xml
    trunk/plexus-graph/src/main/config/pmd/
    trunk/plexus-graph/src/main/config/pmd/ruleset.xml

Added: trunk/plexus-graph/src/main/config/checkstyle/checkstyle-header.txt
===================================================================

--- trunk/plexus-graph/src/main/config/checkstyle/checkstyle-header.txt	                        (rev 0)
+++ trunk/plexus-graph/src/main/config/checkstyle/checkstyle-header.txt	2010-09-10 20:13:54 UTC (rev 870)
@@ -0,0 +1,16 @@
+^/\*$
+^ \*  \$Id: \w+\.java \d+ \d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\dZ \w+ \$$
+^ \*$
+^ \*  Copyright \(C\) \d\d\d\d-\d\d\d\d by Phoenix Software Technologists,$
+^ \*  Inc\. and others\.  All rights reserved\.$
+^ \*$
+^ \*  THIS PROGRAM AND DOCUMENTATION IS PROVIDED UNDER THE TERMS OF THE$
+^ \*  COMMON PUBLIC LICENSE \("AGREEMENT"\) WHICH ACCOMPANIES IT\.  ANY$
+^ \*  USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES$
+^ \*  RECIPIENT'S ACCEPTANCE OF THE AGREEMENT\.$
+^ \*$
+^ \*  The license text can also be found at$
+^ \*    http://opensource\.org/licenses/cpl\.php$
+^ \*/$
+^$
+^package com\.phoenixst\.


Property changes on: trunk/plexus-graph/src/main/config/checkstyle/checkstyle-header.txt
___________________________________________________________________
Added: svn:mime-type
   + text/plain
Added: svn:keywords
   + Date Revision Id
Added: svn:eol-style
   + native

Added: trunk/plexus-graph/src/main/config/checkstyle/checkstyle.xml
===================================================================
--- trunk/plexus-graph/src/main/config/checkstyle/checkstyle.xml	                        (rev 0)
+++ trunk/plexus-graph/src/main/config/checkstyle/checkstyle.xml	2010-09-10 20:13:54 UTC (rev 870)
@@ -0,0 +1,191 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE module PUBLIC
+    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
+    "http://www.puppycrawl.com/dtds/configuration_1_2.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">
+    <!--
+        If you set the basedir property below, then all reported file
+        names will be relative to the specified directory. See
+        http://checkstyle.sourceforge.net/5.x/config.html#Checker
+
+        <property name="basedir" value="${basedir}"/>
+    -->
+
+    <!-- Following interprets the header file as regular expressions. -->
+    <module name="RegexpHeader">
+        <property name="headerFile" value="${checkstyle.header.file}" />
+    </module>
+
+<!-- The rest of this is from sun_checks.xml -->
+
+    <!-- Checks that each Java package has a Javadoc file used for commenting. -->
+    <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage       -->
+    <module name="JavadocPackage">
+        <property name="allowLegacy" value="true"/>
+    </module>
+
+    <!-- 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="FileLength"/>
+
+    <module name="FileTabCharacter">
+        <property name="eachLine" value="true"/>
+    </module>
+
+    <module name="RegexpSingleline">
+        <!-- \s matches whitespace character, $ matches end of line. -->
+        <property name="format" value="\s+$"/>
+        <property name="message" value="Line has trailing spaces."/>
+    </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"/>
+        <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"/>                   -->
+        <!-- </module> -->
+
+
+        <!-- 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="LineLength"/>
+        <module name="MethodLength"/>
+        <module name="ParameterNumber"/>
+
+
+        <!-- Checks for whitespace                               -->
+        <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+        <module name="EmptyForIteratorPad"/>
+        <module name="MethodParamPad"/>
+        <module name="NoWhitespaceAfter"/>
+        <module name="NoWhitespaceBefore"/>
+        <module name="OperatorWrap"/>
+        <module name="ParenPad"/>
+        <module name="TypecastParenPad"/>
+        <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"/>
+
+
+        <!-- Miscellaneous other checks.                   -->
+        <!-- See http://checkstyle.sf.net/config_misc.html -->
+        <module name="ArrayTypeStyle"/>
+        <module name="FinalParameters"/>
+        <module name="TodoComment"/>
+        <module name="UpperEll"/>
+
+    </module>
+
+</module>


Property changes on: trunk/plexus-graph/src/main/config/checkstyle/checkstyle.xml
___________________________________________________________________
Added: svn:mime-type
   + text/xml
Added: svn:keywords
   + Date Revision Id
Added: svn:eol-style
   + native

Added: trunk/plexus-graph/src/main/config/pmd/ruleset.xml
===================================================================
--- trunk/plexus-graph/src/main/config/pmd/ruleset.xml	                        (rev 0)
+++ trunk/plexus-graph/src/main/config/pmd/ruleset.xml	2010-09-10 20:13:54 UTC (rev 870)
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="Plexus Ruleset" xmlns="http://pmd.sf.net/ruleset/1.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
+    xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
+
+    <!--
+        Customized PMD ruleset for Plexus, see [0] for more information
+        [0] http://pmd.sourceforge.net/howtomakearuleset.html
+    -->
+
+    <description>
+        This ruleset checks the code for discouraged programming constructs.
+        It contains almost every Java rule in PMD.
+    </description>
+
+    <rule ref="rulesets/android.xml" />
+    <rule ref="rulesets/basic.xml" />
+    <rule ref="rulesets/braces.xml" />
+    <rule ref="rulesets/clone.xml" />
+    <rule ref="rulesets/codesize.xml" />
+    <rule ref="rulesets/controversial.xml" />
+    <rule ref="rulesets/coupling.xml" />
+    <rule ref="rulesets/design.xml" />
+    <rule ref="rulesets/finalizers.xml" />
+    <rule ref="rulesets/imports.xml" />
+    <rule ref="rulesets/j2ee.xml" />
+    <rule ref="rulesets/javabeans.xml" />
+    <rule ref="rulesets/junit.xml" />
+    <rule ref="rulesets/logging-jakarta-commons.xml" />
+    <rule ref="rulesets/logging-java.xml" />
+    <rule ref="rulesets/migrating.xml" />
+    <rule ref="rulesets/naming.xml" />
+    <rule ref="rulesets/optimizations.xml" />
+    <rule ref="rulesets/strictexception.xml" />
+    <rule ref="rulesets/strings.xml" />
+    <rule ref="rulesets/sunsecure.xml" />
+    <rule ref="rulesets/typeresolution.xml" />
+    <rule ref="rulesets/unusedcode.xml" />
+
+</ruleset>


Property changes on: trunk/plexus-graph/src/main/config/pmd/ruleset.xml
___________________________________________________________________
Added: svn:mime-type
   + text/xml
Added: svn:keywords
   + Date Revision Id
Added: svn:eol-style
   + native


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


