diffplug/spotless

これは何？

主な機能

• 01spotlessCheckとspotlessApplyタスクでフォーマットをチェックし、自動修正します。
• 02Java、Kotlin、Groovy、Scala、JavaScript、TypeScript、SQL、YAML、Markdownなどに対応しています。
• 03google-java-format、ktlint、Prettier、Black、clang-formatなどのフォーマッターを利用できます。
• 04Gitのrefを基準に段階的にフォーマットし、変更されたファイルだけを処理します。
• 05正規表現による置換、空白の削除、ライセンスヘッダーの追加に使える汎用ステップを備えています。

ユースケース

• CIで、多言語対応のJavaまたはKotlinのモノレポ全体に一貫したコードスタイルを適用する。
• ローカルで開発しながら、プルリクエストで変更されたファイルだけを自動フォーマットする。
• ビルド内のすべてのソースファイルにライセンスヘッダーを追加したり、importの順序を整えたりする。
• アプリケーションコードとあわせて、SQL、YAML、Markdownを1つのツールでフォーマットする。

クイックスタート

1. 1

   plugin-gradle または plugin-maven ガイドに従って、Gradle または Maven のビルドに Spotless プラグインを追加する

2. 2

   Gradle でフォーマットを適用する

   ./gradlew spotlessApply
3. 3

   Maven でフォーマットを適用する

   mvn spotless:apply

使う前に知っておきたいこと

• !公式サポートの対象は Gradle と Maven のみです。SBT との連携は外部提供です。
• !機能やフォーマッターのサポート状況はビルドツールによって異なるため、一部の手順は Gradle でのみ利用できます。

収録されている特集

トピック

よくある質問

spotless とは？

GradleとMaven向けのビルドプラグインフレームワーク。多くの言語やファイル形式に対応したフォーマッターとリンターを実行します。 Spotlessは、プロジェクトのソースファイルにコードフォーマッターを適用し、フォーマットされていないファイルがあるとビルドを失敗させるビルドツール用プラグインです。GradleとMavenで利用でき、SBTプラグインは別途メンテナンスされています。spotlessApplyのような単一のコマンドを実行すると、ルールに違反するファイルを書き換えます。spotlessCheckは違反を報告するため、CIでフォーマットを徹底できます。

spotless は無料で使えますか？ライセンスは？

spotless は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

spotless は今もメンテナンスされていますか？

活発にメンテナンス中。spotless の最終コミットは 2026年11月2日 です。

spotless は何に使えますか？

CIで、多言語対応のJavaまたはKotlinのモノレポ全体に一貫したコードスタイルを適用する。 ローカルで開発しながら、プルリクエストで変更されたファイルだけを自動フォーマットする。 ビルド内のすべてのソースファイルにライセンスヘッダーを追加したり、importの順序を整えたりする。 アプリケーションコードとあわせて、SQL、YAML、Markdownを1つのツールでフォーマットする。

spotless のインストール方法は？

plugin-gradle または plugin-maven ガイドに従って、Gradle または Maven のビルドに Spotless プラグインを追加する Gradle でフォーマットを適用する: ./gradlew spotlessApply Maven でフォーマットを適用する: mvn spotless:apply

spotless はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/diffplug/spotless