Kotlin 静态代码检查（ktlint）

最新推荐文章于 2025-04-01 14:03:41 发布

一翼诚-Hokings

最新推荐文章于 2025-04-01 14:03:41 发布

阅读量1k

点赞数

分类专栏： gradle Android Kotlin 文章标签： kotlin android 代码规范 intellij idea

本文链接：https://blog.youkuaiyun.com/Michael_hejing/article/details/115905640

版权

Android 同时被 3 个专栏收录

11 篇文章

订阅专栏

gradle

2 篇文章

订阅专栏

Kotlin

1 篇文章

订阅专栏

本文介绍如何使用ktlint进行Kotlin代码风格检查及格式化。包括配置Gradle任务以运行ktlint，以及如何修复代码样式偏差。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Kotlin 静态代码检查（ktlint）

Plugins

ktlint主页：https://ktlint.github.io/
ktlintGitHub：https://github.com/pinterest/ktlint
ktlint插件：https://plugins.jetbrains.com/plugin/15057-ktlint-unofficial-

Without Plugins

Add the following snippet to build.gradle

apply plugin: "java"

repositories {
    jcenter()
}

configurations {
    ktlint
}

dependencies {
    ktlint "com.pinterest:ktlint:0.41.0"
    // additional 3rd party ruleset(s) can be specified here
    // just add them to the classpath (ktlint 'groupId:artifactId:version') and 
    // ktlint will pick them up
}

task ktlint(type: JavaExec, group: "verification") {
    description = "Check Kotlin code style."
    main = "com.pinterest.ktlint.Main"
    classpath = configurations.ktlint
    args "src/**/*.kt"
    // to generate report in checkstyle format prepend following args:
    // "--reporter=plain", "--reporter=checkstyle,output=${buildDir}/ktlint.xml"
    // see https://github.com/pinterest/ktlint#usage for more
}
check.dependsOn ktlint

task ktlintFormat(type: JavaExec, group: "formatting") {
    description = "Fix Kotlin code style deviations."
    main = "com.pinterest.ktlint.Main"
    classpath = configurations.ktlint
    args "-F", "src/**/*.kt"
}

Usage

# check code style (it's also bound to "gradle check")
$ gradle ktlint
  src/main/kotlin/Main.kt:10:10: Unused import
  
# fix code style deviations (runs built-in formatter)
$ gradle ktlintFormat