JLLeitschuh/ktlint-gradle

这是什么？

核心功能

• 01为所有 source set 和 Kotlin 脚本添加 ktlintCheck、ktlintFormat 任务。
• 02支持 kotlin、kotlin-android、kotlin-multiplatform 和 Kotlin JS 项目。
• 03可通过 baseline 文件忽略已有的代码风格问题。
• 04支持自定义 reporter 与自定义 ktlint 规则集。
• 05可安装 Git pre-commit 钩子，对暂存文件执行检查或格式化。

适用场景

• 在 Android 或 JVM Gradle 构建中统一 Kotlin 代码风格。
• 为 Kotlin Multiplatform 项目添加代码检查，无需手动编写构建逻辑。
• 借助 baseline 逐步在已有代码库中引入代码检查。
• 通过 ktlintCheck 任务在 CI 中执行风格检查。

快速上手

1. 1

   在构建脚本的 plugins 块中添加该插件（版本号设为当前发布版本）

2. 2

   在 repositories 中添加 mavenCentral()，以便下载 KtLint

3. 3

   在项目中运行 Gradle 的 ktlint 任务

使用前须知

• !该插件仅在应用了受支持的 Kotlin 插件的项目中生效。
• !它要求 Gradle 7.4 或更高版本，以及 Kotlin 1.4 或更高版本。

标签

常见问题

ktlint-gradle 是什么？

为 Kotlin 项目添加 ktlint 代码检查与自动格式化任务的 Gradle 插件。 ktlint-gradle 是对 ktlint Kotlin 代码检查与格式化工具的 Gradle 封装插件。它在构建中自动添加现成的任务，无需手动配置即可检查并修复代码风格。插件只在项目应用了 Kotlin 插件时生效，专门针对 Kotlin 代码。

ktlint-gradle 可以免费使用吗？用的什么许可证？

ktlint-gradle 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。

ktlint-gradle 还在维护吗？

活跃维护中。ktlint-gradle 最近一次提交是在 2026年11月6日。

ktlint-gradle 适合用来做什么？

在 Android 或 JVM Gradle 构建中统一 Kotlin 代码风格。 为 Kotlin Multiplatform 项目添加代码检查，无需手动编写构建逻辑。 借助 baseline 逐步在已有代码库中引入代码检查。 通过 ktlintCheck 任务在 CI 中执行风格检查。

ktlint-gradle 怎么安装和运行？

在构建脚本的 plugins 块中添加该插件（版本号设为当前发布版本） 在 repositories 中添加 mavenCentral()，以便下载 KtLint 在项目中运行 Gradle 的 ktlint 任务

在哪里获取 ktlint-gradle？

源代码和安装说明在 GitHub 上：https://github.com/JLLeitschuh/ktlint-gradle