diff --git a/checkstyle/.cvsignore b/checkstyle/.cvsignore index 7244964b..7aa0bb00 100644 --- a/checkstyle/.cvsignore +++ b/checkstyle/.cvsignore @@ -3,3 +3,4 @@ velocity.log maven.log .classpath .project +build.properties diff --git a/checkstyle/plugin.jelly b/checkstyle/plugin.jelly index c6e018c6..493c7053 100644 --- a/checkstyle/plugin.jelly +++ b/checkstyle/plugin.jelly @@ -1,129 +1,37 @@ + - - - - - - - + + - - - - - - - + + - - - - - - - - - - Using ${checkstyleProperties} for checkstyle ... - - - - - - - - - - - - - - - - - - - - - - - - - - - ${checkstyle.header.file} - - - - - - - - ====================================================================== - = W A R N I N G = - ====================================================================== - = Your project doesn't contain a header file specified as: = - = ${header} - = Checkstyle needs it to check the existence of the License in your = - = source files. If it can't find this file, it throws an error. = - = A temporary solution is to create an empty LICENSE.txt file. = - = Though, we recommend that you edit this License. = - ====================================================================== - - - - - - - - - - - - + - + value="${plugin.resources}/${maven.checkstyle.format}_checks.xml"/> + + + + + + + + + + + + + + + + + + + + + + + + + ====================================================================== + = W A R N I N G = + ====================================================================== + = Your project doesn't contain a header file specified as: = + = ${header} + = Checkstyle needs it to check the existence of the License in your = + = source files. If it can't find this file, it throws an error. = + = A temporary solution is to create an empty LICENSE.txt file. = + = Though, we recommend that you edit this License. = + ====================================================================== + + + + + + + + + + + + + + + + + + + + + Using ${checkstyleProperties} for checkstyle ... + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/checkstyle/plugin.properties b/checkstyle/plugin.properties index dd47382f..b9293ebf 100644 --- a/checkstyle/plugin.properties +++ b/checkstyle/plugin.properties @@ -1,15 +1,15 @@ # ------------------------------------------------------------------- -# P L U G I N P R O P E R I E S +# P L U G I N P R O P E R T I E S # ------------------------------------------------------------------- # Checkstyle plugin # ------------------------------------------------------------------- -maven.build.dir = ${basedir}/target maven.checkstyle.includes = **/*.java maven.checkstyle.excludes = maven.checkstyle.fail.on.violation = false maven.checkstyle.cache.file = ${maven.build.dir}/checkstyle-cachefile maven.checkstyle.format = sun +maven.checkstyle.header.file = ${basedir}/LICENSE.txt # If useFile is false then the checkstyle task will display violations # on stdout. diff --git a/checkstyle/project.xml b/checkstyle/project.xml index f0b8425b..c9ab6160 100644 --- a/checkstyle/project.xml +++ b/checkstyle/project.xml @@ -5,22 +5,29 @@ 3 maven-checkstyle-plugin Maven Checkstyle Plug-in - 1.1 + 2.0-SNAPSHOT - Java Project Management Tools + Checkstyle Plug-in http://maven.apache.org/reference/plugins/checkstyle/ /www/maven.apache.org/reference/plugins/checkstyle/ scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:maven/src/plugins-build/checkstyle/ http://cvs.apache.org/viewcvs/maven/src/plugins-build/checkstyle/ + 1.1 1.1 MAVEN_CHECKSTYLE_1_1 + + 2.0 + 2.0 + HEAD + + dIon Gillard @@ -43,8 +50,8 @@ Vincent Massol vmassol - vmassol@octo.com - Octo Technology + vmassol@pivolis.com + Pivolis Java Developer @@ -55,71 +62,42 @@ jason@zenplex.com Zenplex - Architect - Release Manager + Java Developer + - antlr - 2.7.1 - antlrall-2.7.1.jar - - root - + antlr + antlr + 2.7.2 - checkstyle - 2.3 - - root - + checkstyle + checkstyle + 3.1 - commons-jelly - commons-jelly-tags-jsl - 20030211.143151 - - root.maven - - - - commons-jelly - commons-jelly-tags-xml - 20030211.142705 - http://jakarta.apache.org/commons/jelly/libs/xml/ - - root.maven - - - - commons-jelly - commons-jelly-tags-util - 20030211.141939 - http://jakarta.apache.org/commons/jelly/libs/util/ - - root.maven - - - - regexp + regexp + regexp 1.2 - - root - + + + commons-beanutils + commons-beanutils + 1.6 + + + commons-collections + commons-collections + 2.1 + + + commons-logging + commons-logging + 1.0.3 - - diff --git a/checkstyle/src/plugin-resources/avalon-checkstyle.properties b/checkstyle/src/plugin-resources/avalon-checkstyle.properties deleted file mode 100644 index e902ed50..00000000 --- a/checkstyle/src/plugin-resources/avalon-checkstyle.properties +++ /dev/null @@ -1,49 +0,0 @@ -checkstyle.lcurly.type=nl -checkstyle.lcurly.method=nl -checkstyle.lcurly.other=nl - -checkstyle.rcurly=alone - -checkstyle.ignore.braces=no -checkstyle.ignore.importlength=yes -checkstyle.ignore.public.in.interface=no -checkstyle.ignore.whitespace=yes -checkstyle.ignore.whitespace.cast=yes - -checkstyle.parent.pad=space - -# TODO: Try to get the files ot match the default values -# default 80 maxlinelen -checkstyle.maxlinelen=250 -# default 2000 -checkstyle.maxfilelen=3000 -# default 150 maxmethodlen -checkstyle.maxmethodlen=180 -# default 150 maxmethodlen -checkstyle.maxconstructorlen=100 - -# default 7 -checkstyle.maxparameters=13 - -checkstyle.pattern.member=^m_[a-z](_?[a-zA-Z0-9])*$ -checkstyle.pattern.static=^c_[a-z](_?[a-zA-Z0-9])*$ -checkstyle.pattern.const=^[A-Z](_?[A-Z0-9]+)*$ -checkstyle.pattern.method=[a-z](_?[a-zA-Z0-9]+)*$ -checkstyle.pattern.parameter=[a-z](_?[a-zA-Z0-9]+)*$ -checkstyle.pattern.localvar=[a-z](_?[a-zA-Z0-9]+)*$ - -checkstyle.pattern.todo=xTODO:x - -checkstyle.javadoc.scope=protected -checkstyle.javadoc.checkUnusedThrows=true - -checkstyle.require.packagehtml=yes - -checkstyle.allow.noauthor=no -checkstyle.allow.protected=yes -checkstyle.allow.package=no -checkstyle.allow.tabs=no - -# These instantiations should be illegal, use the static constants instead. -checkstyle.illegalInstantiations=java.lang.Boolean - diff --git a/checkstyle/src/plugin-resources/avalon_checks.xml b/checkstyle/src/plugin-resources/avalon_checks.xml new file mode 100644 index 00000000..9d03d852 --- /dev/null +++ b/checkstyle/src/plugin-resources/avalon_checks.xml @@ -0,0 +1,189 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/checkstyle/src/plugin-resources/sun-checkstyle.properties b/checkstyle/src/plugin-resources/sun-checkstyle.properties deleted file mode 100644 index b101018b..00000000 --- a/checkstyle/src/plugin-resources/sun-checkstyle.properties +++ /dev/null @@ -1,7 +0,0 @@ -# Sample checkstyle properties file to use with maven to support the -# sun code conventions -# -# To use this file, place the following in your project.properties: -# -# maven.checkstyle.properties=${maven.home}/plugins/checkstyle/sun-code-conventions-checkstyle.properties -# diff --git a/checkstyle/src/plugin-resources/sun_checks.xml b/checkstyle/src/plugin-resources/sun_checks.xml new file mode 100644 index 00000000..2efad25e --- /dev/null +++ b/checkstyle/src/plugin-resources/sun_checks.xml @@ -0,0 +1,166 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/checkstyle/src/plugin-resources/turbine-checkstyle.properties b/checkstyle/src/plugin-resources/turbine-checkstyle.properties deleted file mode 100644 index 8f6e0852..00000000 --- a/checkstyle/src/plugin-resources/turbine-checkstyle.properties +++ /dev/null @@ -1,39 +0,0 @@ -# -# Checkstyle settings ... default turbine project code settings, these can be -# overridden in a project specific properties file. -# -checkstyle.lcurly.type = nl -checkstyle.lcurly.method = nl -checkstyle.lcurly.other = nl -checkstyle.rcurly = alone -#checkstyle.paren.pad = nospace -#checkstyle.allow.tabs = false -#checkstyle.allow.protected = false -#checkstyle.allow.package = false -#checkstyle.allow.no.author = false -checkstyle.tab.width = 4 -checkstyle.ignore.maxlinelen = @version -checkstyle.maxfilelen = 2000 -#checkstyle.maxlinelen = 80 -#checkstyle.maxmethodlen = 150 -#checkstyle.maxconstructorlen = 150 -#checkstyle.ignore.importlength = false -#checkstyle.pattern.member = ^[a-z][a-zA-Z0-9]*$ -checkstyle.pattern.publicmember = ^f[A-Z][a-zA-Z0-9]*$ -#checkstyle.pattern.parameter = ^[a-z][a-zA-Z0-9]*$ -#checkstyle.pattern.const = ^[A-Z]([A-Z0-9_]*[A-Z0-9])?$ -#checkstyle.pattern.static = ^[a-z][a-zA-Z0-9]*$ -#checkstyle.pattern.type = ^[A-Z][a-zA-Z0-9]*$ -#checkstyle.pattern.method = ^[a-z][a-zA-Z0-9]*$ -#checkstyle.pattern.localvar = ^[a-z][a-zA-Z0-9]*$ -#checkstyle.javadoc.scope = private -#checkstyle.require.package.html = false -#checkstyle.ignore.imports = false -checkstyle.illegal.imports = -#checkstyle.ignore.whitespace = false -#checkstyle.ignore.cast.whitespace = false -#checkstyle.ignore.braces = false -#checkstyle.ignore.public.in.interface = false -checkstyle.header.file = LICENSE.txt -#checkstyle.header.regexp = false -checkstyle.header.ignoreline = 1,6 diff --git a/checkstyle/src/plugin-resources/turbine_checks.xml b/checkstyle/src/plugin-resources/turbine_checks.xml new file mode 100644 index 00000000..d8b900b5 --- /dev/null +++ b/checkstyle/src/plugin-resources/turbine_checks.xml @@ -0,0 +1,183 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/checkstyle/xdocs/.cvsignore b/checkstyle/xdocs/.cvsignore deleted file mode 100644 index cb6131bb..00000000 --- a/checkstyle/xdocs/.cvsignore +++ /dev/null @@ -1 +0,0 @@ -stylesheets diff --git a/checkstyle/xdocs/changes.xml b/checkstyle/xdocs/changes.xml index 7e44c5ad..db50de06 100644 --- a/checkstyle/xdocs/changes.xml +++ b/checkstyle/xdocs/changes.xml @@ -6,6 +6,19 @@ + + + + Upgraded to Checkstyle 3.1. + + + Updated documentation. + + + Complete clean of the existing plugin. + + + Added a new maven.checkstyle.useFile property. diff --git a/checkstyle/xdocs/goals.xml b/checkstyle/xdocs/goals.xml index a178fdf8..7bc1b393 100644 --- a/checkstyle/xdocs/goals.xml +++ b/checkstyle/xdocs/goals.xml @@ -13,29 +13,19 @@ checkstyle - This is the default goal of the plugin and simply has a pre-requisite - of the checkstyle:check-license-file goal. + This is the default goal of the plugin. It simply calls the + checkstyle:report goal. - checkstyle:generate-report + checkstyle:report Generates an xml report from the source code showing how well the - code conforms to the Checkstyle + code conforms to the + Checkstyle definitions defined by the project. - - checkstyle:check-license-file - - Checks the existence of the LICENSE.txt file that checkstyle uses - for ensuring the top of a source file has a valid license block. -

