在代码提交时自动检测格式化代码

670 阅读1分钟

使用spotless插件可以在代码提交时自动检测格式化代码。在git commit之前,会执行gradlew spotlessApply,进行代码的自动格式化。既不需要每个人设置IDE,也可以避免未经格式化的代码提交。

插件引入

plugins {
    id 'com.diffplug.spotless' version '5.0.0'
}

apply plugin: "com.diffplug.gradle.spotless"

插件配置

spotless {
    kotlin {
        target "**/*.kt"
        ktlint('0.33.0').userData(['indent_size': '2', 'continuation_indent_size' : '2'])
    }
    java {
        target "**/*.java"
        googleJavaFormat()
        indentWithSpaces(2)
        trimTrailingWhitespace()
        removeUnusedImports()
    }
}

插件命令

./gradlew spotlessApply