如何用pre-commit-hooks快速检查Erlang项目的rebar.config配置

pre-commit-hooks是一个功能强大的Git预提交钩子集合，专为提升代码质量而设计。作为开源项目pre-commit的核心组件，它提供了30多个现成的检查工具，能够帮助开发者在代码提交前自动发现和修复常见问题。

对于Erlang开发者来说，虽然pre-commit-hooks没有专门针对rebar.config的检查钩子，但我们可以通过巧妙的配置方法，利用现有的通用检查工具来确保rebar配置文件的正确性。🚀

为什么Erlang项目需要配置检查

rebar.config是Erlang项目的核心配置文件，包含了依赖管理、编译选项、插件配置等重要信息。一个错误的配置可能导致：

• ❌ 依赖解析失败
• ❌ 编译错误
• ❌ 部署问题
• ❌ 团队协作混乱

通过pre-commit-hooks的自动化检查，我们可以确保每次提交的rebar.config文件都是语法正确且符合规范的。

快速配置rebar.config检查步骤

第一步：安装pre-commit框架

首先需要安装pre-commit框架，这是使用pre-commit-hooks的前提条件：

pip install pre-commit

第二步：创建配置文件

在项目根目录创建.pre-commit-config.yaml文件，添加对rebar.config的检查配置：

repos:
-   repo: https://gitcode.com/gh_mirrors/pr/pre-commit-hooks
    rev: v6.0.0
    hooks:
    -   id: check-json
        files: ^rebar\.config$

第三步：利用JSON检查工具

虽然rebar.config使用Erlang语法，但其结构与JSON相似。我们可以利用check_json.py工具来验证配置文件的语法正确性。

第四步：自定义检查脚本

对于更复杂的检查需求，可以创建自定义钩子：

-   repo: local
    hooks:
    -   id: rebar-config-check
        name: Check rebar.config syntax
        entry: erl -eval '{ok, _} = file:consult("rebar.config"), halt(0).' -noshell
        language: system
        files: ^rebar\.config$

实用的rebar.config检查技巧

1. 语法验证技巧

利用Erlang运行时验证rebar.config语法：

erl -eval '{ok, _} = file:consult("rebar.config"), halt(0). -noshell

2. 依赖配置检查

通过check_yaml.py的变通使用：

-   id: check-yaml
    files: ^rebar\.config$
    args: [--unsafe]

3. 文件格式规范

使用其他通用钩子确保配置文件质量：

• trailing-whitespace - 去除尾部空格
• end-of-file-fixer - 确保文件以换行符结束
• mixed-line-ending - 统一行尾符

高级配置优化方案

多环境配置检查

对于包含多个环境的rebar.config，可以设置分层检查：

-   id: check-json
    files: ^rebar\.config$
-   id: check-yaml  
    files: ^rebar\.config\.local$

团队协作规范

通过pre-commit-hooks确保团队成员遵循统一的配置标准：

• ✅ 统一的缩进风格
• ✅ 一致的键值对格式
• ✅ 必要的配置项完整性
• ✅ 依赖版本规范

常见问题解决方案

问题1：检查工具不识别Erlang语法 解决方案：使用Erlang解释器进行语法验证，或者将配置文件转换为JSON格式进行临时检查。

问题2：复杂的rebar配置结构
解决方案：创建专门的解析脚本，利用util.py中的工具函数。

结语

通过pre-commit-hooks的灵活配置，Erlang开发者可以轻松实现rebar.config文件的自动化检查。这种实践不仅提升了代码质量，还促进了团队协作的规范化。

记住，好的工具配置是高效开发的基石。开始使用pre-commit-hooks来保护你的Erlang项目配置吧！✨