JLLeitschuh/ktlint-gradle

これは何？

主な機能

• 01すべてのソースセットとKotlinスクリプト向けにktlintCheckとktlintFormatタスクを追加します。
• 02kotlin、kotlin-android、kotlin-multiplatform、Kotlin JSの各プロジェクトをサポートします。
• 03baselineファイルを使って既存のLint違反を抑制できます。
• 04カスタムreporterとktlintのカスタムrulesetに対応します。
• 05ステージング済みファイルに対してcheckまたはformatを実行するGit pre-commit hookをインストールできます。

ユースケース

• AndroidまたはJVMのGradleビルドで、Kotlinのコードスタイルを統一する。
• ビルドロジックを手作業で変更せずに、マルチプラットフォームKotlinプロジェクトへLintチェックを追加する。
• baselineを使い、既存のコードベースにLintを段階的に導入する。
• ktlintCheckタスクを使って、CIでスタイルチェックを実行する。

クイックスタート

1. 1

   ビルドスクリプトのpluginsブロックにプラグインを追加します（バージョンには現行リリースを指定）

2. 2

   KtLintをダウンロードできるように、repositoriesにmavenCentral()を追加します

3. 3

   プロジェクトでGradleのktlintタスクを実行します

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

• !このプラグインは、対応するKotlinプラグインを適用したプロジェクトでのみ有効になります。
• !Gradle 7.4以降、Kotlin 1.4以降が必要です。

トピック

よくある質問

ktlint-gradle とは？

Kotlinプロジェクトにチェックと自動フォーマットのタスクを追加する、ktlintをラップしたGradleプラグイン。 ktlint-gradleは、Kotlin用リンター兼フォーマッターのktlintをラップするGradleプラグインです。Gradleビルドにすぐ使えるタスクを追加するため、手動で設定しなくてもコードスタイルをチェックして修正できます。Kotlinプラグインを適用したプロジェクトでのみ有効になり、任意のファイルではなくKotlinコードを対象にします。

ktlint-gradle は無料で使えますか？ライセンスは？

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

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

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

ktlint-gradle は何に使えますか？

AndroidまたはJVMのGradleビルドで、Kotlinのコードスタイルを統一する。 ビルドロジックを手作業で変更せずに、マルチプラットフォームKotlinプロジェクトへLintチェックを追加する。 baselineを使い、既存のコードベースにLintを段階的に導入する。 ktlintCheckタスクを使って、CIでスタイルチェックを実行する。

ktlint-gradle のインストール方法は？

ビルドスクリプトのpluginsブロックにプラグインを追加します（バージョンには現行リリースを指定） KtLintをダウンロードできるように、repositoriesにmavenCentral()を追加します プロジェクトでGradleのktlintタスクを実行します

ktlint-gradle はどこで入手できますか？

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