You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by he...@apache.org on 2005/09/12 10:35:10 UTC

svn commit: r280291 - in /jakarta/turbine/core/trunk/extensions/maven-plugin: conf/ conf/checkstyle-license.txt conf/turbine-checkstyle.xml project.properties

Author: henning
Date: Mon Sep 12 01:35:06 2005
New Revision: 280291

URL: http://svn.apache.org/viewcvs?rev=280291&view=rev
Log:
Added checkstyle definition for plugin and license.


Added:
    jakarta/turbine/core/trunk/extensions/maven-plugin/conf/
    jakarta/turbine/core/trunk/extensions/maven-plugin/conf/checkstyle-license.txt   (with props)
    jakarta/turbine/core/trunk/extensions/maven-plugin/conf/turbine-checkstyle.xml   (with props)
Modified:
    jakarta/turbine/core/trunk/extensions/maven-plugin/project.properties

Added: jakarta/turbine/core/trunk/extensions/maven-plugin/conf/checkstyle-license.txt
URL: http://svn.apache.org/viewcvs/jakarta/turbine/core/trunk/extensions/maven-plugin/conf/checkstyle-license.txt?rev=280291&view=auto
==============================================================================
--- jakarta/turbine/core/trunk/extensions/maven-plugin/conf/checkstyle-license.txt (added)
+++ jakarta/turbine/core/trunk/extensions/maven-plugin/conf/checkstyle-license.txt Mon Sep 12 01:35:06 2005
@@ -0,0 +1,17 @@
+
+
+/*
+ * Copyright 2003-2005 The Apache Software Foundation.
+ *
+ * Licensed 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.
+ */

Propchange: jakarta/turbine/core/trunk/extensions/maven-plugin/conf/checkstyle-license.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Added: jakarta/turbine/core/trunk/extensions/maven-plugin/conf/turbine-checkstyle.xml
URL: http://svn.apache.org/viewcvs/jakarta/turbine/core/trunk/extensions/maven-plugin/conf/turbine-checkstyle.xml?rev=280291&view=auto
==============================================================================
--- jakarta/turbine/core/trunk/extensions/maven-plugin/conf/turbine-checkstyle.xml (added)
+++ jakarta/turbine/core/trunk/extensions/maven-plugin/conf/turbine-checkstyle.xml Mon Sep 12 01:35:06 2005
@@ -0,0 +1,211 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2003-2005 The Apache Software Foundation.
+
+ Licensed 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>

Propchange: jakarta/turbine/core/trunk/extensions/maven-plugin/conf/turbine-checkstyle.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: jakarta/turbine/core/trunk/extensions/maven-plugin/conf/turbine-checkstyle.xml
------------------------------------------------------------------------------
    svn:keywords = Id Author

Modified: jakarta/turbine/core/trunk/extensions/maven-plugin/project.properties
URL: http://svn.apache.org/viewcvs/jakarta/turbine/core/trunk/extensions/maven-plugin/project.properties?rev=280291&r1=280290&r2=280291&view=diff
==============================================================================
--- jakarta/turbine/core/trunk/extensions/maven-plugin/project.properties (original)
+++ jakarta/turbine/core/trunk/extensions/maven-plugin/project.properties Mon Sep 12 01:35:06 2005
@@ -1,18 +1,16 @@
-# -------------------------------------------------------------------
-# Copyright 2001-2004 The Apache Software Foundation
+# Copyright 2003-2005 The Apache Software Foundation.
 #
-# Licensed under the Apache License, Version 2.0 (the "License");
+# Licensed 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.
-# -------------------------------------------------------------------
 
 # -------------------------------------------------------------------
 # P R O J E C T  P R O P E R T I E S
@@ -25,20 +23,28 @@
 
 maven.multiproject.type=jar
 
-#========================================================================
-# 
+# ========================================================================
+#
 # Maven building and deploy. These settings are for deployment to www.apache.org.
 # If you are not an Turbine committer, you can safely ignore these. :-)
-# 
-#========================================================================
+#
+# ========================================================================
 maven.repo.remote=http://www.ibiblio.org/maven/,http://www.apache.org/dist/java-repository/
 maven.remote.group=apcvs
 
+maven.repo.list=apache
+maven.repo.apache=scp://cvs.apache.org
+maven.repo.apache.directory=/www/www.apache.org/dist/java-repository
+maven.repo.apache.group=apcvs
+
 maven.checkstyle.format = turbine
-#maven.home = ${user.home}/maven
+maven.checkstyle.properties = conf/turbine-checkstyle.xml
+maven.checkstyle.header.file = conf/checkstyle-license.txt
 
-# display the date on the site
+# xdoc plugin
 maven.xdoc.date = left
-# Display the version the web site is documenting
+maven.xdoc.locale.default = en
 maven.xdoc.version = ${pom.currentVersion}
 
+# No ideology without asking
+maven.xdoc.developmentProcessUrl=



---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org