IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> 开发工具 -> commit规范使用gitmoji全流程 cz-customizable+commitlint+husky+conventional-changelog -> 正文阅读

[开发工具]commit规范使用gitmoji全流程 cz-customizable+commitlint+husky+conventional-changelog

前言


  1. 创建 git 仓库 git init
  2. git 忽略规则 .gitignore : node_modules
  3. 代码

1. Gitmoji Commit Message 规范


  • 格式:
<emoji> <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
  • 例子:
? feat(blog): add comment section

2. 书写 Commit


  • cz-customizable
    可自定义的 Commitizen 插件(或独立实用程序),可帮助实现一致的提交消息

  • 安装

npm i -D cz-customizable
  • 配置
    根目录创建 .cz-config.js
module.exports = {
  types: [
    {
      value: ':sparkles: feat',
      name: '? feat:     新功能'
    },
    {
      value: ':bug: fix',
      name: '🐛 fix:      修复bug'
    },
    {
      value: ':tada: init',
      name: '🎉 init:     初始化'
    },
    {
      value: ':pencil2: docs',
      name: '??  docs:     文档变更'
    },
    {
      value: ':lipstick: style',
      name: '💄 style:    代码的样式美化'
    },
    {
      value: ':recycle: refactor',
      name: '??  refactor: 重构'
    },
    {
      value: ':zap: perf',
      name: '?? perf:     性能优化'
    },
    {
      value: ':white_check_mark: test',
      name: '? test:     测试'
    },
    {
      value: ':rewind: revert',
      name: '?? revert:   回退'
    },
    {
      value: ':package: build',
      name: '📦? build:    打包'
    },
    {
      value: ':rocket: chore',
      name: '🚀 chore:    构建/工程依赖/工具'
    },
    {
      value: ':construction_worker: ci',
      name: '👷 ci:       CI related changes'
    }
  ],
  messages: {
    type: '请选择提交类型(必填)',
    customScope: '请输入文件修改范围(可选)',
    subject: '请简要描述提交(必填)',
    body: '请输入详细描述(可选)',
    breaking: '列出任何BREAKING CHANGES(可选)',
    footer: '请输入要关闭的issue(可选)',
    confirmCommit: '确定提交此说明吗?'
  },
  allowCustomScopes: true,
  allowBreakingChanges: [':sparkles: feat', ':bug: fix'],
  subjectLimit: 72
}
  • 将新脚本添加到您的 package.json
"scripts" : {
  ...
  "commit": "git add . && cz-customizable"
}
  • 使用 npm run commit 代替 git commit

3. 校验 commit


  • commitlint

检查 commit 是否符合某种规范的校验工具

  • 安装
npm i -D @commitlint/cli commitlint-config-git-commit-emoji commitlint-config-cz
  • 配置
    根目录创建 commitlint.config.js
module.exports = {
  extends: ['git-commit-emoji', 'cz']
}
  • husky
    针对 git 流程自动执行 commitlint

  • 安装

npm i -D husky
  • 配置
npm set-script prepare "husky install"
npm run prepare
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

4. 生成日志


  • conventional-changelog
    可以根据项目的 commit 和 metadata 信息自动生成 changelogs 和 release notes 的系列工具。

  • 安装

npm i -D conventional-changelog-cli conventional-changelog-gitmoji-config
  • 将新脚本添加到您的 package.json
"scripts" : {
  ...
  "changelog": "conventional-changelog -p gitmoji-config -i CHANGELOG.md -s"
}
  • 运行 npm run changelog 生成日志

参考文章


  开发工具 最新文章
Postman接口测试之Mock快速入门
ASCII码空格替换查表_最全ASCII码对照表0-2
如何使用 ssh 建立 socks 代理
Typora配合PicGo阿里云图床配置
SoapUI、Jmeter、Postman三种接口测试工具的
github用相对路径显示图片_GitHub 中 readm
Windows编译g2o及其g2o viewer
解决jupyter notebook无法连接/ jupyter连接
Git恢复到之前版本
VScode常用快捷键
上一篇文章      下一篇文章      查看所有文章
加:2022-05-24 18:25:54  更:2022-05-24 18:28:05 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 -2024/11/14 14:54:24-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码