阅读 44

代码洁癖之commitlint

代码洁癖之commitlint(强洁癖)

功能

防止开发者乱写commit,使commit变得人人可以看得懂,但这需要一些英语加持

安装

yarn add --dev husky @commitlint/cli @commitlint/config-conventional

使用

在项目根目录创建.commitlintrc.js文件

module.exports = {
    extends: ['@commitlint/config-conventional'],
    rules: {
        'subject-case': [0, 'never'],
        'type-enum': [
            2,
            'always',
            [
                'build', // 构建
                'ci', //ci
                'chore', // 改变构建流程或增加依赖库,工具等
                'docs', // 仅仅修改文档,比如README
                'feat', // 新增feature
                'fix', // 修复bug
                'perf', // 优化相关,比如提升性能、体验
                'refactor', // 代码重构,没有增加新功能或修复bug
                'revert', //回滚到上一个版本
                'style', // 仅仅修改了空格、缩进、等,不改变代码逻辑
                'test' // 测试用例,包括单元测试集成测试等
            ]
        ]
    }
}
复制代码

修改package.json文件

{
    "husky": {
        "hooks": {
            "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
        }
    }
}
复制代码

\

文章分类
前端