PMDの利用手順｜日本語版

 インストールについて

・必要条件

Java 8 以降

zipアーカイバ

・ダウンロード

https://github.com/pmd/pmd/releases/download/pmd_releases%2F7.0.0/pmd-dist-7.0.0-bin.zip

・環境変数の追加

必須ではありませんが、追加すると便利になる

例え、C:\pmd-bin-7.0.0に展開する場合

CMDで追加：SET PATH=C:\pmd-bin-7.0.0\bin;%PATH%

もしくは手動でスタートメニューから環境変数に追加する

基本的なCLIの使用

https://pmd.github.io/pmd/pmd_userdocs_cli_reference.html

-R <path>: 使用するルール・セット・ファイル。

-d <source> …: 分析するソースへのパス。

-f <format>: レポート形式。

--aux-classpath <classpath>: 分析されたJavaソースのコンパイル済みクラス・ファイル(存在する場合)を含むクラス・パス。

・Javaの場合

pmd.bat check -d c:\src -R rulesets/java/quickstart.xml -f csv > [出力パス]\result.csv

・Apexの場合

pmd.bat check -d c:\src -R rulesets/apex/quickstart.xml -f csv > [出力パス]\result.csv

・LWCとVisualForceの場合

ルールセットは自作してから利用します。ルールセットは作成資料：

https://pmd.github.io/pmd/pmd_userdocs_making_rulesets.html#sharing-your-ruleset

https://pmd.github.io/pmd/pmd_rules_ecmascript.html

https://pmd.github.io/pmd/pmd_rules_html.html

https://pmd.github.io/pmd/pmd_rules_visualforce.html