使用husky+commitlint检查提交描述是否符合规范要求

最新推荐文章于 2025-04-20 16:45:26 发布

翟敏1201

最新推荐文章于 2025-04-20 16:45:26 发布

阅读量560

点赞数 1

分类专栏：前端常用知识文章标签： vue.js javascript npm

本文链接：https://blog.youkuaiyun.com/chaitong2204/article/details/124969616

版权

本文介绍了如何结合husky和commitlint来确保git提交信息遵循特定的规范。首先，详细讲述了如何安装commitlint，创建并配置commitlint.config.js文件。接着，讲解了husky的安装过程，包括生成hooks，添加prepare指令，以及在commit-msg阶段运行commitlint的hook。最终实现的效果是，如果不符规范的commit将无法被提交。文章最后提醒读者，规范的完善还包括pre-commit钩子处理代码规范的检查。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

commitlint

1.安装依赖

npm install --save-dev @commitlint/config-conventional@12.1.4 @commitlint/cli@12.1.4

2.创建commitlint.config.js文件

echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

3.打开commitlint.config.js,增加配置项

module.exports = {
    // 继承的规则
    extends: ['@commitlint/config-conventional'],
    // 定义规则类型
    rules: {
        // type 类型定义，表示 git 提交的 type 必须在以下类型范围内
        'type-enum': [
            // 当前验证的错误级别
            2,
            'always', [
                'feat', // 新功能 feature
                'fix', // 修复 bug
                'docs', // 文档注释
                'style', // 代码格式(不影响代码运行的变动)
                'refactor', // 重构(既不增加新功能，也不是修复bug)
                'perf', // 性能优化
                'test', //

最低0.47元/天解锁文章