Android静态代码代码检测

项目大了，想要让项目自动化管理工具。查阅资料了解到detekt这个可以实现。该库是基于ktLint实现的。

项目官方地址

配置gradle

buildscript {
    repositories {
        google()
        mavenCentral()
        gradlePluginPortal()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:<agp_version>"
    }
}

plugins {
    id "com.android.application"
    id "org.jetbrains.kotlin.android" version "<kotlin_version>"
    id "io.gitlab.arturbosch.detekt" version "1.23.0-RC1"
}

repositories {
    mavenCentral()
}

添加commit hook
在git流中添加代码检测钩子
那么如何在git flow中[添加hook]？(https://www.atlassian.com/git/tutorials/git-hooks)

1. 打开项目所在的Git仓库，并进入项目根目录。
2. 进入.git/hooks目录，这个目录中包含了一些默认的Git Hook模板。
3. 选择你需要添加的Hook类型，例如pre-commit。
4. 将你的Hook脚本文件放置在该目录中，命名为pre-commit（或其他Hook类型的名称）。下面的代码就是pre-commit代码。

#!/usr/bin/env bash
echo "Running detekt check..."
OUTPUT="/tmp/detekt-$(date +%s)"
./gradlew detekt > $OUTPUT
EXIT_CODE=$?
if [ $EXIT_CODE -ne 0 ]; then
  cat $OUTPUT
  rm $OUTPUT
  echo "***********************************************"
  echo "                 Detekt failed                 "
  echo " Please fix the above issues before committing "
  echo "***********************************************"
  exit $EXIT_CODE
fi
rm $OUTPUT

5. 添加可执行权限，使用命令chmod +x pre-commit。
6. 编辑Hook脚本文件，根据需要添加代码，例如运行自动化测试或代码规范检查。
7. 提交你的Hook脚本文件到Git仓库中，可以口头约定手动去操作，但这看起来好傻，我们是程序员，当然懒是第一生产力。
   写一段task执行自动注入pre-commit。

tips：下面的detekt-pre-commit.sample其实就是上面我贴的pre-commit代码。

task detektInit(){
    if(!file("${project.rootDir}/.git/hooks/pre-commit").exists()){
        print("commit hooks not exists,create it")
        copy {
            from "${project.rootDir}/config/detekt/detekt-pre-commit.sample"
            into "${project.rootDir}/.git/hooks/"
            rename { String fileName->
                return "pre-commit"
            }
        }
    }
}

默认的应该是基于ktLint，可以根据自己需要添加对应的规则。
忽略警告排除
baseline

• 也可以直接用官方的rule

下面我列了2个官方规则，
其中下面这个是twitter的compose代码检测规则

detektPlugins "io.gitlab.arturbosch.detekt:detekt-formatting:1.22.0"
detektPlugins "com.twitter.compose.rules:detekt:0.0.26"

另外我们可以通过ktLint官网查看检测规则，输出相应的规则文档。

遇到的哪些坑？

1、根据官方文档添加自定义规则忽略文件

detekt {
        config = files("${project.rootDir}/config/detekt/detekt-config.yml")
 }

平平无奇的代码始终编译报错，路径完全没错。
最后发现是因为文件名中带了中划线 - 导致的，将名字改成detektConfig.yml搞定。

2、如果项目在build文件产生变动的情况下commit的话，会报java文件编译错误。

image.png

对项目进行一次build，就不会出错了，搞定。

3、文件存在依旧报错

image.png

image.png

formatting:
  active: true
  NoTrailingSpaces:
    active: false
    autoCorrect: false
  Indentation:
    active: false
    autoCorrect: false
  NoBlankLineBeforeRbrace:
    active: false
    autoCorrect: false

重新提交

image.png

最终提交通过。
搞定。

4、git commit的时候hooks没有生效？

查看.git\hooks\pre-commit 文件是否为可执行文件。如果不是可执行文件，可能因为编码问题变成了txt文本文件，那么hooks也不会自动执行。