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/07/05 19:28:14 UTC
svn commit: r674214 - in
/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default:
myfaces-checks-loose.xml myfaces-checks-strict.xml myfaces-checks.xml
myfaces-header-2.txt myfaces-header-regexp.txt
Author: skitching
Date: Sat Jul 5 10:28:14 2008
New Revision: 674214
URL: http://svn.apache.org/viewvc?rev=674214&view=rev
Log:
Checkstyle rules updates. Create variants for high and low quality source.
Added:
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-loose.xml (with props)
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-strict.xml (with props)
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header-2.txt (with props)
myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header-regexp.txt (with props)
Modified:
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-loose.xml
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-loose.xml?rev=674214&view=auto
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-loose.xml (added)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-loose.xml Sat Jul 5 10:28:14 2008
@@ -0,0 +1,53 @@
+<?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.
+ This checks the absolute minimum, and should only be used for
+ projects that have really ugly existing code and are not worth
+ fixing up.
+ -->
+
+<module name="Checker">
+
+ <module name="TreeWalker">
+
+ <property name="cacheFile" value="${checkstyle.cache.file}"/>
+
+ <module name="TypeName">
+ <property name="format" value="^_?[A-Z][a-zA-Z0-9]*$"/>
+ </module>
+
+ <module name="Header">
+ <property name="headerFile" value="${checkstyle.header.file}"/>
+ </module>
+
+ <module name="TabCharacter"/>
+
+ <module name="UpperEll"/>
+
+ </module>
+
+</module>
Propchange: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-loose.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-strict.xml
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-strict.xml?rev=674214&view=auto
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-strict.xml (added)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-strict.xml Sat Jul 5 10:28:14 2008
@@ -0,0 +1,174 @@
+<?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.
+ This enforces stricter quality checks than the "myfaces-checks.xml"
+ file does. Ideally this would be used everywhere, but...
+-->
+
+<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 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">
+ <!-- Normal rules, except that:
+ - * any name can start with an underscore.
+ - * "log" is allowed; this is a traditional name for log objects
+ - * names ending with "ThreadLocal" are allowed so that threadlocal vars don't have to be
+ - all-caps. They are static final, but are not really constants. Yes, type prefixes
+ - on variable names sucks ("hungarian notation") but checkstyle doesn't allow
+ - name rules to vary by the type of the constant, and no other alternative seems
+ - any better.
+ -->
+ <property name="format"
+ value="^_?((log)|([a-z][a-zA-Z]*ThreadLocal)|([A-Z][A-Z0-9]*(_[A-Z0-9]+)*))$"/>
+ </module>
+
+ <module name="LocalVariableName"/>
+ <module name="MethodName">
+ <property name="format" value="^_?[a-z][a-zA-Z0-9]*$"/>
+ </module>
+ <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="LineLength">
+ <property name="max" value="120" />
+ <property name="ignorePattern" value="@version|@see"/>
+ </module>
+ <module name="MethodLength">
+ <property name="max" value="200" />
+ </module>
+ <module name="ParameterNumber">
+ <property name="max" value="10" />
+ </module>
+
+
+ <!-- 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>
+ -->
+ <module name="UpperEll"/>
+
+ </module>
+
+</module>
Propchange: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks-strict.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: 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=674214&r1=674213&r2=674214&view=diff
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks.xml (original)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-checks.xml Sat Jul 5 10:28:14 2008
@@ -25,14 +25,6 @@
<!--
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">
@@ -53,23 +45,11 @@
<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"/>
--->
+ <!-- module name="JavadocMethod"/ -->
+ <!-- module name="JavadocType"/ -->
+ <!-- module name="JavadocVariable"/ -->
<!-- Checks for Naming Conventions. -->
@@ -81,12 +61,23 @@
-->
<module name="ConstantName">
- <!-- Normal rules, except that "log" is also allowed as a constant name. -->
- <property name="format" value="^(log|[A-Z][A-Z0-9]*(_[A-Z0-9]+)*)$"/>
+ <!-- Normal rules, except that:
+ - * any name can start with an underscore.
+ - * "log" is allowed; this is a traditional name for log objects
+ - * names ending with "ThreadLocal" are allowed so that threadlocal vars don't have to be
+ - all-caps. They are static final, but are not really constants. Yes, type prefixes
+ - on variable names sucks ("hungarian notation") but checkstyle doesn't allow
+ - name rules to vary by the type of the constant, and no other alternative seems
+ - any better.
+ -->
+ <property name="format"
+ value="^_?((log)|([a-z][a-zA-Z]*ThreadLocal)|([A-Z][A-Z0-9]*(_[A-Z0-9]+)*))$"/>
</module>
<module name="LocalVariableName"/>
- <module name="MethodName"/>
+ <module name="MethodName">
+ <property name="format" value="^_?[a-z][a-zA-Z0-9]*$"/>
+ </module>
<module name="PackageName"/>
<module name="LocalFinalVariableName"/>
<module name="ParameterName"/>
@@ -95,12 +86,14 @@
<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"/>
@@ -112,8 +105,16 @@
<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
<module name="FileLength"/>
- <module name="MethodLength"/>
- <module name="ParameterNumber"/>
+ <module name="LineLength">
+ <property name="max" value="120" />
+ <property name="ignorePattern" value="@version|@see"/>
+ </module>
+ <module name="MethodLength">
+ <property name="max" value="200" />
+ </module>
+ <module name="ParameterNumber">
+ <property name="max" value="10" />
+ </module>
<!-- Checks for whitespace -->
@@ -122,14 +123,12 @@
<!-- Modifier Checks -->
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
-<!--
- <module name="ModifierOrder"/>
- <module name="RedundantModifier"/>
--->
+ <!-- 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="EmptyBlock"/ -->
<module name="NeedBraces"/>
<module name="LeftCurly">
<property name="option" value="nl"/>
@@ -154,10 +153,8 @@
<!-- module name="DesignForExtension"/ -->
<!-- module name="FinalClass"/ -->
<!-- module name="HideUtilityClassConstructor"/ -->
-<!--
- <module name="InterfaceIsType"/>
- <module name="VisibilityModifier"/>
--->
+ <!-- module name="InterfaceIsType"/ -->
+ <!-- module name="VisibilityModifier"/ -->
<!-- Miscellaneous other checks. -->
@@ -170,9 +167,6 @@
<property name="message" value="Line has trailing spaces."/>
</module>
-->
- <!-- Let todo plugin handle this.
- <module name="TodoComment"/>
- -->
<module name="UpperEll"/>
</module>
Added: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header-2.txt
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header-2.txt?rev=674214&view=auto
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header-2.txt (added)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header-2.txt Sat Jul 5 10:28:14 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-2.txt
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header-regexp.txt
URL: http://svn.apache.org/viewvc/myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header-regexp.txt?rev=674214&view=auto
==============================================================================
--- myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header-regexp.txt (added)
+++ myfaces/myfaces-build-tools/trunk/other/checkstyle-rules/src/main/resources/default/myfaces-header-regexp.txt Sat Jul 5 10:28:14 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-regexp.txt
------------------------------------------------------------------------------
svn:eol-style = native