前端git约定式规范化提交-commitizen

发布于:2024-06-30 ⋅ 阅读:(123) ⋅ 点赞:(0)

当使用commitizen进行代码提交时,commitizen会提示你在提交代码时填写所必填的提交字段信息内容。

1、全局安装commitizen

npm install -g commitizen@4.2.4

2、安装并配置 cz-customizeable 插件

2.1 使用 npm 下载 cz-customizeable

npm i  cz-customizeable@6.3.0 --save-dev

2.2 在package.json中添加配置

"config":{
    "commitizen":{
        "path": "node_modules/cz-customizable"
    }
}

3、项目根目录下添加 .cz-config.js 文件

module.exports = {
    // 可选类型
    types: [
        {value: 'feat', name: 'feat:    新功能'},
        {value: 'fix', name: 'fix:    修复'},
        {value: 'docs', name: 'docs:    文档变更'},
        {value: 'style', name: 'style:    代码格式(不影响代码运行的变动)'},
        {
            value: 'refactor',
            name: 'refactor: 重构(既不是增加feature,也不是修复bug)'
        },
        {value: 'perf', name: 'perf:    性能优化'},
        {value: 'test', name: 'test:    增加测试'},
        {value: 'chore', name: 'chore:    构建过程或辅助工具的变动'},
        {value: 'revert', name: 'revert:    回退'},
        {value: 'build', name: 'build:    打包'}
    ],
    
    // 步骤
    messages: {
        type: '请选择提交的类型:',
        customScope: '请输入修改的范围(可选)',
        subject: '请简要描述提交内容(必填)',
        body: '请输入详细描述(可选)',
        footer: '请输入要关闭的issue(可选)',
        confirmCommit: '确认要使用以上信息提交? (y/n)'
    },

    // 跳过步骤
    skipQuestions: ['body', 'footer'],

    // 默认长度为 72
    subjectLimit: 72
}

4、使用 git cz 代替 git commit

使用 git cz 代替 git commit,即可看到提交的提示内容


网站公告

今日签到

点亮在社区的每一天
去签到