Git 预提交脚本中使用 ktlintCheck 和 ktlintFormat 的完整指南：自动化代码检查和格式化

2024-03-08 18:30:26

在 Git Pre-Commit 脚本中使用 ktlintCheck 和 ktlintFormat 的完整指南

引言

对于使用 Kotlin 开发的项目，维护代码样式和质量至关重要。ktlint 是一种流行的 Kotlin 代码分析工具，可帮助确保代码符合既定的约定。在 Git 预提交钩子脚本中集成 ktlint，可以自动化代码格式化和检查流程，确保在代码提交到存储库之前符合标准。本文将深入探讨如何使用 ktlintCheck 和 ktlintFormat 任务，并详细介绍在 Git 预提交脚本中使用它们的步骤。

使用 ktlintCheck 和 ktlintFormat 任务

创建自定义 Gradle 任务

由于 Git 预提交脚本不能直接访问 Gradle 任务，因此需要创建一个自定义 Gradle 任务来执行 ktlint 检查和格式化操作。在项目的 build.gradle 文件中添加以下代码：

task customKtlintCheckAndFormat(type: org.jlleitschuh.gradle.ktlint.tasks.BaseKtLintCheckTask) {
    group = 'Verification'
    description = 'Runs ktlint check and format on changed files'
}

修改预提交脚本

在 Git 预提交脚本中，更新 Gradle 命令以调用自定义任务，而不是直接调用 ktlintCheck 任务。例如：

./gradlew --stacktrace customKtlintCheckAndFormat

添加过滤器

为了仅检查和格式化已暂存的 Kotlin 文件，请在脚本中添加以下行：

-PinternalKtlintGitFilter="$CHANGED_FILES"

示例脚本

以下是完整的 Git 预提交脚本示例：

#!/bin/sh
######## KTLINT-GRADLE HOOK START ########

CHANGED_FILES="$(git --no-pager diff --name-status --no-color --cached | awk '$1 != "D" && $NF ~ /\.kts?$/ { print $NF }')"

if [ -z "$CHANGED_FILES" ]; then
    echo "No Kotlin staged files."
    exit 0
fi;

echo "Running ktlint over these files:"
echo "$CHANGED_FILES"

diff=.git/unstaged-ktlint-git-hook.diff
git diff --color=never > $diff
if [ -s $diff ]; then
  git apply -R $diff
fi

./gradlew --stacktrace customKtlintCheckAndFormat -PinternalKtlintGitFilter="$CHANGED_FILES"
gradle_command_exit_code=$?

echo "Completed ktlint run."

if [ -s $diff ]; then
  git apply --ignore-whitespace $diff
fi
rm $diff
unset diff

echo "Completed ktlint hook."
exit $gradle_command_exit_code
######## KTLINT-GRADLE HOOK END ########