如何使 tidy-maven-plugin 和 Spotless-maven-plugin 忽略 pom.xml 中的注释格式或以相同的方式执行?

问题描述 投票:0回答:1

我正在尝试使用 Maven 插件来进行

pom.xml
验证,
因为我们的项目 pom.xml 处于被忽视的状态,没有格式化等。

我发现spotless可以通过下面的配置来完成

mvn spotless:apply

https://www.mojohaus.org/tidy-maven-plugin/

mvn tidy:pom
.

问题:虽然两者都很好并指出了一些问题, 并同意有意义的 pom.xml 内容,
他们对于如何写评论存在分歧(我真的不想严格要求)

spotless 希望多行注释块像这样开始

<plugin>   
<!--

和 整洁的需求排成 1 行

<plugin><!--

问题:如何让这些插件忽略评论格式 还是用同样的方法做?

      <!-- mvn spotless:check by default is mapped to mvn verify (verify lifecycle phase)-->
      <plugin>
        <groupId>com.diffplug.spotless</groupId>
        <artifactId>spotless-maven-plugin</artifactId>
        <version>2.30.0</version>
        <configuration>
          <java>
            <googleJavaFormat></googleJavaFormat>
          </java>
          <pom>
            <sortPom>
              <!-- see https://github.com/diffplug/spotless/blob/main/plugin-maven/README.md#sortpom -->
            </sortPom>
          </pom>
        </configuration>
        <executions>
          <execution>
            <goals>
              <goal>check</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
maven validation pom.xml spotless-maven-plugin
1个回答
0
投票

Spotless 使用

sortpom-maven-plugin
对 pom 文件进行排序。 Sortpom 将整个文件解析为 xml 内容,并从该 xml 结构重新生成文件。有关行号和单独格式的大多数信息都会在此过程中丢失,包括格式化的注释。也就是说,它将注释视为任何其他 xml 内容。 有多种方法可以使用 Sortpom 忽略 pom 文件中的部分,请参阅 SORTPOM IGNORE,但我不知道它是否适用于您的用例。

© www.soinside.com 2019 - 2024. All rights reserved.