如何使用ktfmtFormat格式化项目Kotlin文件?求Windows命令行脚本
使用ktfmt Gradle插件批量格式化Windows上Android项目的Kotlin文件
1. 配置ktfmt Gradle插件
首先在项目根目录的build.gradle(Groovy语法)或build.gradle.kts(Kotlin语法)中添加插件依赖:
Groovy 版本
plugins { id "com.facebook.ktfmt" version "0.41" // 可替换为最新稳定版本 }
Kotlin DSL 版本
plugins { id("com.facebook.ktfmt") version "0.41" }
可选:自定义格式化规则(比如切换风格、指定文件范围),在根目录构建文件中添加:
ktfmt { style = "google" // 可选值:facebook(默认)、google include("**/*.kt") // 匹配所有Kotlin文件 exclude("**/build/**", "**/generated/**") // 排除构建目录和自动生成的文件 }
2. 批量格式化的命令行方式
方式1:直接在命令行执行
打开项目根目录(和gradlew.bat同路径),在CMD或PowerShell中输入:
gradlew ktfmtFormat
方式2:编写Windows批处理脚本(一键执行)
在项目根目录创建format_kotlin.bat文件,内容如下:
@echo off echo 正在批量格式化所有Kotlin文件... call gradlew ktfmtFormat echo 格式化完成! pause
双击该批处理文件即可自动执行格式化操作。
注意事项
- 确保项目根目录存在
gradlew.bat(Android Studio创建的项目默认自带),无需额外安装Gradle - 首次运行会自动下载ktfmt插件依赖,耗时稍长
- 格式化会直接修改文件内容,建议先提交代码到版本控制系统,避免意外修改丢失
内容的提问来源于stack exchange,提问作者Kaleab Woldemariam
相关产品推荐
相关产品推荐

