为了活动小家电-代码约定-ktlint(二)

217 阅读2分钟

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的17天,点击查看活动详情

为了活动小家电,接着上篇搞!

官方 Kotlin 编码约定中未指定诸如 max_line_length 和 insert_final_newline 之类的规则。但是,如果在修复同一源代码的同时进行协作的开发人员不统一它,则会出现不必要的差异,从而不方便识别代码更改。

  • 您可以使用 disabled_rules 属性指定不检查的规则。

特别建议此时不要使用导入排序规则。

jlleitschuh/ktlint-gradle 只能与 Gradle 版本 5.4.1 或更高版本一起使用。 在低于该版本的版本中,会出现以下错误。
* What went wrong:
Could not determine the dependencies of task ':ktlintCheck'.
> Could not create task ':ktlintTestSourceSetCheck'.
   > Could not create task of type 'KtlintCheckTask'.
      > Could not generate a decorated class for class org.jlleitschuh.gradle.ktlint.KtlintCheckTask.
         > org/gradle/work/InputChanges
         
在这种情况下,您需要升级 Gradle 的版本。

使用官方编码约定的策略也在 gradle.properites 文件中指定如下。

2.设置gradle.properites

kotlin.code.style=official

3.风格检查

./gradlew ktlintCheck

或直接从 IntelliJ 右侧的 Gradle 选项卡。

4.样式的批量转换

./gradlew ktlintFormat

,或直接从 IntelliJ 右侧的 Gradle 选项卡。

警告

1、上述两种风格检查中,有时会出现构建失败的情况,查看错误日志并处理即可。

2.据说在使用样式批量转换时,有时会无意中删除文件。所以你只需要做 3 次样式检查,或者再看一下转换后的代码。

3.安装保存动作插件

保存操作插件允许您在保存文件时自动运行格式化程序。

  1. 转到文件 > 设置 (Ctrl + Alt + S) > 插件菜单。
  2. 在“市场”选项卡中搜索“保存操作”。
  3. 单击 Save Actions 插件详细说明屏幕上的 [Install] 按钮。
  4. 重新启动 IntelliJ。
  5. 转到文件 > 设置 > 其他设置 > 保存操作菜单。
  6. 检查以下项目(推荐)或其他所需选项。
  • 在保存时激活保存操作
  • 优化导入
  • refmat文件(如果整个项目的风格统一的话)
  • Refmat 只修改了代码(如果项目的风格不统一,修复与风格不匹配的代码,更难识别变化)