git: pre-commit-hook: python + nodejs:如何配置

基础概念

pre-commit-hook 是 Git 中的一个钩子脚本，它在提交之前执行，用于检查代码质量、运行测试或其他自定义任务。通过配置 pre-commit-hook，可以在代码提交前自动执行一系列检查，确保代码质量和一致性。

相关优势

1. 代码质量提升：在提交前自动运行代码检查和测试，可以及时发现并修复问题。
2. 一致性保证：确保所有提交的代码都符合团队的编码规范。
3. 自动化流程：减少手动执行检查的工作量，提高开发效率。

类型

pre-commit-hook 可以是任何可执行脚本，常见的类型包括：

• Python 脚本：用于执行代码检查、静态分析等。
• Node.js 脚本：用于运行测试、格式化代码等。
• Shell 脚本：用于执行系统命令或组合多个工具。

应用场景

1. 代码格式化：在提交前自动格式化代码，确保代码风格一致。
2. 代码检查：运行 ESLint、Pylint 等工具检查代码中的潜在问题。
3. 单元测试：在提交前运行单元测试，确保代码的正确性。
4. 依赖检查：检查项目依赖是否最新，是否存在安全漏洞。

配置步骤

以下是一个配置 pre-commit-hook 的示例，结合 Python 和 Node.js 脚本：

1. 创建 pre-commit 文件

在项目的 .git/hooks 目录下创建一个名为 pre-commit 的文件，并确保其具有可执行权限。

touch .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

2. 编写 pre-commit 脚本

编辑 .git/hooks/pre-commit 文件，添加以下内容：

#!/bin/sh

# 运行 Python 代码检查
python scripts/run_pylint.py

# 运行 Node.js 单元测试
node scripts/run_tests.js

# 如果前面的命令有任何失败，退出并返回非零状态码
if [ $? -ne 0 ]; then
    echo "Pre-commit checks failed. Please fix the issues before committing."
    exit 1
fi

3. 编写 Python 和 Node.js 脚本

假设你有一个 scripts 目录，其中包含 run_pylint.py 和 run_tests.js 文件。

run_pylint.py:

import subprocess

def run_pylint():
    result = subprocess.run(['pylint', 'src'], capture_output=True, text=True)
    if result.returncode != 0:
        print(result.stdout)
        print(result.stderr)
        raise Exception("Pylint check failed")

if __name__ == "__main__":
    run_pylint()

run_tests.js:

const { execSync } = require('child_process');

try {
    execSync('npm test', { stdio: 'inherit' });
} catch (error) {
    console.error('Unit tests failed');
    process.exit(1);
}

常见问题及解决方法

问题：pre-commit 脚本没有执行

原因：可能是 .git/hooks/pre-commit 文件没有可执行权限，或者文件内容为空。

解决方法：

chmod +x .git/hooks/pre-commit

确保文件内容不为空，并且脚本路径和命令正确。

问题：Python 或 Node.js 脚本执行失败

原因：可能是脚本路径错误、依赖缺失或脚本本身有语法错误。

解决方法：

1. 检查脚本路径是否正确。
2. 确保所有依赖已安装。
3. 运行脚本单独测试，确保其能正常工作。

参考链接

• Git Hooks Documentation
• Pylint Documentation
• Node.js Documentation

通过以上步骤，你可以成功配置一个结合 Python 和 Node.js 的 pre-commit-hook，在代码提交前自动执行一系列检查和测试，提升代码质量和开发效率。