- If the license file exists, the checkstyle:generate-report - goal is attained. -

- - diff --git a/checkstyle/xdocs/index.xml b/checkstyle/xdocs/index.xml index b0b5acda..75ef8e70 100644 --- a/checkstyle/xdocs/index.xml +++ b/checkstyle/xdocs/index.xml @@ -9,9 +9,31 @@

- This plugin generates a nicely formatted checkstyle report so + This plugin generates a nicely formatted + Checkstyle report so code violations can be easily found and corrected.

+
+ + + + + + + + + + + + + +
DateDescription
30 May 2003 + New development version 2.0 created. First cut at supporting + Checkstyle 3.1. +
30 May 2003 + Release of version 1.1 (compatible with Checkstyle 2.4). +
+
diff --git a/checkstyle/xdocs/properties.xml b/checkstyle/xdocs/properties.xml index 92d6306f..3a00e009 100644 --- a/checkstyle/xdocs/properties.xml +++ b/checkstyle/xdocs/properties.xml @@ -33,23 +33,33 @@ exclude any files. + + maven.checkstyle.format + Yes + + Specifies what predefined check set to use. Available sets are + "sun" (for the Sun coding conventions), "turbine" and "avalon". + Default value is sun. + + maven.checkstyle.properties Yes Specifies the location of the checkstyle properties that will be - used to check the source. -

- There is also a sample file shipped with maven of the Jakarta - Turbine project - coding style, which maven adheres to. -

-

For more information on checkstyle properties, please see the - CheckStyle Home Page -

-

The default value is - ${plugin.dir}/core/sun-code-conventions-checkstyle.properties. -

+ used to check the source. Note that you will need to use this + property only if you don't want to use any of the predefined + formats (see maven.checkstyle.format). + + + + maven.checkstyle.header.file + Yes + + Specifies the location of the License file (a.k.a the header file) + that is used by Checkstyle to verify that source code has the + correct copyright. Default value is + ${basedir}/LICENSE.txt