devbox
算法构造者2
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

git commit规范与配置_npx cz

作者：算法构造者2 | 2024-01-30 12:13:21

赞

踩

npx cz

一、需求场景

        在一个开发团队中，前端开发的代码管理越来越规范化、工程化，而代码commit更是需要一个统一的规范去约束，保证代码commit时的规范性。尤其多人参与一个项目开发时，大家的代码commit风格不相同，不便于后续的代码统一管理和可读性；所以良好的git commit风格是很重要的。

二、使用工具

1、commitlint

        很多时候我们提交代码时，运行 git commmit -m 'xxx' 即可，而commitlint可以对message进行约束，是判断message是否符合格式要求的工具。commitlint 推荐结合config-conventional 配置使用，正确的提交格式是：git commit -m <type>[optional scope]: <description>

type ：说明代码提交的类型。

optional scope：一个可选的修改范围。

description：描述提交的主要内容。

常见的type类型

  • feat：新功能

  • fix：Bug 修复

  • docs：文档更新

  • style：代码样式更改，例如空格、格式、缺少分号等

  • refactor：重构代码

  • perf：性能优化

  • test：添加缺失或修正测试代码

  • chore：构建相关的代码或工具库，如文档生成等

         commitlint仅仅规范git commit -m <type>[optional scope]: <description>这样的格式去提交代码，每次提交时都需要输入type，这样比较麻烦，所以需要使用commitizen辅助工具来自动生成提交信息。

2、commitizen+cz-customizable

        commitizen是规范commit message的工具，提供选择的commit message类型，快速生成commit message说明；而cz-customizable作为它的适配器，可以定制提交说明信息的type。

3、husky + lint-staged

        进行代码质量规范检查时,husky可以阻止不符合规范的commit，push等操作，husky是注册在git pre-commit钩子函数被调用时执行lint-staged，pre-commit 钩子在git commit 时就会触发。lint-staged对暂存区中有改动的文件根据ESLint 和 Prettier的规则进行检测；eslint+husky+prettier+lint-staged工具的配合使用可以规范我们的代码格式统一，进行代码格式检查 和代码美化，保证代码质量。

三、配置

1、commitlint

安装

npm install  @commitlint/cli @commitlint/config-conventional  -D

在根目录下新建.commitlintrc.js或者commitlint.config.js文件

  1. module.exports = {
  2.     extends: ['@commitlint/config-conventional']
  3. };

2、commitizen+cz-customizable

安装

npm install commitizen cz-customizable -D

在根目录下新建.cz-config.js文件，配置commit type。

  1. // 提交代码：使用 npx cz 命令
  2. // 相关配置：https://github.com/leoforfree/cz-customizable
  3. module.exports = {
  4.     types: [
  5.         {
  6.             value: 'feat',
  7.             name: '✨ feat（新功能）'
  8.         },
  9.         {
  10.             value: 'fix',
  11.             name: '
    声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/article/detail/46361
    推荐阅读
    相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。