为 git commit 添加提示

最新推荐文章于 2024-08-31 23:31:54 发布

陈y_d

最新推荐文章于 2024-08-31 23:31:54 发布

阅读量170

点赞数

分类专栏：工具链文章标签： git javascript 开发语言

本文链接：https://blog.csdn.net/Cwd_wade/article/details/130236812

版权

工具链专栏收录该内容

4 篇文章 0 订阅

订阅专栏

文章介绍了如何在项目中设置commitizen和cz-customizable来规范Git提交信息。首先，需要安装这两个依赖，然后在package.json中添加config配置，指明commitizen路径。接着，创建.cz-config.js文件，自定义提交类型和范围。完成后，可以通过npmruncommit命令进行规范化提交。

摘要由CSDN通过智能技术生成

首先要 commitizen 和 cz-customizable 依赖。

 npm i commitizen cz-customizable -D

接着在 pagckage.json 文件中添加 config 配置，如下：

{
  "name": "test-commit",
  "version": "1.0.0",
  "description": "",
  "main": ".cz-config.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "commit": "git-cz"
  },
  "config": {
    "commitizen": {
      "path": "node_modules/cz-customizable"
    }
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "commitizen": "^4.2.4",
    "cz-customizable": "^6.7.0"
  }
}

最后，在所在项目根目录新建 .cz-config.js 文件，其内容如下：

module.exports = {
	allowBreakingChanges: ["feat", "fix"],
	allowCustomScopes: true,
	scopes: [],
	types: [{
		name: "功能：新增功能，迭代项目需求 (feat)",
		value: "feat"
	}, {
		name: "修复：修复缺陷，修复上一版本存在问题 (fix)",
		value: "fix"
	}, {
		name: "文档：更新文档，仅改动文档不改动代码 (docs)",
		value: "docs"
	}, {
		name: "样式：变动格式，不影响代码逻辑 (style)",
		value: "style"
	}, {
		name: "重构：重构代码，非新增功能也非修改缺陷 (refactor)",
		value: "refactor"
	}, {
		name: "性能：优化性能，提高代码执行性能 (perf)",
		value: "perf"
	}, {
		name: "测试：新增测试，追加测试用例验证代码 (test)",
		value: "test"
	}, {
		name: "构建：更新构建，改动构建工具或外部依赖 (build)",
		value: "build"
	}, {
		name: "脚本：更新脚本，改动CI或执行脚本配置 (ci)",
		value: "ci"
	}, {
		name: "事务：变动事务，改动其他不影响代码的事务 (chore)",
		value: "chore"
	}, {
		name: "回滚：回滚版本，撤销某次代码提交 (revert)",
		value: "revert"
	}, {
		name: "合并：合并分支，合并分支代码到其他分支 (merge)",
		value: "merge"
	}, {
		name: "同步：同步分支，同步分支代码到其他分支 (sync)",
		value: "sync"
	}, {
		name: "改进：改进功能，升级当前功能模块 (impr)",
		value: "impr"
	}]
};