Spotless 代码格式化的配置和使用
2022-04-28 本文已影响0人
zhongjh
简洁
- Spotless 是一个代码格式化工具。
- 它支持的开发语言有java, kotlin, scala, sql, javascript, css, json, yaml, etc。
- 它可以提示哪里不规范,同时也支持自动修正(其实就是批量的将所有类格式化)
- 支持maven|gradle plugin等插件
这里我们对AndroidStudio的gradle-plugin,并且支持Kotlin进行使用教程
环境:AndroidStudio 2021.1.1版本
1. 首先在build.gradle中引入spotless 插件
buildscript {
repositories {
······
}
dependencies {
······
classpath "com.diffplug.spotless:spotless-plugin-gradle:$versions.spotlessGradle"
}
}
在各自的modulebuild.gradle加入该代码
plugins {
······
}
apply from: "$rootDir/spotless.gradle"
2. 看看spotless.gradle该文件什么内容
放在根目录
image.png
apply plugin: "com.diffplug.spotless"
spotless {
kotlin {
target "**/*.kt"
ktlint('0.43.0').userData(['indent_size': '2', 'continuation_indent_size': '2'])
trimTrailingWhitespace()
endWithNewline()
}
}
还能严格控制检查顶部是否有许可代码,具体可以看demo如何写
3. 配置好了,让我们直接使用
点开菜单,如图
image.png
检测某个module,点开相应的module即可。
会发现有如下命令
image.png
点击即可,当然,也可以在命令行输入相关命令即可
// 做代码检查
gradlew spotlessKotlinCheck
// 自动格式化
gradlew spotlessKotlinApply