使用 PMD Maven 分析 Javascript

Question

我目前正在尝试将 PMD 作为我们公司可以使用的一种可能的静态分析工具。我已经分析了 Java 文件，没有任何问题，但我似乎无法用 Javascript 来做，每次我执行 pmd:pmd 它只是再次分析 java 文件。无论如何，这是我的 POM.xml 的 sn-p：

*使用 Maven 3.3.1

<build>
  <plugins>
    <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>build-helper-maven-plugin</artifactId>
        <version>3.0.0</version>
        <configuration>
        <sources>
            ${basedir}/src/main/webapp/js
        </sources>
        </configuration>
        <executions>
            <execution>
                <goals>
                    <goal>add-source</goal>
                </goals>
            </execution>
        </executions>
    </plugin>
  </plugins>
</build>

<reporting>
  <plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-pmd-plugin</artifactId>
        <version>3.7</version>
        <configuration>
        <language>javascript</language>
        <rulesets>
            <ruleset>ecmascript-basic</ruleset>
            <ruleset>ecmascript-braces</ruleset>
            <ruleset>ecmascript-unnecessary</ruleset>
        </rulesets>
        <includes>
            <include>**/*.js</include>
        </includes>
        </configuration>
    </plugin>
 </plugins>
</reporting>

所以我只是按照this 中指示的说明进行操作，但似乎无法使其工作。你们能告诉我是否缺少一些必需的设置/配置吗？ TIA。

Answer 1

您的配置是正确的（假设缺少 <plugins> 标记只是编辑问题）。很可能您没有运行正确的 Maven 目标。

使用您当前的配置，PMD 将在站点生成期间作为报告运行，即mvn site。但是，如果这样做，build-helper-maven-plugin:add-source 目标将不会运行，并且不会找到源。

解决这个问题的最基本（无用）方法就是调用mvn generate-sources site。

您可以通过如下更改插件配置让add-source 在mvn site 上自动运行：

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>build-helper-maven-plugin</artifactId>
            <version>3.0.0</version>
            <executions>
                <execution>
                    <id>config-js</id>
                    <phase>pre-site</phase>
                    <goals>
                        <goal>add-source</goal>
                    </goals>
                    <configuration>
                        <sources>${basedir}/src/main/javascript</sources>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

在这里，phase 设置为 pre-site 具有将执行挂钩到 site 生命周期开头的魔力。

如果您希望能够使用mvn pmd:pmd 或mvn pmd:check 运行PMD，那么您的配置应该稍有不同。 PMD 插件不应该是<reporting> 部分的一部分，而是<build> 的一部分。不幸的是，PMD maven 插件不会将自己与生命周期事件挂钩，因此在这种情况下，我们必须手动确保 build-helper-maven-plugin:add-source 已运行。再一次，我们可以使用mvn generate-sources pmd:pmd