Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add goals page; clarify properties.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@489952 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
jjensen 2006-12-23 23:44:20 +00:00
parent 7a96f451f5
commit 60eaeb275a
6 changed files with 114 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
pmd/project.xml
View File

@ -76,6 +76,11 @@
<name>1.9</name>
<tag>MAVEN_PMD_1_9</tag>
</version>
<version>
<id>1.10-SNAPSHOT</id>
<name>1.10-SNAPSHOT</name>
<tag>MAVEN_PMD_1_10</tag>
</version>
</versions>
<developers>
<developer>
@ -131,6 +136,15 @@
<role>Developer</role>
</roles>
</developer>
<developer>
<name>Jeff Jensen</name>
<id>jjensen</id>
<email>jjensen@apache.org</email>
<roles>
<role>Developer</role>
</roles>
<timezone>-6</timezone>
</developer>
</developers>
<contributors>
<contributor>

2
pmd/xdocs/changes.xml
View File

@ -25,6 +25,8 @@
</properties>
<body>
<release version="1.10-SNAPSHOT" date="In SVN">
<action dev="jjensen" type="add">Add "Goals" page.</action>
<action dev="jjensen" type="update">Update/clarify properties and add "Default" column to "Properties" page.</action>
<action dev="ltheussl" type="fix" issue="MPPMD-30">Cannot run pmd with Strings rulesets.</action>
<action dev="ltheussl" type="add" due-to="James Dempsey">Add an alternative jsl stylesheet that includes priority information.</action>
<action dev="ltheussl" type="add" issue="MPPMD-27">Allow custom JSL stylesheet to be defined via a property.</action>

53
pmd/xdocs/goals.xml Normal file
View File

@ -0,0 +1,53 @@
<?xml version="1.0"?>
<!--
/*
* Copyright 2006 The Apache Software Foundation.
*
* Licensed 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.
*/
-->
<document>
<properties>
<title>Maven PMD Plug-in Goals</title>
<author email="jjensen@apache.org">Jeff Jensen</author>
</properties>
<body>
<section name="Goals">
<table>
<tr>
<th>Goal</th>
<th>Description</th>
</tr>
<tr>
<td>pmd</td>
<td>If enabled, run the pmd:report goal.</td>
</tr>
<tr>
<td>pmd:report</td>
<td>
Run PMD on the code and generate the report.
Also, if enabled, run the pmd:cpd-report goal.
</td>
</tr>
<tr>
<td>pmd:cpd-report</td>
<td>Run CPD on the code and generate the report.</td>
</tr>
<tr>
<td></td>
<td></td>
</tr>
</table>
</section>
</body>
</document>

4
pmd/xdocs/index.xml
View File

@ -27,6 +27,10 @@
This plugin generates a report of the PMD static source code
analyzer.
</p>
<p>
To learn which release of PMD this version of the Maven PMD plugin uses,
refer to the <a href="dependencies.html">Dependencies Report</a>.
</p>
<p>
See the <a href="faq.html">FAQ</a> for more information on Installation / Use / Configuring.
</p>

1
pmd/xdocs/navigation.xml
View File

@ -32,6 +32,7 @@
<menu name="Home">
<item name="About" href="/index.html"/>
<item name="FAQs" href="/faq.html"/>
<item name="Goals" href="/goals.html"/>
<item name="Properties" href="/properties.html"/>
<item name="Sample" href="/images/sample.gif" target="_blank"/>
</menu>

55
pmd/xdocs/properties.xml
View File

