2020-11-14 09:20:07 +00:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "description" content = "" >
< meta name = "keywords" content = "userdocstools, " >
< title > Maven PMD Plugin | PMD Source Code Analyzer< / title >
< link rel = "stylesheet" href = "css/syntax.css" >
< link rel = "stylesheet" type = "text/css" href = "https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" >
<!-- <link rel="stylesheet" type="text/css" href="css/bootstrap.min.css"> -->
< link rel = "stylesheet" href = "css/modern-business.css" >
< link rel = "stylesheet" href = "css/lavish-bootstrap.css" >
< link rel = "stylesheet" href = "css/customstyles.css" >
< link rel = "stylesheet" href = "css/theme-blue.css" >
< link rel = "stylesheet" href = "css/pmd-customstyles.css" >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js" > < / script >
< script src = "js/jquery.navgoco.min.js" > < / script >
< script src = "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js" > < / script >
< script src = "js/toc.js" > < / script >
< script src = "js/customscripts.js" > < / script >
< link rel = "shortcut icon" href = "images/favicon.ico" type = "image/x-icon" >
< link rel = "icon" href = "images/favicon.ico" type = "image/x-icon" >
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!-- [if lt IE 9]>
< script src = "https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js" > < / script >
< script src = "https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js" > < / script >
<![endif]-->
< link rel = "alternate" type = "application/rss+xml" title = "" href = "https://pmd.github.io/pmd/feed.xml" >
< script >
$(document).ready(function() {
// Initialize navgoco with default options
$("#mysidebar").navgoco({
caretHtml: '',
accordion: true,
openClass: 'active', // open
save: false, // leave false or nav highlighting doesn't work right
cookie: {
name: 'navgoco',
expires: false,
path: '/'
},
slide: {
duration: 400,
easing: 'swing'
}
});
$("#collapseAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', false);
});
$("#expandAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', true);
});
});
< / script >
< script >
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
< / script >
< script >
$(document).ready(function() {
$("#tg-sb-link").click(function() {
$("#tg-sb-sidebar").toggle();
$("#tg-sb-content").toggleClass('col-md-9');
$("#tg-sb-content").toggleClass('col-md-12');
$("#tg-sb-icon").toggleClass('fa-toggle-on');
$("#tg-sb-icon").toggleClass('fa-toggle-off');
});
});
< / script >
< / head >
< body >
<!-- Content is offset by the height of the topnav bar. -->
<!-- There's already a padding - top rule in modern - business.css, but it apparently doesn't work on Firefox 60 and Chrome 67 -->
< div id = "topbar-content-offset" >
<!-- Navigation -->
< nav class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "container topnavlinks" >
< div class = "navbar-header" >
< button type = "button" class = "navbar-toggle" data-toggle = "collapse" data-target = "#bs-example-navbar-collapse-1" >
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "fa fa-home fa-lg navbar-brand" href = "index.html" > < span class = "projectTitle" > PMD Source Code Analyzer Project< / span > < / a >
< / div >
< div class = "collapse navbar-collapse" id = "bs-example-navbar-collapse-1" >
< ul class = "nav navbar-nav navbar-right" >
<!-- toggle sidebar button -->
< li > < a id = "tg-sb-link" href = "#" > < i id = "tg-sb-icon" class = "fa fa-toggle-on" > < / i > Nav< / a > < / li >
<!-- entries without drop - downs appear here -->
< li > < a href = "https://github.com/pmd/pmd/releases/latest" target = "_blank" > Download< / a > < / li >
< li > < a href = "https://github.com/pmd/pmd" target = "_blank" > Fork us on github< / a > < / li >
<!-- entries with drop - downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file. -->
<!-- comment out this block if you want to hide search -->
< li >
<!-- start search -->
< div id = "search-demo-container" >
< input type = "text" id = "search-input" placeholder = "search..." >
< ul id = "results-container" > < / ul >
< / div >
< script src = "js/jekyll-search.js" type = "text/javascript" > < / script >
< script type = "text/javascript" >
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: 'search.json',
searchResultTemplate: '< li > < a href = "{url}" title = "Maven PMD Plugin" > {title}< / a > < / li > ',
noResultsText: 'No results found.',
limit: 10,
fuzzy: true,
})
< / script >
<!-- end search -->
< / li >
< / ul >
< / div >
< / div >
<!-- /.container -->
< / nav >
<!-- Page Content -->
< div class = "container" >
< div class = "col-lg-12" > < / div >
<!-- Content Row -->
< div class = "row" >
<!-- Sidebar Column -->
< div class = "col-md-3" id = "tg-sb-sidebar" >
< ul id = "mysidebar" class = "nav" >
2021-01-30 17:25:02 +00:00
< li class = "sidebarTitle" > PMD 6.32.0-SNAPSHOT< / li >
2020-11-14 09:20:07 +00:00
< li >
< a href = "#" > About< / a >
< ul >
< li > < a href = "index.html" > Home< / a > < / li >
< li > < a href = "pmd_release_notes.html" > Release notes< / a > < / li >
< li > < a href = "pmd_next_major_development.html" > PMD 7.0.0 development< / a > < / li >
< li > < a href = "pmd_about_help.html" > Getting help< / a > < / li >
< / ul >
< / li >
< li >
< a href = "#" > User Documentation< / a >
< ul >
< li > < a href = "pmd_userdocs_installation.html" > Installation and basic CLI usage< / a > < / li >
< li > < a href = "pmd_userdocs_making_rulesets.html" > Making rulesets< / a > < / li >
< li > < a href = "pmd_userdocs_configuring_rules.html" > Configuring rules< / a > < / li >
< li > < a href = "pmd_userdocs_best_practices.html" > Best practices< / a > < / li >
< li > < a href = "pmd_userdocs_suppressing_warnings.html" > Suppressing warnings< / a > < / li >
< li > < a href = "pmd_userdocs_incremental_analysis.html" > Incremental analysis< / a > < / li >
< li > < a href = "pmd_userdocs_cli_reference.html" > PMD CLI reference< / a > < / li >
< li > < a href = "pmd_userdocs_report_formats.html" > PMD Report formats< / a > < / li >
< li class = "subfolders" >
< a href = "#" > CPD reference< / a >
< ul >
< li > < a href = "pmd_userdocs_cpd.html" > Copy-paste detection< / a > < / li >
< li > < a href = "pmd_userdocs_cpd_report_formats.html" > CPD Report formats< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Extending PMD< / a >
< ul >
< li > < a href = "pmd_userdocs_extending_writing_rules_intro.html" > Introduction to writing rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_your_first_rule.html" > Your first rule< / a > < / li >
< li > < a href = "pmd_userdocs_extending_writing_xpath_rules.html" > XPath rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_writing_java_rules.html" > Java rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_designer_reference.html" > Rule designer reference< / a > < / li >
< li > < a href = "pmd_userdocs_extending_defining_properties.html" > Defining rule properties< / a > < / li >
< li > < a href = "pmd_userdocs_extending_metrics_howto.html" > Using and defining code metrics< / a > < / li >
< li > < a href = "pmd_userdocs_extending_rule_guidelines.html" > Rule guidelines< / a > < / li >
< li > < a href = "pmd_userdocs_extending_testing.html" > Testing your rules< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Tools / Integrations< / a >
< ul >
< li class = "active" > < a href = "pmd_userdocs_tools_maven.html" > Maven PMD Plugin< / a > < / li >
< li > < a href = "pmd_userdocs_tools_gradle.html" > Gradle< / a > < / li >
< li > < a href = "pmd_userdocs_tools_ant.html" > Ant< / a > < / li >
< li > < a href = "pmd_userdocs_tools_java_api.html" > PMD Java API< / a > < / li >
< li > < a href = "pmd_userdocs_tools_ci.html" > CI integrations< / a > < / li >
< li > < a href = "pmd_userdocs_tools.html" > Other Tools / Integrations< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< a href = "#" > Rule Reference< / a >
< ul >
< li class = "subfolders" >
< a href = "#" > Apex Rules< / a >
< ul >
< li > < a href = "pmd_rules_apex.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_apex_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_apex_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_apex_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_apex_documentation.html" > Documentation< / a > < / li >
< li > < a href = "pmd_rules_apex_errorprone.html" > Error Prone< / a > < / li >
< li > < a href = "pmd_rules_apex_performance.html" > Performance< / a > < / li >
< li > < a href = "pmd_rules_apex_security.html" > Security< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Ecmascript Rules< / a >
< ul >
< li > < a href = "pmd_rules_ecmascript.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_ecmascript_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_ecmascript_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_ecmascript_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Java Rules< / a >
< ul >
< li > < a href = "pmd_rules_java.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_java_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_java_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_java_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_java_documentation.html" > Documentation< / a > < / li >
< li > < a href = "pmd_rules_java_errorprone.html" > Error Prone< / a > < / li >
< li > < a href = "pmd_rules_java_multithreading.html" > Multithreading< / a > < / li >
< li > < a href = "pmd_rules_java_performance.html" > Performance< / a > < / li >
< li > < a href = "pmd_rules_java_security.html" > Security< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Java Server Pages Rules< / a >
< ul >
< li > < a href = "pmd_rules_jsp.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_jsp_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_jsp_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_jsp_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_jsp_errorprone.html" > Error Prone< / a > < / li >
< li > < a href = "pmd_rules_jsp_security.html" > Security< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Maven POM Rules< / a >
< ul >
< li > < a href = "pmd_rules_pom.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_pom_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Modelica Rules< / a >
< ul >
< li > < a href = "pmd_rules_modelica.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_modelica_bestpractices.html" > Best Practices< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > PLSQL Rules< / a >
< ul >
< li > < a href = "pmd_rules_plsql.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_plsql_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_plsql_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_plsql_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_plsql_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Salesforce VisualForce Rules< / a >
< ul >
< li > < a href = "pmd_rules_vf.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_vf_security.html" > Security< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > VM Rules< / a >
< ul >
< li > < a href = "pmd_rules_vm.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_vm_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_vm_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_vm_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > XML Rules< / a >
< ul >
< li > < a href = "pmd_rules_xml.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_xml_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > XSL Rules< / a >
< ul >
< li > < a href = "pmd_rules_xsl.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_xsl_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_xsl_performance.html" > Performance< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< a href = "#" > Language Specific Documentation< / a >
< ul >
< li > < a href = "pmd_languages_jsp.html" > JSP Support< / a > < / li >
< li > < a href = "pmd_java_metrics_index.html" > Java code metrics< / a > < / li >
< li > < a href = "pmd_apex_metrics_index.html" > Apex code metrics< / a > < / li >
< / ul >
< / li >
< li >
< a href = "#" > Developer Documentation< / a >
< ul >
< li > < a href = "pmd_devdocs_development.html" > Developer resources< / a > < / li >
< li > < a href = "pmd_devdocs_building.html" > Building PMD from source< / a > < / li >
< li > < a href = "https://github.com/pmd/pmd/blob/master/CONTRIBUTING.md" target = "_blank" > Contributing< / a > < / li >
< li > < a href = "pmd_devdocs_writing_documentation.html" > Writing documentation< / a > < / li >
< li > < a href = "pmd_devdocs_roadmap.html" > Roadmap< / a > < / li >
< li > < a href = "pmd_devdocs_how_pmd_works.html" > How PMD works< / a > < / li >
< li > < a href = "pmd_devdocs_pmdtester.html" > Pmdtester< / a > < / li >
< li > < a href = "pmd_devdocs_rule_deprecation_policy.html" > Rule Deprecation Policy< / a > < / li >
< li class = "subfolders" >
< a href = "#" > Major contributions< / a >
< ul >
< li > < a href = "pmd_devdocs_major_adding_new_language.html" > Adding a new language< / a > < / li >
< li > < a href = "pmd_devdocs_major_adding_new_cpd_language.html" > Adding a new CPD language< / a > < / li >
< li > < a href = "pmd_devdocs_major_adding_new_metrics_framework.html" > Adding metrics support to a language< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Experimental features< / a >
< ul >
< li > < a href = "pmd_devdocs_experimental_ast_dump.html" > Creating (XML) dump of the AST< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< a href = "#" > Project documentation< / a >
< ul >
< li class = "subfolders" >
< a href = "#" > Trivia about PMD< / a >
< ul >
< li > < a href = "pmd_projectdocs_trivia_news.html" > PMD in the press< / a > < / li >
< li > < a href = "pmd_projectdocs_trivia_products.html" > Products & books related to PMD< / a > < / li >
< li > < a href = "pmd_projectdocs_trivia_similarprojects.html" > Similar projects< / a > < / li >
< li > < a href = "pmd_projectdocs_trivia_meaning.html" > What does 'PMD' mean?< / a > < / li >
< / ul >
< / li >
< li > < a href = "pmd_projectdocs_faq.html" > FAQ< / a > < / li >
< li > < a href = "license.html" > License< / a > < / li >
< li > < a href = "pmd_projectdocs_credits.html" > Credits< / a > < / li >
< li > < a href = "pmd_release_notes_old.html" > Old release notes< / a > < / li >
< li class = "subfolders" >
< a href = "#" > Project management< / a >
< ul >
< li > < a href = "pmd_projectdocs_committers_releasing.html" > Release process< / a > < / li >
< li > < a href = "pmd_projectdocs_committers_merging_pull_requests.html" > Merging pull requests< / a > < / li >
< li > < a href = "pmd_projectdocs_committers_main_landing_page.html" > Main Landing page< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
<!-- if you aren't using the accordion, uncomment this block:
< p class = "external" >
< a href = "#" id = "collapseAll" > Collapse All< / a > | < a href = "#" id = "expandAll" > Expand All< / a >
< / p >
-->
< / ul >
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted. -->
< script > $ ( "li.active" ) . parents ( 'li' ) . toggleClass ( "active" ) ; < / script >
< / div >
<!-- Content Column -->
< div class = "col-md-9" id = "tg-sb-content" >
< div class = "post-header" >
< h1 class = "post-title-main" > Maven PMD Plugin< / h1 >
< / div >
< div class = "post-content" >
<!-- this handles the automatic toc. use ## for subheads to auto - generate the on - page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
< script >
$( document ).ready(function() {
// Handler for .ready() called.
$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
});
< / script >
< div id = "toc" > < / div >
< a target = "_blank" href = "https://github.com/pmd/pmd/blob/master/docs/pages/pmd/userdocs/tools/maven.md" class = "btn btn-default githubEditButton" role = "button" > < i class = "fa fa-github fa-lg" > < / i > Edit me< / a >
< h2 id = "maven-2-and-3" > Maven 2 and 3< / h2 >
< h3 id = "running-the-pmd-plugin" > Running the pmd plugin< / h3 >
< h4 id = "choosing-the-plugin-version" > Choosing the plugin version< / h4 >
< p > When adding the maven-pmd-plugin to your pom.xml, you need to select a version. To figure out the
latest available version, have a look at the official < a href = "https://maven.apache.org/plugins/maven-pmd-plugin/" > maven-pmd-plugin documentation< / a > .< / p >
< p > As of March 2020, the current plugin version is < strong > 3.13.0< / strong > .< / p >
< p > The version of the plugin should be specified in < code class = "language-plaintext highlighter-rouge" > < build> < pluginManagement/> < /build> < / code > and if using the project
report additionally in < code class = "language-plaintext highlighter-rouge" > < reporting> < plugins/> < /reporting> < / code > elements. Here’
section:< / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < build> < / span >
< span class = "nt" > < pluginManagement> < / span >
< span class = "nt" > < plugins> < / span >
< span class = "nt" > < plugin> < / span >
< span class = "nt" > < groupId> < / span > org.apache.maven.plugins< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > maven-pmd-plugin< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > 3.13.0< span class = "nt" > < /version> < / span >
< span class = "nt" > < /plugin> < / span >
< span class = "nt" > < /plugins> < / span >
< span class = "nt" > < /pluginManagement> < / span >
< span class = "nt" > < /build> < / span >
< / code > < / pre > < / div > < / div >
< p > When defining the version in the pluginManagment section, then it doesn’
section. However, it should additionally be specified in the reporting section.< / p >
< p > More information, see < a href = "https://maven.apache.org/guides/mini/guide-configuring-plugins.html" > Guide to Configuring Plugin-ins< / a > .< / p >
< h4 id = "generating-a-project-report" > Generating a project report< / h4 >
< p > To include the PMD report in the project reports section add the following lines under
the reports element in your pom.xml:< / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < project> < / span >
...
< span class = "nt" > < reporting> < / span >
< span class = "nt" > < plugins> < / span >
< span class = "nt" > < plugin> < / span >
< span class = "nt" > < groupId> < / span > org.apache.maven.plugins< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > maven-pmd-plugin< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > 3.13.0< span class = "nt" > < /version> < / span >
< span class = "nt" > < /plugin> < / span >
< span class = "nt" > < /plugins> < / span >
< span class = "nt" > < /reporting> < / span >
...
< span class = "nt" > < /project> < / span >
< / code > < / pre > < / div > < / div >
< p > This will add an entry to the ‘ ’ < / p >
< h4 id = "executing-pmd-manually" > Executing PMD manually< / h4 >
< p > To run PMD on a Maven project without adding it as a report, simply run< / p >
< div class = "language-plaintext highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > mvn pmd:pmd
< / code > < / pre > < / div > < / div >
< p > The PMD plugin writes the report in XML which will then be formatted into more readable HTML.< / p >
< h4 id = "integrated-into-the-build-process" > Integrated into the build process< / h4 >
< p > You can also run PMD automatically when building your project. You even let the build fail, if
PMD finds some violations. Therefore the < code class = "language-plaintext highlighter-rouge" > check< / code > goal is used:< / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < project> < / span >
...
< span class = "nt" > < build> < / span >
< span class = "nt" > < plugins> < / span >
< span class = "nt" > < plugin> < / span >
< span class = "nt" > < groupId> < / span > org.apache.maven.plugins< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > maven-pmd-plugin< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > 3.13.0< span class = "nt" > < /version> < / span > < span class = "c" > < !-- or use version from pluginManagement --> < / span >
< span class = "nt" > < configuration> < / span >
< span class = "c" > < !-- failOnViolation is actually true by default, but can be disabled --> < / span >
< span class = "nt" > < failOnViolation> < / span > true< span class = "nt" > < /failOnViolation> < / span >
< span class = "c" > < !-- printFailingErrors is pretty useful --> < / span >
< span class = "nt" > < printFailingErrors> < / span > true< span class = "nt" > < /printFailingErrors> < / span >
< span class = "nt" > < /configuration> < / span >
< span class = "nt" > < executions> < / span >
< span class = "nt" > < execution> < / span >
< span class = "nt" > < goals> < / span >
< span class = "nt" > < goal> < / span > check< span class = "nt" > < /goal> < / span >
< span class = "nt" > < /goals> < / span >
< span class = "nt" > < /execution> < / span >
< span class = "nt" > < /executions> < / span >
< span class = "nt" > < /plugin> < / span >
< span class = "nt" > < /plugins> < / span >
< span class = "nt" > < /build> < / span >
...
< span class = "nt" > < /project> < / span >
< / code > < / pre > < / div > < / div >
< p > This will run PMD automatically during the < code class = "language-plaintext highlighter-rouge" > verify< / code > phase of the build. You can additionally run CPD, if
you add < code class = "language-plaintext highlighter-rouge" > cpd-check< / code > as a goal.< / p >
< h3 id = "customization" > Customization< / h3 >
< h4 id = "changing-rulesets" > Changing rulesets< / h4 >
< p > To specify a ruleset, simply edit the previous configuration:< / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < reporting> < / span >
< span class = "nt" > < plugins> < / span >
< span class = "nt" > < plugin> < / span >
< span class = "nt" > < groupId> < / span > org.apache.maven.plugins< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > maven-pmd-plugin< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > 3.13.0< span class = "nt" > < /version> < / span >
< span class = "nt" > < configuration> < / span >
< span class = "nt" > < rulesets> < / span >
< span class = "nt" > < ruleset> < / span > /rulesets/java/quickstart.xml< span class = "nt" > < /ruleset> < / span >
< span class = "nt" > < ruleset> < / span > d:\rulesets\my-ruleset.xml< span class = "nt" > < /ruleset> < / span >
< span class = "nt" > < ruleset> < / span > http://localhost/design.xml< span class = "nt" > < /ruleset> < / span >
< span class = "nt" > < /rulesets> < / span >
< span class = "nt" > < /configuration> < / span >
< span class = "nt" > < /plugin> < / span >
< span class = "nt" > < /plugins> < / span >
< span class = "nt" > < /reporting> < / span >
< / code > < / pre > < / div > < / div >
< p > The value of the ‘ ’ < / p >
< p > A clean strategy for customizing which rules to use for a project is to write a ruleset file.
In this file you can define which rules to use, add custom rules, and
customizing which rules to include/exclude from official rulesets. More information on
writing a ruleset can be found < a href = "pmd_userdocs_making_rulesets.html" > here< / a > .
Note that if you include other rulesets in your own rulesets, you have to be sure that the plugin
will be able to resolve those other ruleset references.< / p >
< h4 id = "enabling-incremental-analysis" > Enabling Incremental Analysis< / h4 >
< p > When using the Maven PMD plugin 3.8 or later along with PMD 5.6.0 or later, you can enable incremental analysis to
speed up PMD’ < / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < plugin> < / span >
< span class = "nt" > < groupId> < / span > org.apache.maven.plugins< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > maven-pmd-plugin< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > 3.13.0< span class = "nt" > < /version> < / span > < span class = "c" > < !-- or use version from pluginManagement --> < / span >
< span class = "nt" > < configuration> < / span >
< span class = "c" > < !-- enable incremental analysis --> < / span >
< span class = "nt" > < analysisCache> < / span > true< span class = "nt" > < /analysisCache> < / span >
< span class = "c" > < !-- analysisCacheLocation: optional - points to the following location by default --> < / span >
< span class = "nt" > < analysisCacheLocation> < / span > ${project.build.directory}/pmd/pmd.cache< span class = "nt" > < /analysisCacheLocation> < / span >
< span class = "nt" > < /configuration> < / span >
< span class = "nt" > < /plugin> < / span >
< / code > < / pre > < / div > < / div >
< h4 id = "other-configurations" > Other configurations< / h4 >
< p > The Maven PMD plugin allows you to configure CPD, targetJDK, and the use of XRef to link
the report to html source files, and the file encoding:< / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < plugin> < / span >
< span class = "nt" > < groupId> < / span > org.apache.maven.plugins< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > maven-pmd-plugin< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > 3.13.0< span class = "nt" > < /version> < / span > < span class = "c" > < !-- or use version from pluginManagement --> < / span >
< span class = "nt" > < configuration> < / span >
< span class = "nt" > < linkXRef> < / span > true< span class = "nt" > < /linkXRef> < / span >
< span class = "nt" > < sourceEncoding> < / span > ISO-8859-1< span class = "nt" > < /sourceEncoding> < / span >
< span class = "nt" > < minimumTokens> < / span > 30< span class = "nt" > < /minimumTokens> < / span >
< span class = "nt" > < targetJdk> < / span > 1.4< span class = "nt" > < /targetJdk> < / span >
< span class = "nt" > < /configuration> < / span >
< span class = "nt" > < /plugin> < / span >
< / code > < / pre > < / div > < / div >
< h4 id = "upgrading-the-pmd-version-at-runtime" > Upgrading the PMD version at runtime< / h4 >
< p > The Maven PMD plugin comes with a specific PMD version, which is documented on the
< a href = "https://maven.apache.org/plugins/maven-pmd-plugin/index.html" > plugin project page< / a > .< / p >
< p > Given that the newer PMD version is compatible, you can override the PMD version, that the
Maven plugin will use and benefit from the latest bugfixes and enhancements:< / p >
< div class = "language-xml highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "nt" > < project> < / span >
< span class = "nt" > < properties> < / span >
< span class = "nt" > < pmdVersion> < / span > ...choose your version...< span class = "nt" > < /pmdVersion> < / span >
< span class = "nt" > < /properties> < / span >
...
< span class = "nt" > < build> < / span >
< span class = "nt" > < pluginManagement> < / span >
< span class = "nt" > < plugins> < / span >
< span class = "nt" > < plugin> < / span >
< span class = "nt" > < groupId> < / span > org.apache.maven.plugins< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > maven-pmd-plugin< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > 3.13.0< span class = "nt" > < /version> < / span >
< span class = "nt" > < dependencies> < / span >
< span class = "nt" > < dependency> < / span >
< span class = "nt" > < groupId> < / span > net.sourceforge.pmd< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > pmd-core< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > ${pmdVersion}< span class = "nt" > < /version> < / span >
< span class = "nt" > < /dependency> < / span >
< span class = "nt" > < dependency> < / span >
< span class = "nt" > < groupId> < / span > net.sourceforge.pmd< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > pmd-java< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > ${pmdVersion}< span class = "nt" > < /version> < / span >
< span class = "nt" > < /dependency> < / span >
< span class = "nt" > < dependency> < / span >
< span class = "nt" > < groupId> < / span > net.sourceforge.pmd< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > pmd-javascript< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > ${pmdVersion}< span class = "nt" > < /version> < / span >
< span class = "nt" > < /dependency> < / span >
< span class = "nt" > < dependency> < / span >
< span class = "nt" > < groupId> < / span > net.sourceforge.pmd< span class = "nt" > < /groupId> < / span >
< span class = "nt" > < artifactId> < / span > pmd-jsp< span class = "nt" > < /artifactId> < / span >
< span class = "nt" > < version> < / span > ${pmdVersion}< span class = "nt" > < /version> < / span >
< span class = "nt" > < /dependency> < / span >
< span class = "nt" > < /dependencies> < / span >
< span class = "nt" > < /plugin> < / span >
< span class = "nt" > < /plugins> < / span >
< span class = "nt" > < /pluginManagement> < / span >
< span class = "nt" > < /build> < / span >
...
< span class = "nt" > < /project> < / span >
< / code > < / pre > < / div > < / div >
< h3 id = "reference" > Reference< / h3 >
< p > For more information, please see the well documented PMD plugin project page here:
< a href = "http://maven.apache.org/plugins/maven-pmd-plugin/index.html" > http://maven.apache.org/plugins/maven-pmd-plugin/index.html< / a > .
Also, the bug tracker for this plugin is < a href = "https://issues.apache.org/jira/browse/MPMD" > here< / a > .< / p >
< h2 id = "maven-1" > Maven 1< / h2 >
< div class = "alert alert-danger" role = "alert" > < i class = "fa fa-exclamation-circle" > < / i > < b > Warning:< / b > Apache Maven 1.x has reached its end of life, and is no longer supported. For more information, see the < a href = "http://maven.apache.org/maven-1.x-eol.html" > announcement< / a > . Users are encouraged to migrate to the current version of Apache Maven.< / div >
< p > This section is about the maven 1 PMD plugin.< / p >
< h3 id = "running-the-pmd-plugin-1" > Running the pmd plugin< / h3 >
< h4 id = "generating-a-project-report-1" > Generating a project report< / h4 >
< p > To include the PMD report in the project reports section add the following line under
the reports element in your project.xml:< / p >
< div class = "language-plaintext highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < report> maven-pmd-plugin< /report>
< / code > < / pre > < / div > < / div >
< p > This will add an entry to the ‘ ’ < / p >
< h4 id = "executing-pmd-manually-1" > Executing PMD manually< / h4 >
< p > To run PMD on a Maven project without adding it as a report, simply run< / p >
< div class = "language-plaintext highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > maven pmd xdoc
< / code > < / pre > < / div > < / div >
< p > The PMD plugin writes the report in XML which will then be formatted into more readable HTML.< / p >
< h3 id = "customization-1" > Customization< / h3 >
< h4 id = "changing-rulesets-1" > Changing rulesets< / h4 >
< p > To specify a set of official, built-in rulesets to be used set them in the property
< em > maven.pmd.rulesets< / em > . You can include this setting in your project.properties file.< / p >
< p > A clean strategy for customizing which rules to use for a project is to write a ruleset file.
In this file you can define which rules to use, add custom rules, and
customizing which rules to include/exclude from official rulesets. More information on
writing a ruleset can be found < a href = "pmd_userdocs_making_rulesets.html" > here< / a > .< / p >
< p > Add to the root of your Maven project a pmd.xml file which contains the ruleset mentioned in
the previous paragraph. Add the following property to your project now:< / p >
< div class = "language-plaintext highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > maven.pmd.rulesetfiles = ${basedir}/pmd.xml
< / code > < / pre > < / div > < / div >
< h3 id = "reference-1" > Reference< / h3 >
< p > See the PMD plugin project page here:
< a href = "http://maven.apache.org/maven-1.x/plugins/pmd/" > http://maven.apache.org/maven-1.x/plugins/pmd/< / a > < / p >
< div class = "tags" >
< b > Tags: < / b >
< a href = "tag_userdocs.html" class = "btn btn-default navbar-btn cursorNorm" role = "button" > userdocs< / a >
< a href = "tag_tools.html" class = "btn btn-default navbar-btn cursorNorm" role = "button" > tools< / a >
< / div >
< / div >
< hr class = "shaded" / >
< footer >
< div class = "row" >
< div class = "col-lg-12 footer" >
2021-01-01 05:00:10 +00:00
© 2021 PMD Open Source Project. All rights reserved. < br / >
2021-02-19 08:34:17 +00:00
< span > Page last updated:< / span > March 2020< br / > Site last generated: Feb 19, 2021 < br / >
2020-11-14 09:20:07 +00:00
< p > < img src = "images/pmd-logo-small.png" alt = "Company logo" / > < / p >
< / div >
< / div >
< / footer >
< / div >
<!-- /.row -->
< / div >
<!-- /.container -->
< / div >
< / div >
< / body >
< / html >
