You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by gr...@apache.org on 2006/11/15 19:14:29 UTC
svn commit: r475340 - in /myfaces/maven/trunk:
build-tools/src/main/resources/org/apache/myfaces/checkstyle.xml
master-pom/pom.xml
Author: grantsmith
Date: Wed Nov 15 10:14:28 2006
New Revision: 475340
URL: http://svn.apache.org/viewvc?view=rev&rev=475340
Log:
Checkstyle rules for file headers.
Modified:
myfaces/maven/trunk/build-tools/src/main/resources/org/apache/myfaces/checkstyle.xml
myfaces/maven/trunk/master-pom/pom.xml
Modified: myfaces/maven/trunk/build-tools/src/main/resources/org/apache/myfaces/checkstyle.xml
URL: http://svn.apache.org/viewvc/myfaces/maven/trunk/build-tools/src/main/resources/org/apache/myfaces/checkstyle.xml?view=diff&rev=475340&r1=475339&r2=475340
==============================================================================
--- myfaces/maven/trunk/build-tools/src/main/resources/org/apache/myfaces/checkstyle.xml (original)
+++ myfaces/maven/trunk/build-tools/src/main/resources/org/apache/myfaces/checkstyle.xml Wed Nov 15 10:14:28 2006
@@ -1,232 +0,0 @@
-<?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.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">
-
- <!-- Checks that a package.html file exists for each package. -->
- <!-- See http://checkstyle.sf.net/config_javadoc.html#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}"/>
- <property name="charset" value="UTF-8"/>
- <property name="tabWidth" value="4"/>
-
- <!-- 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"/> -->
- <!-- Following interprets the header file as regular expressions. -->
- <!-- </module> -->
-
- <module name="RegexpHeader">
- <property name="header" value="^package \n^$\n/\*$\n^ \* Copyright \d\d\d\d-\d\d\d\d The Apache Software Foundation.$\n^ \*$\n^ \* Licensed under the Apache License, Version 2.0 \(the "License"\)\;$\n^ \* you may not use this file except in compliance with the License.$\n^ \* You may obtain a copy of the License at$\n^ \*$\n^ \* http://www.apache.org/licenses/LICENSE-2.0$\n^ \*$\n^ \* Unless required by applicable law or agreed to in writing, software$\n^ \* distributed under the License is distributed on an "AS IS" BASIS,$\n^ \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.$\n^ \* See the License for the specific language governing permissions and$\n^ \* limitations under the License.$\n^ \*/$\n^$"/>
- </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="FileLength"/>
- <module name="LineLength">
- <property name="max" value="120"/>
- </module>
- <module name="MethodLength"/>
- <module name="ParameterNumber">
- </module>
-
-
- <!-- 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="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">
- <property name="allowInSwitchCase" value="true"/>
- </module>
- <module name="EmptyBlock">
- <property name="option" value="text"/>
- <property name="tokens" value="LITERAL_CATCH"/>
- </module>
- <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="CovariantEquals"/>
- <module name="DoubleCheckedLocking"/> <!-- MY FAVOURITE -->
- <!--<module name="EmptyStatement"/>-->
- <module name="EqualsHashCode"/>
- <!--module name="HiddenField">
- <property name="ignoreSetter" value="true" />
- <property name=" ignoreConstructorParameter" value="true" />
- </module-->
- <module name="IllegalInstantiation">
- <property name="classes" value="java.lang.Boolean"/>
- </module>
- <module name="InnerAssignment"/>
- <!-- <module name="MagicNumber"/> -->
- <module name="MissingSwitchDefault"/>
- <module name="RedundantThrows">
- <property name="allowUnchecked" value="true"/>
- </module>
- <module name="StringLiteralEquality"/>
- <module name="SimplifyBooleanExpression"/>
- <module name="SimplifyBooleanReturn"/>
- <module name="SuperClone"/>
- <module name="SuperFinalize"/>
- <module name="IllegalThrows"/>
- <module name="PackageDeclaration"/>
- <module name="MultipleVariableDeclarations"/>
-
- <!-- 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"/> -->
- <!-- Line with Trailing Spaces (disabled as it's to noisy)
- <module name="GenericIllegalRegexp">
- <property name="format" value="\s+$"/>
- <property name="message" value="Line has trailing spaces."/>
- </module>
- -->
-
- <!-- Let todo plugin handle this.
- <module name="TodoComment"/>
- -->
-
- <module name="UpperEll"/>
-
- </module>
-
-</module>
Modified: myfaces/maven/trunk/master-pom/pom.xml
URL: http://svn.apache.org/viewvc/myfaces/maven/trunk/master-pom/pom.xml?view=diff&rev=475340&r1=475339&r2=475340
==============================================================================
--- myfaces/maven/trunk/master-pom/pom.xml (original)
+++ myfaces/maven/trunk/master-pom/pom.xml Wed Nov 15 10:14:28 2006
@@ -435,6 +435,18 @@
<target>1.3</target>
</configuration>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.myfaces.maven</groupId>
+ <artifactId>build-tools</artifactId>
+ <version>${pom.version}</version>
+ </dependency>
+ </dependencies>
+ <version>2.1</version>
+ </plugin>
</plugins>
</build>
<repositories>
@@ -486,6 +498,15 @@
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jdepend-maven-plugin</artifactId>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <configuration>
+ <configLocation>config/myfaces-checks.xml</configLocation>
+ <headerLocation>config/myfaces-header.txt</headerLocation>
+ </configuration>
+ <version>2.1</version>
</plugin>
</plugins>
</reporting>