第33章 PMDプラグイン

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

PMDプラグインは PMDを使用して、あなたのプロジェクトのJavaソースファイルの品質チェックを行ないます。そして、これらのチェック結果から結果レポートを生成します。

33.1. 使用方法Usage

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

PMDプラグインを使うためには、ビルドスクリプトに下記を含めます：

例33.1 PMDプラグインの使用

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.

このプラグインは、品質チェックを行なうプロジェクトへの多くのタスクを加えます。貴方はタスク実行時にチェック処理を実行させることが出来ます。 gradle check.

The PMD plugin adds the following tasks to the project:

PMDプラグインは、以下のタスクをプロジェクトに追加します:

表33.1 PMDプラグイン - タスクPMD plugin - tasks

タスク名Task name	依存先Depends on	型Type	説明Description
`pmdMain`	-	`Pmd`	製品のJavaソースを対象にPMDを実行します。Runs PMD against the production Java source files.
`pmdTest`	-	`Pmd`	テストのJavaソースを対象にPMDを実行します。Runs PMD against the test Java source files.
`pmdSourceSet`	-	`Pmd`	特定のソースセットで指定されたJavaソースを対象に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.

PMDプラグインは、Javaプラグインによって追加されたタスクに以下の依存関係を追加します。

表33.2 PMDプラグイン - タスクの追加依存関係PMD plugin - additional task dependencies

タスク名Task name	依存先Depends on
`check`	全てのPMDタスクは、`pmdMain` と `pmdTest`を含みます。All PMD tasks, including `pmdMain` and `pmdTest`.

The PMD plugin adds the following dependency configurations:

PMDプラグインは、以下の依存関係設定を追加します。

表33.3 PMDプラグイン - 依存関係設定

PMD plugin - dependency configurations

名前 Name	意味 Meaning
`pmd`	PMDのライブラリを使用します。 The PMD libraries to use

See the PmdExtension class in the API documentation.