turbine-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From t.@apache.org
Subject svn commit: r615321 - in /turbine/core/trunk/conf: CodeWrestler.excludes checkstyle-license.txt cw.sh turbine-checkstyle.xml
Date Fri, 25 Jan 2008 20:04:50 GMT
Author: tv
Date: Fri Jan 25 12:04:50 2008
New Revision: 615321

URL: http://svn.apache.org/viewvc?rev=615321&view=rev
Log:
Added CodeWrestler configuration

Added:
    turbine/core/trunk/conf/CodeWrestler.excludes
    turbine/core/trunk/conf/checkstyle-license.txt
    turbine/core/trunk/conf/cw.sh
    turbine/core/trunk/conf/turbine-checkstyle.xml

Added: turbine/core/trunk/conf/CodeWrestler.excludes
URL: http://svn.apache.org/viewvc/turbine/core/trunk/conf/CodeWrestler.excludes?rev=615321&view=auto
==============================================================================
--- turbine/core/trunk/conf/CodeWrestler.excludes (added)
+++ turbine/core/trunk/conf/CodeWrestler.excludes Fri Jan 25 12:04:50 2008
@@ -0,0 +1,14 @@
+#
+# This is an exclude file to parse the turbine-2 code base using CodeWrestler,
+# available from http://henning.schmiedehausen.org/eyewiki/Wiki.jsp?page=CodeWrestler
+#
+.*\.ai$
+.*\.psd$
+.*\.dia$
+/proposals/
+src/announcements
+conf/CodeWrestler\.excludes$
+conf/openldap/turbine\.schema$
+conf/openldap/turbine\.ldif$
+conf/openldap/slapd\.conf$
+/target/

Added: turbine/core/trunk/conf/checkstyle-license.txt
URL: http://svn.apache.org/viewvc/turbine/core/trunk/conf/checkstyle-license.txt?rev=615321&view=auto
==============================================================================
--- turbine/core/trunk/conf/checkstyle-license.txt (added)
+++ turbine/core/trunk/conf/checkstyle-license.txt Fri Jan 25 12:04:50 2008
@@ -0,0 +1,20 @@
+
+
+/*
+ * 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.
+ */

Added: turbine/core/trunk/conf/cw.sh
URL: http://svn.apache.org/viewvc/turbine/core/trunk/conf/cw.sh?rev=615321&view=auto
==============================================================================
--- turbine/core/trunk/conf/cw.sh (added)
+++ turbine/core/trunk/conf/cw.sh Fri Jan 25 12:04:50 2008
@@ -0,0 +1,29 @@
+# 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.
+
+# Run the CodeWrestler
+# http://henning.schmiedehausen.org/eyewiki/Wiki.jsp?page=CodeWrestler
+
+# Add license to new files
+python ~/Dev/cw/CodeWrestler.py -e conf/CodeWrestler.excludes --module=license.ReLicense
--modopts='-f conf/checkstyle-license.txt -t java -n'
+# Relicense existing files
+python ~/Dev/cw/CodeWrestler.py -e conf/CodeWrestler.excludes --module=license.ReLicense
--modopts='-f conf/checkstyle-license.txt -t java -e'
+
+# Cleanup Java files
+python ~/Dev/cw/CodeWrestler.py -e conf/CodeWrestler.excludes --module=java.TopFormatter
+python ~/Dev/cw/CodeWrestler.py -e conf/CodeWrestler.excludes --module=xml.TopFormatter
+python ~/Dev/cw/CodeWrestler.py -e conf/CodeWrestler.excludes --module=format.StripBlank

Added: turbine/core/trunk/conf/turbine-checkstyle.xml
URL: http://svn.apache.org/viewvc/turbine/core/trunk/conf/turbine-checkstyle.xml?rev=615321&view=auto
==============================================================================
--- turbine/core/trunk/conf/turbine-checkstyle.xml (added)
+++ turbine/core/trunk/conf/turbine-checkstyle.xml Fri Jan 25 12:04:50 2008
@@ -0,0 +1,214 @@
+<?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.
+-->
+
+<!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 that are different from the sun coding conventions ones -->
+        <!-- ************************************************************** -->
+        <property name="tabWidth" value="4"/>
+        <module name="LeftCurly">
+          <property name="option" value="nl"/>
+        </module>
+        <module name="RightCurly">
+          <property name="option" value="alone"/>
+        </module>
+        <module name="LineLength">
+          <property name="ignorePattern" value="@version"/>
+          <property name="max" value="132"/>
+        </module>
+        <module name="MemberName">
+          <property name="format" value="^[a-z]+_*[a-zA-Z0-9]*$"/>
+        </module>
+        <module name="StaticVariableName">
+          <property name="format" value="^[a-z]+_*[a-zA-Z0-9]*$"/>
+        </module>
+        <module name="ConstantName">
+          <property name="format" value="^(([A-Z][A-Z0-9]*(_[A-Z0-9]+)*)|log)$"/>
+        </module>
+        <module name="ParameterName">
+          <property name="format" value="^[a-z]+_*[a-zA-Z0-9]*$"/>
+        </module>
+
+        <!-- ************************************************************** -->
+        <!-- Default Sun coding conventions checks                          -->
+        <!-- ************************************************************** -->
+
+        <!-- Checks for Javadoc comments.                     -->
+        <!-- See http://checkstyle.sf.net/config_javadoc.html -->
+        <module name="JavadocMethod">
+          <property name="excludeScope" value="private"/>
+        </module>
+        <module name="JavadocType"/>
+        <module name="JavadocVariable"/>
+
+
+        <!-- Checks for Naming Conventions.                  -->
+        <!-- See http://checkstyle.sf.net/config_naming.html -->
+        <module name="LocalFinalVariableName"/>
+        <module name="LocalVariableName"/>
+        <module name="MethodName"/>
+        <module name="PackageName"/>
+        <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.                   -->
+            <property name="headerFile" value="${checkstyle.header.file}"/>
+            <property name="ignoreLines" value="1,6"/>
+        </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="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="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="NeedBraces"/>
+
+
+        <!-- Checks for common coding problems               -->
+        <!-- See http://checkstyle.sf.net/config_coding.html -->
+        <module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->
+        <module name="EmptyStatement"/>
+        <module name="EqualsHashCode"/>
+        <module name="FallThrough"/>
+        <module name="HiddenField"/>
+        <module name="IllegalInstantiation"/>
+        <module name="InnerAssignment"/>
+        <module name="MagicNumber"/>
+        <module name="MissingSwitchDefault"/>
+<!--        <module name="OneMethodPrivateField" /> -->
+        <module name="RedundantThrows"/>
+        <module name="SimplifyBooleanExpression"/>
+        <module name="SimplifyBooleanReturn"/>
+
+        <!-- Checks for class design                         -->
+        <!-- See http://checkstyle.sf.net/config_design.html -->
+        <module name="FinalClass"/>
+        <module name="HideUtilityClassConstructor"/>
+        <module name="VisibilityModifier">
+        <module name="MissingSwitchDefault"/>
+          <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>



Mime
View raw message