Chapter 62. The JDepend Plugin

Table of Contents

62.1. Usage
62.2. Tasks
62.3. Dependency management
62.4. Configuration

The JDepend plugin performs quality checks on your project's source files using JDepend and generates reports from these checks.

62.1. Usage

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

Example 62.1. Using the JDepend plugin


apply plugin: 'jdepend'

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 JDepend will run with the same Java version used to run Gradle.

62.2. Tasks

The JDepend plugin adds the following tasks to the project:

Table 62.1. JDepend plugin - tasks

Task name Depends on Type Description
jdependMain classes JDepend Runs JDepend against the production Java source files.
jdependTest testClasses JDepend Runs JDepend against the test Java source files.
jdependSourceSet sourceSetClasses JDepend Runs JDepend against the given source set's Java source files.

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

Table 62.2. JDepend plugin - additional task dependencies

Task nameDepends on
check All JDepend tasks, including jdependMain and jdependTest.

62.3. Dependency management

The JDepend plugin adds the following dependency configurations:

Table 62.3. JDepend plugin - dependency configurations

Name Meaning
jdepend The JDepend libraries to use

62.4. Configuration

See the JDependExtension class in the API documentation.