You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by sk...@apache.org on 2008/06/30 23:14:53 UTC
svn commit: r672926 - in
/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules: ./ src/
src/main/ src/main/resources/ src/main/resources/default/
src/main/resources/tobago/
Author: skitching
Date: Mon Jun 30 14:14:53 2008
New Revision: 672926
URL: http://svn.apache.org/viewvc?rev=672926&view=rev
Log:
Add checkstyle rules module.
Added:
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/pom.xml (with props)
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks.xml (with props)
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header.txt (with props)
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-header.txt (with props)
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-strict.xml (with props)
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle.xml (with props)
Added: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/pom.xml
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/pom.xml?rev=672926&view=auto
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/pom.xml (added)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/pom.xml Mon Jun 30 14:14:53 2008
@@ -0,0 +1,10 @@
+<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.myfaces.buildtools</groupId>
+ <artifactId>checkstyle-rules</artifactId>
+ <packaging>jar</packaging>
+ <version>1-SNAPSHOT</version>
+ <name>checkstyle-rules</name>
+ <url>http://maven.apache.org</url>
+</project>
Propchange: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/pom.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks.xml
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks.xml?rev=672926&view=auto
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks.xml (added)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks.xml Mon Jun 30 14:14:53 2008
@@ -0,0 +1,175 @@
+<?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 maven coding conventions.
+ version 1
+-->
+
+<!--
+ The initial implementation is to verify the Apache license is present
+ in all source files. Modules not need for the initial implementation
+ where commented out instead of being removed. The assumption is that
+ modules will be added over time.
+-->
+
+<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}"/>
+
+<!--
+ <property name="tabWidth" value="4"/>
+
+ <module name="LineLength">
+ <property name="max" value="120" />
+ <property name="ignorePattern" value="@version|@see"/>
+ </module>
+
+-->
+
+ <!-- Checks for Javadoc comments. -->
+ <!-- See http://checkstyle.sf.net/config_javadoc.html -->
+<!--
+ <module name="JavadocMethod"/>
+ <module name="JavadocType"/>
+ <module name="JavadocVariable"/>
+-->
+
+
+ <!-- Checks for Naming Conventions. -->
+ <!-- See http://checkstyle.sf.net/config_naming.html -->
+<!--
+ <module name="MemberName">
+ <property name="format" value="^_[a-z][a-zA-Z0-9]*$"/>
+ </module>
+-->
+ <module name="ConstantName"/>
+ <module name="LocalVariableName"/>
+ <module name="MethodName"/>
+ <module name="PackageName"/>
+ <module name="LocalFinalVariableName"/>
+ <module name="ParameterName"/>
+ <module name="StaticVariableName"/>
+ <module name="TypeName">
+ <property name="format" value="^_?[A-Z][a-zA-Z0-9]*$"/>
+ </module>
+
+ <!-- Checks for Headers -->
+ <!-- See http://checkstyle.sf.net/config_header.html -->
+ <module name="Header">
+ <property name="headerFile" value="${checkstyle.header.file}"/>
+ </module>
+
+ <!-- Checks for imports -->
+ <!-- See http://checkstyle.sf.net/config_import.html -->
+ <module name="AvoidStarImport"/>
+ <module name="IllegalImport"/>
+ <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="TabCharacter"/>
+
+ <!-- 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="EmptyBlock"/>
+ <module name="NeedBraces"/>
+ <module name="LeftCurly">
+ <property name="option" value="nl"/>
+ </module>
+ <module name="RightCurly">
+ <property name="option" value="alone"/>
+ </module>
+
+ <!-- Checks for common coding problems -->
+ <!-- See http://checkstyle.sf.net/config_coding.html -->
+ <module name="DoubleCheckedLocking"/>
+ <module name="EmptyStatement"/>
+ <module name="EqualsHashCode"/>
+ <module name="InnerAssignment"/>
+ <module name="DefaultComesLast"/>
+ <module name="MissingSwitchDefault"/>
+ <module name="FallThrough"/>
+ <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>
Propchange: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header.txt
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header.txt?rev=672926&view=auto
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header.txt (added)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header.txt Mon Jun 30 14:14:53 2008
@@ -0,0 +1,18 @@
+/*
+ * 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.
+ */
Propchange: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header.txt
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-header.txt
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-header.txt?rev=672926&view=auto
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-header.txt (added)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-header.txt Mon Jun 30 14:14:53 2008
@@ -0,0 +1,19 @@
+^package
+^$
+^/\*$
+^ \* 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: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-header.txt
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-strict.xml
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-strict.xml?rev=672926&view=auto
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-strict.xml (added)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-strict.xml Mon Jun 30 14:14:53 2008
@@ -0,0 +1,245 @@
+<?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="2"/>
+
+ <!-- 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="headerFile" value="${checkstyle.header.file}"/>
+ <!--<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"/>
+
+
+ <!-- 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"/>
+ <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="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, java.lang.String"/>
+ </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="DeclarationOrder"/>
+ <module name="ParameterAssignment"/>
+ <module name="DeclarationOrder"/>
+ <module name="MultipleVariableDeclarations"/>
+ <module name="UnnecessaryParentheses"/>
+
+ <!-- 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="GenericIllegalRegexp">
+ <property name="format" value="((public)|(protected))\s+void\s+finalize\(\s*\)"/>
+ <property name="message" value="Avoid finalizers"/>
+ </module>
+ <!-- No direct printing to System.out or System.err -->
+
+
+ <module name="GenericIllegalRegexp">
+ <property name="format" value="System\.(out|err)\."/>
+ <property name="message" value="Don't write directly to System.out our System.err"/>
+ </module>
+ <!-- No @author tags -->
+ <module name="GenericIllegalRegexp">
+ <property name="format" value="@author"/>
+ <property name="message" value="No @author tag allowed"/>
+ </module>
+
+
+ <module name="UpperEll"/>
+
+ </module>
+
+</module>
Propchange: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle-strict.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle.xml
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle.xml?rev=672926&view=auto
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle.xml (added)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle.xml Mon Jun 30 14:14:53 2008
@@ -0,0 +1,252 @@
+<?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="2"/>
+
+ <!-- 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="headerFile" value="${checkstyle.header.file}"/>
+ <!--<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">
+ <property name="max" value="15"/>
+ </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, java.lang.String"/>
+ </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="GenericIllegalRegexp">
+ <property name="format" value="((public)|(protected))\s+void\s+finalize\(\s*\)"/>
+ <property name="message" value="Avoid finalizers"/>
+ </module>
+ <!-- No direct printing to System.out or System.err -->
+
+
+ <module name="GenericIllegalRegexp">
+ <property name="format" value="System\.(out|err)\."/>
+ <property name="message" value="Don't write directly to System.out our System.err"/>
+ </module>
+ <!-- No @author tags -->
+ <module name="GenericIllegalRegexp">
+ <property name="format" value="@author"/>
+ <property name="message" value="No @author tag allowed"/>
+ </module>
+
+ <module name="GenericIllegalRegexp">
+ <property name="format" value="strählekreuzen"/>
+ <property name="message" value="No strählekreuzen allowed"/>
+ </module>
+
+ <module name="UpperEll"/>
+
+ </module>
+
+</module>
Propchange: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/tobago/checkstyle.xml
------------------------------------------------------------------------------
svn:eol-style = native