Kotlin 代码格式化 ktfmt

[xuxiaowei]

源码

• GitHub - facebook/ktfmt: A program that reformats Kotlin source code to comply with the common community standard for Kotlin code conventions.

要求

• JDK 11+

基于 brew 安装与使用

安装

brew install ktfmt

使用

• 代码不规范示例：

  

• 执行命令

  # 最后的 app 可以是文件（夹），支持多个文件（夹）
  ktfmt --kotlinlang-style app
  

• 格式化结果

  

手动 安装与使用

• 下载：Releases · facebook/ktfmt · GitHub
  • 需要下载：ktfmt-*.*-with-dependencies.jar
• 执行命令

  # 最后的 app 可以是文件（夹），支持多个文件（夹）
  java -jar ktfmt-0.61-with-dependencies.jar --kotlinlang-style app
  

Android 项目 配置与使用

gradle/libs.versions.toml

[versions]
ktfmt = "0.25.0"

[plugins]
ktfmt = { id = "com.ncorti.ktfmt.gradle", version.ref = "ktfmt" }

build.gradle.kts

plugins {
    alias(libs.plugins.ktfmt) apply false
}

app/build.gradle.kts

plugins {
    alias(libs.plugins.ktfmt)
}

ktfmt { kotlinLangStyle() }

使用

gradle ktfmtFormat --rerun-tasks

gradle ktfmtFormatTest --rerun-tasks

gradle ktfmtFormatAndroidTest --rerun-tasks

gradle ktfmtFormatMain --rerun-tasks

更多命令

gradle tasks | grep ktfmt