git 提交管理配置-信息规范

npm i -g [email protected]

yarn add [email protected] -D

在packge.json中添加以下内容

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

在项目根目录下创建.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/e/h)'  },  // 跳过问题  skipQuestions: ['body', 'footer'],  // subject文字长度默认是72  subjectLimit: 72}

yarn add @commitlint/[email protected] @commitlint/[email protected] -D

在项目根目录下创建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', // 增加测试        'chore', // 构建过程或辅助工具的变动        'revert', // 回退        'build' // 打包      ]    ],    // subject 大小写不做校验    'subject-case': [0]  }}

yarn add [email protected] -D

在控制台执行 npx husky install 命令，会在项目根目录生成对应的文件夹

需要在packge.json文件中生成对应的指令，可以直接添加也可以根据指令添加

npm set-script prepare "husky install"

指令

在控制台执行 yarn/npm run prepare, 执行之后出现以下内容，表示指令执行成功

添加commitlint的hook 到husky中，并指令在 commit-msg 的hook下执行 npx --no-install commitlint --edit "$1" 的指令

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'