ソースコードのフォーマットチェック（Gradle Plugin）

spotless plugin

ソースコードなどのフォーマットチェックおよびフォーマッットを行うタスクを提供するプラグイン

Github

以下の言語のフォーマットに対応している

• Java (google-java-format, eclipse jdt, clang-format, prettier, palantir-java-format)
• Groovy (eclipse groovy)
• Kotlin (ktfmt, ktlint, diktat, prettier)
• Scala (scalafmt)
• C/C++ (clang-format, eclipse cdt)
• Python (black)
• FreshMark aka markdown
• Antlr4 (antlr4formatter)
• SQL (dbeaver, prettier)
• Typescript (tsfmt, prettier)
• JSON

プラグインの導入

build.gradleに以下の記述を追加

plugins {
    id "com.diffplug.gradle.spotless" version "6.7.0"
}

プラグインの設定

build.gradleに以下の記述を追加

spotless {

  java {
    // eclipseのフォーマッタ設定xmlを使用してフォーマット
    eclipse().configFile project.file("eclipse-format-setting.xml")
  }
}

タスクの実行

# フォーマットチェック
gradlew spotlessCheck

# フォーマット適用
gradlew spotlessApply