ASF Bugzilla – Attachment 25423 Details for
Bug 49268
Use checkstyle to enforce common code style
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
Remember
[x]
|
Forgot Password
Login:
[x]
Patch adding target checkstyle to main build.xml with a extrem minimal number of checks
patchCheckstyle.txt (text/plain), 10.74 KB, created by
Marc Guillemot
on 2010-05-10 12:12:31 UTC
(
hide
)
Description:
Patch adding target checkstyle to main build.xml with a extrem minimal number of checks
Filename:
MIME Type:
Creator:
Marc Guillemot
Created:
2010-05-10 12:12:31 UTC
Size:
10.74 KB
patch
obsolete
>Index: build.properties.default >=================================================================== >--- build.properties.default (revision 942708) >+++ build.properties.default (working copy) >@@ -130,3 +130,7 @@ > dojo-js.loc=http://download.dojotoolkit.org/release-1.1.1/dojo-release-1.1.1.tar.gz > dojo-js.jar=${dojo-js.home}/dojo/dojo.js > >+# ----- Checkstyle ----- >+checkstyle.home=${base.path}/checkstyle >+checkstyle.loc=${base-sf.loc}/checkstyle/checkstyle/5.1/checkstyle-5.1.zip >+checkstyle.jar=${checkstyle.home}/checkstyle-5.1/checkstyle-all-5.1.jar >Index: build.xml >=================================================================== >--- build.xml (revision 942708) >+++ build.xml (working copy) >@@ -74,6 +74,7 @@ > <property name="tomcat.src.jars" value="${tomcat.output}/src-jars"/> > <property name="test.classes" value="${tomcat.output}/testclasses"/> > <property name="test.temp" value="${tomcat.output}/test-tmp"/> >+ <property name="checkstyle.report.dir" value="${tomcat.output}/checkstyle"/> > > <!-- Servlet 3.0 spec requires 1.6+ --> > <property name="compile.source" value="1.6"/> >@@ -1822,6 +1823,28 @@ > > </target> > >+ <target name="checkstyle"> >+ <antcall target="downloadzip"> >+ <param name="sourcefile" value="${checkstyle.loc}"/> >+ <param name="destfile" value="${checkstyle.jar}"/> >+ <param name="destdir" value="${checkstyle.home}"/> >+ </antcall> >+ <taskdef resource="checkstyletask.properties" classpath="${checkstyle.jar}"/> >+ >+ <mkdir dir="${checkstyle.report.dir}"/> >+ <checkstyle config="res/checkstyle.xml" failOnViolation="false" failureProperty="checkstyleFailed"> >+ <fileset dir="java" includes="org/**/*.java"/> >+ <property key="checkstyle.cache.file" file="${checkstyle.report.dir}/cachefile"/> >+ <formatter type="xml" tofile="${checkstyle.report.dir}/checkstyle_report.xml"/> >+ <formatter type="plain"/> >+ </checkstyle> >+ >+ <xslt basedir="${checkstyle.report.dir}" destdir="${checkstyle.report.dir}" >+ includes="checkstyle_report.xml" >+ style="${checkstyle.home}/checkstyle-5.1/contrib/checkstyle-noframes.xsl"/> >+ <fail if="checkstyleFailed">Checkstyle failed!</fail> >+ </target> >+ > <!-- ========================= Cleaning Targets ========================== --> > > <target name="clean-depend" >Index: res/checkstyle.xml >=================================================================== >--- res/checkstyle.xml (revision 0) >+++ res/checkstyle.xml (revision 0) >@@ -0,0 +1,233 @@ >+<?xml version="1.0"?> >+<!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"> >+ <!-- >+ If you set the basedir property below, then all reported file >+ names will be relative to the specified directory. See >+ http://checkstyle.sourceforge.net/5.x/config.html#Checker >+ >+ <property name="basedir" value="${basedir}"/> >+ --> >+ >+ <!-- Checks that a package-info.java file exists for each package. --> >+ <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage --> >+ <!-- >+ <module name="JavadocPackage"/> >+ --> >+ >+ <!-- 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"/> >+ >+ <!-- Checks for Size Violations. --> >+ <!-- See http://checkstyle.sf.net/config_sizes.html --> >+ <!-- >+ <module name="FileLength"/> >+ --> >+ >+ <!-- Checks for whitespace --> >+ <!-- See http://checkstyle.sf.net/config_whitespace.html --> >+ <module name="FileTabCharacter"/> >+ >+ <!-- Miscellaneous other checks. --> >+ <!-- See http://checkstyle.sf.net/config_misc.html --> >+ <!-- >+ <module name="RegexpSingleline"> >+ <property name="format" value="\s+$"/> >+ <property name="minimum" value="0"/> >+ <property name="maximum" value="0"/> >+ <property name="message" value="Line has trailing spaces."/> >+ </module> >+ --> >+ >+ <module name="TreeWalker"> >+ >+ <!-- Checks for Javadoc comments. --> >+ <!-- See http://checkstyle.sf.net/config_javadoc.html --> >+ <!-- >+ <module name="JavadocMethod"/> >+ --> >+<!-- >+ <module name="JavadocType"> >+ <property name="scope" value="public"/> >+ <property name="versionFormat" value="\$Id.*\$"/> >+ </module> >+ --> >+ <!-- >+ <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"/> --> >+ <!-- </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="LineLength"/> >+ <module name="MethodLength"/> >+ <module name="ParameterNumber"/> >+ --> >+ >+ >+ <!-- Checks for whitespace --> >+ <!-- See http://checkstyle.sf.net/config_whitespace.html --> >+ <!-- >+ <module name="EmptyForIteratorPad"/> >+ <module name="GenericWhitespace"/> >+ <module name="MethodParamPad"/> >+ <module name="NoWhitespaceAfter"/> >+ <module name="NoWhitespaceBefore"/> >+ <module name="OperatorWrap"/> >+ <module name="ParenPad"/> >+ <module name="TypecastParenPad"/> >+ <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="DoubleCheckedLocking"/> --> <!-- MY FAVOURITE --> >+ <!-- >+ <module name="EmptyStatement"/> >+ <module name="EqualsHashCode"/> >+ <module name="HiddenField"/> >+ --> >+ <module name="IllegalInstantiation"/> >+ <!-- >+ <module name="InnerAssignment"/> >+ <module name="MagicNumber"/> >+ <module name="MissingSwitchDefault"/> >+ <module name="RedundantThrows"/> >+ <module name="SimplifyBooleanExpression"/> >+ <module name="SimplifyBooleanReturn"/> >+ --> >+ >+ <!-- 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"/> >+ <module name="TodoComment"/> >+ <module name="UpperEll"/> >+ --> >+ >+ </module> >+ >+</module> > >Property changes on: res/checkstyle.xml >___________________________________________________________________ >Added: svn:eol-style > + native >Added: svn:keywords > + Author Date Id Revision >
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Raw
Actions:
View
Attachments on
bug 49268
: 25423