Maven 2 Checkstyle 配置位置

Question

我有一个项目，它有一个 jar 文件作为 maven 依赖项，其中包含一个 xml 文件，我在其中存储了我的 checkstyle 规则。 我认为只使用这个配置就可以了：

<configLocation>mycheckstyle.xml</configLocation>

我的理解是应该在类路径上搜索该文件，并且我的 jar 文件是 Maven 依赖项，因此应该可以找到它，但是我得到一个资源未找到异常。

有什么建议吗？

Answer 1

尝试将依赖项部分添加到您的插件配置中。

例如，

  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <dependencies>
      <dependency>
        <groupId>com.example.whizbang</groupId>
        <artifactId>build-tools</artifactId>
        <version>1.0</version>
      </dependency>
    </dependencies>
  </plugin>

有关更多信息，请参阅Maven Checkstyle 插件 - 多模块配置。

Answer 2

如果您有一个本地 Maven 存储库用于您自己创建和编译的检查，请注意不要忘记定义

<repositories>
    <repository>
        <id>my local repository</id>
        <url>file:${basedir}/.m2artifacts</url>
    </repository>
    <!-- ... -->
</repositories>

但也

<pluginRepositories>
    <pluginRepository>
        <id>my local repository</id>
        <url>file:${basedir}/.m2artifacts</url>
    </pluginRepository>
    <!-- ... -->
</pluginRepositories>

否则插件依赖只会在中央 maven repo 中查找，但不会找到带有检查类的本地 JAR 文件

Answer 3

如Checkstyle 插件页面所述，

配置位置：

指定要使用的 XML 配置的位置。

可能的值是文件系统路径、URL或类路径资源。

我从来没有在我的项目中这样做过......

当 checkstyle 插件启动时，您确定包含 XML 文件的 JAR 位于类路径中吗？

Answer 4

我有一个父级，它指定了 checkstyle 插件，并在其资源文件夹中包含了相应的 mycheckstyle.xml。 我使用 Maven 程序集插件制作我父母资源文件夹的 jar 并将该 jar 定义为我孩子的依赖项。 因此，当子级继承 checkstyle 插件 + 它是父级的配置时，它应该能够找到 mycheckstyle.xml。 我已按照 checkstyle 插件页面上的说明进行操作，但没有奏效。