使用commitize+husky+commitlint制定git提交规范并自动修复代码格式

原创

已于 2022-04-12 22:36:52 修改 · 984 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#git #webpack

于 2022-04-12 11:59:58 首次发布

本文介绍了如何结合git、commitizen、cz-customizable、husky和commitlint来规范代码提交流程。首先，通过全局安装Commitizen和cz-customizable插件，自定义提交提示信息。接着，创建.cz-config.js文件以设置提交类型。然后，安装并配置husky和commitlint，确保提交描述遵循指定的规范。最后，利用lint-staged在提交时进行代码规范检查和自动修复，确保团队开发过程中代码提交的质量和一致性。

文章目录

一、使用git+commitize+cz-customizable制定提交规范

1.全局安装 Commitizen

npm install -g commitizen@4.2.4

2.安装并配置 cz-customizable 插件

// 使用npm 下载 cz-customizable
npm install cz-customizable@6.3.0 --save--dev

添加以下配置到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