如何通过pom.xml配置jqassistant-maven-plugin生成report报告？

1. 执行mvn jqassistant:report未生成site目录 #

2.0.x版本的插件默认将报告输出到target/jqassistant/report，而非maven标准的site目录。按以下方式调整：

• 直接指定报告输出到site目录：
  在pom.xml的插件配置中添加outputDirectory配置：

  <plugin>
      <groupId>com.buschmais.jqassistant</groupId>
      <artifactId>jqassistant-maven-plugin</artifactId>
      <version>2.0.7</version>
      <configuration>
          <report>
              <!-- 指向maven site默认输出目录 -->
              <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
          </report>
      </configuration>
  </plugin>
  

  执行mvn jqassistant:report后，报告会生成到target/site目录。

• 绑定到site生命周期（自动生成）：
  如果希望执行mvn site时自动触发jqassistant报告生成，添加生命周期绑定配置：

  <plugin>
      <groupId>com.buschmais.jqassistant</groupId>
      <artifactId>jqassistant-maven-plugin</artifactId>
      <version>2.0.7</version>
      <executions>
          <execution>
              <id>jqassistant-generate-report</id>
              <phase>site</phase>
              <goals>
                  <goal>report</goal>
              </goals>
          </execution>
      </executions>
      <configuration>
          <report>
              <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
          </report>
      </configuration>
  </plugin>
  

  之后执行mvn clean site即可自动生成包含jqassistant报告的site目录。

2. 旧版本xmlReportFile配置迁移到jqassistant.yml #

旧pom中的xmlReportFile配置在2.x版本需移至jqassistant.yml的reporting节点下，具体格式如下：

reporting:
  reports:
    Xml:
      file: ${project.build.directory}/custom-path/jqassistant-report.xml

• 注意事项：
  • YAML对缩进敏感，确保层级缩进正确（每个子节点比父节点多2个空格）。
  • ${project.build.directory}会被maven自动替换为项目的target目录，也可直接填写绝对路径。
  • 若插件未自动识别yml文件，在pom.xml中显式指定配置文件路径：

    <plugin>
        <groupId>com.buschmais.jqassistant</groupId>
        <artifactId>jqassistant-maven-plugin</artifactId>
        <version>2.0.7</version>
        <configuration>
            <configurationFile>src/main/resources/jqassistant.yml</configurationFile>
        </configuration>
    </plugin>
    

内容的提问来源于stack exchange，提问作者Gandora