
Spotless使用方法
Spotless 是什么?
Spotless是一款高效的代码格式化工具。它可以帮助开发者保持代码的整洁和一致性,提高代码的可读性和易维护性。
它支持多种编程语言,包括Java、Kotlin、JavaScript等,并提供了丰富的配置选项,可以根据开发者的需求定制代码格式化规则。
为什么要用Spotless?
使用Spotless的原因很多。首先,它可以帮助您维持一致的代码风格,使团队成员更容易阅读和理解代码。其次,它可以自动修复许多常见的代码格式问题,提高了开发效率。
项目地址
使用方法
添加插件
Gradle官网
我现在使用的都是VersionCatalog
+KTS
了,暂时只介绍VersionCatalog
+KTS
的方式了
- 在Toml文件中添加插件声明
- 在工程的
build.gradle.kts
中添加
- 在模块的
build.gradle.kts
中添加,以及配置spotless
使用
使用起来也非常简单,主要就两条命令
检查校验代码风格
在项目根目录下执行
执行完之后,如果有问题会报错并列出异常代码的位置
自动修复代码风格
在项目根目录下执行
执行完之后,会自动更正代码风格有问题的地方
使用Git hooks自动格式化代码
- 在项目目录添加
.hooks
目录,并添加pre-commit
文件,内容如下所示
- 在项目级的
build.gradle.kts
中添加一下copyHooks
的任务,把钩子文件复制到.git/hooks
里面去
- 双击Ctrl键,执行
gradle copyHooks
即可,以后每一次提交代码的时候,会自动检查代码风格,如果代码风格有问题,会自动格式化,然后需要重新Review
完代码之后再重新提交
参考
本文是原创文章,采用 CC BY-NC-ND 4.0 协议,完整转载请注明来自 EmccK
评论
匿名评论
隐私政策
你无需删除空行,直接评论以获取最佳展示效果