git commit 提交规范及配置

最新推荐文章于 2025-04-03 21:21:52 发布

Wings_Lee

最新推荐文章于 2025-04-03 21:21:52 发布

阅读量889

点赞数 1

分类专栏： git 文章标签： git 前端 github vue.js javascript

本文链接：https://blog.youkuaiyun.com/liyp921210/article/details/129261280

版权

git 专栏收录该内容

2 篇文章

订阅专栏

文章介绍了如何通过安装和配置commitizen及cz-customizable插件，来使开发团队的Gitcommit提交更加规范。安装流程包括npm全局安装，更新package.json配置，创建cz-config.js文件并定义提交类型。在遇到ES模块加载错误时，通过将package.json中的type改为CommonJS解决了问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

开发过程中，希望commit提交更为规范，找到了这样一个插件，分享一下

使用后的效果：

这样多人开发的时候，提交代码更为清晰了，接下来是安装流程

1.安装commitizen和cz-customizable

npm i -g commitizen@4.2.4 
npm i cz-customizable@6.3.0 -S

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/e/h)",
  },
  // 跳过问题
  skipQuestions: ["body", "footer"],
  // subject文字长度默认是72
  subjectLimit: 72,
};

之后就可以用 git cz来替代git commit

出现了这个错误（Must use import to load ES Module: xxx\vite-project\.cz-config.js）

我将package.json中的type从module改为CommonJs后可行了