在maven构建期间使用ktlint进行格式化

Question

我对ktlint使用了以下设置，它允许在本地maven构建期间自动格式化所有文件，但如果格式化不正确，则不会触发管道故障：

<plugin>
    <groupId>com.github.gantsign.maven</groupId>
    <artifactId>ktlint-maven-plugin</artifactId>
    <version>1.6.1</version>
    <executions>
        <execution>
        <id>format-and-check</id>
        <goals>
            <goal>format</goal>
            <goal>check</goal>
        </goals>
        </execution>
    </executions>
</plugin>

为了让ktlint在格式不正确时触发管道故障，我将设置更改为

<execution>
    <id>verify-code-style</id>
    <phase>validate</phase>
    <goals>
        <goal>check</goal>
    </goals>
</execution>

这确实会立即触发失败。

但是-现在我不能进行本地maven构建，也不能使用自动格式化。相反，它会立即触发一个失败，需要手动操作，例如Y行上X类中的Needless blank line(s)。

我希望两全其美-在管道中触发失败，并在本地使用自动格式化。有什么方法可以做到这一点吗？

Answer 1

由于您希望与CI在本地的行为有所不同，因此我认为最简单的解决方案是在您本地运行的build命令之前运行format目标。

因此，不需要部署mvn (或包或您运行的任何东西)，只需运行

mvn ktlint:format deploy