Chapter 64. The PMD Plugin

Table of Contents

64.1. Usage
64.2. Tasks
64.3. Dependency management
64.4. Configuration

The PMD plugin performs quality checks on your project’s Java source files using PMD and generates reports from these checks.

64.1. Usage

To use the PMD plugin, include the following in your build script:

Example 64.1. Using the PMD plugin

build.gradle

apply plugin: 'pmd'

The plugin adds a number of tasks to the project that perform the quality checks. You can execute the checks by running gradle check.

Note that PMD will run with the same Java version used to run Gradle.

64.2. Tasks

The PMD plugin adds the following tasks to the project:

Table 64.1. PMD plugin - tasks

Task name Depends on Type Description

pmdMain

-

Pmd

Runs PMD against the production Java source files.

pmdTest

-

Pmd

Runs PMD against the test Java source files.

pmdSourceSet

-

Pmd

Runs PMD against the given source set’s Java source files.

The PMD plugin adds the following dependencies to tasks defined by the Java plugin.

Table 64.2. PMD plugin - additional task dependencies

Task name Depends on

check

All PMD tasks, including pmdMain and pmdTest.

64.3. Dependency management

The PMD plugin adds the following dependency configurations:

Table 64.3. PMD plugin - dependency configurations

Name Meaning

pmd

The PMD libraries to use

64.4. Configuration

See the PmdExtension class in the API documentation.