@ -22,6 +22,7 @@
<properties>
<title>Properties</title>
<author email="siegfried.goeschl@it20one.at">Siegfried Goeschl</author>
<author email="jjensen@apache.org">Jeff Jensen</author>
</properties>
<body>
@ -30,11 +31,13 @@
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Default</th>
<th>Description</th>
</tr>
<tr>
<td>maven.pmd.enable</td>
<td>No</td>
<td>true</td>
<td>
Enable/disable the PMD plugin. Has to be set to "true"
to enable the plugin
@ -43,91 +46,109 @@
<tr>
<td>maven.pmd.rulesetfiles</td>
<td>Yes</td>
<td>rulesets/basic.xml, rulesets/unusedcode.xml, rulesets/imports.xml</td>
<td>
Defines the rule to be used for running PMD. Is
already defined in the plugin
Defines the rule sets that PMD uses to scan the code
checking for violations.
Comma separated list.
Can specify rulesets that ship with PMD
(in the PMD jar, which are all in the "rulesets" package)
and custom rulesets of PMD rules and/or your own rules.
(suggestion is to specify custom rule jars as a project
dependency so Maven automatically puts them on the classpath
and PMD will automatically find them)
</td>
</tr>
<tr>
<td>maven.pmd.includes</td>
<td>Yes</td>
<td>
**/*.java, which matches all Java source files
in the source tree (specified by the <code>${maven.src.dir}</code>
property.
</td>
<td>
Specifies a comma-separated list of Ant patterns to use
when matching files in the source tree to be included in the
PMD report. The pattern specified is relative to
<code>${maven.src.dir}</code>. The default value is
<code>**/*.java</code>, which matches all Java source files
in the source tree (specified by the <code>${maven.src.dir}</code>
property.
<code>${maven.src.dir}</code>.
</td>
</tr>
<tr>
<td>maven.pmd.excludes</td>
<td>Yes</td>
<td>(no files excluded)</td>
<td>
Specifies a comma-separated list of Ant patterns to use when
matching files in the source tree to be excluded from the
PMD report. The pattern specified is relative to
<code>${maven.src.dir}</code>. The default value is to not
exclude any files.
<code>${maven.src.dir}</code>.
</td>
</tr>
<tr>
<td>maven.pmd.cpd.enable</td>
<td>Yes</td>
<td>false</td>
<td>
Enable/disable the CPD report. Defaults to "false".
Enable/disable the CPD report.
</td>
</tr>
<tr>
<td>maven.pmd.cpd.minimumtokencount</td>
<td>Yes</td>
<td>100</td>
<td>
Specifies the minimal number required to consider two sequences of
tokens identical. Defaults to "100".
Specifies the minimum number of tokens required
to consider two sequences of tokens identical.
</td>
</tr>
<tr>
<td>maven.pmd.check.tests</td>
<td>Yes</td>
<td>true</td>
<td>
Whether or not to run PMD on test sources. Defaults to true.
Whether or not to run PMD on test sources.
</td>
</tr>
<tr>
<td>maven.pmd.console</td>
<td>Yes</td>
<td>false</td>
<td>
Whether or not to display PMD errors to the console. Defaults to false.
Whether or not to display PMD errors to the console.
</td>
</tr>
<tr>
<td>maven.pmd.failonerror</td>
<td>Yes</td>
<td>false</td>
<td>
Whether or not to fail the build if any errors occur while processing the files. Defaults to false.
Whether or not to fail the build if any errors occur
while processing the files.
</td>
</tr>
<tr>
<td>maven.pmd.failonruleviolation</td>
<td>Yes</td>
<td>false</td>
<td>
Whether or not to fail the build if PMD finds any problems. Defaults to false.
Whether or not to fail the build if PMD finds any rule violations.
</td>
</tr>
<tr>
<td>maven.pmd.targetjdk</td>
<td>Yes</td>
<td>${maven.compile.source}</td>
<td>
Target JDK 1.3, 1.4, or 1.5.. Defaults to ${maven.compile.source}.
The target JDK: 1.3, 1.4, or 1.5...
</td>
</tr>
<tr>
<td>maven.pmd.stylesheet</td>
<td>Yes</td>
<td>${plugin.resources}/pmd.jsl</td>
<td>
A custom stylesheet to use for the report.
Default is <code>${plugin.resources}/pmd.jsl</code>.
An alternative stylesheet is supplied that includes
priority information of pmd violations. To use it, set
<code>maven.pmd.stylesheet=${plugin.resources}/pmd-priority.jsl</code>.