commitlint-config-ranwawa v1.0.1

• 前言
• 1. 项目配置 - 1.1 安装依赖 - 1.2 在husky中集成commitlint - 1.3 使用辅助工具git-cz - 1.4 集成gitlab-ci
• 2. commit message规范 - 2.1 type - 2.2 subject - 2.3 body
• 3. commitlint详细配置

前言

在所有项目中使用同样风格的message信息的好处

• 内容明确,便于review
• 格式统一,方便输出changelog

1. 项目配置

1.1 安装依赖

1.1.1 安装commitlint

npm install --save-dev @commitlint/cli

1.1.2 安装commitlint配置文件

npm install --save-dev commitlint-config-ranwawa

1.1.3 初始化commitlint配置文件

echo "module.exports = { extends: ['ranwawa'] };" > commitlint.config.js

1.1.4 验证commitlint配置是否生效

# 提交一个错误的commit message
git add package.json
git commit -m "安装commitlint相关依赖"
npx commitlint --from HEAD~1 --to HEAD --verbose

⧗   input: 安装commitlint相关依赖
✖   type may not be empty [type-empty]
✖   subject may not be empty [subject-empty]

# 提交一个正确的commit message
git add commitlint.config.js 
git commit -m "build: 初始化commitlint配置文件"

npx commitlint --from HEAD~1 --to HEAD --verbose
⧗   input: build: 初始化commitlint配置文件
✔   found 0 problems, 0 warnings

1.2 在husky中集成commitlint

每次提交之后,手动运行命令检查commit message是否符合规范.这种操作明显很麻烦. 所以我们需要集成husky,在每次提交commit message之后自动进行检查.

1.2.1 安装husky

npm install --save-dev husky

1.2.2 在npm生命周期中自动激活husky

npm set-script prepare "husky install"

1.2.3 手动激活husky

npm run prepare

1.2.4 在husky生命周期中自动执行commitlint

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'

1.2.5 验证

git add .husky/commit-msg
git commit -m "husky中集成commitlint"

⧗   input: husky中集成commitlint
✖   type may not be empty [type-empty]
✖   subject may not be empty [subject-empty]

1.3 使用辅助工具git-cz

1.3.1 安装git-cz

npm install --save-dev git-cz

1.3.2 安装git-cz配置文件

npm install --save-dev git-cz-config-ranwawa

1.3.3 初始化git-cz配置文件

echo "module.exports = require('git-cz-config-ranwawa');" > changelog.config.js

1.2.4 在npm中添加git-cz命令

npm set-script commit "git-cz"

1.3.5 验证

git add changelog.config.js
npm run commit

? Select the type of change that you're committing: (Use arrow keys or type to search)
❯ 🎸  feat:       新功能 
  🐛  fix:        bug修复 
  💍  test:       增加测试用例 
  💡  refactor:   重构代码(既不是新增功能也不是修复bug) 
  💄  style:      空格,格式化,分号,文字错误等不影响功能的修改 
  ️📖  docs:       注释,文档等无关代码的修改 
  🎡  build:      构建/持续集成相关的修改 

1.4 集成gitlab-ci

2. commit message规范

type: subject

body?

2.1 type

当前提交类型(必填)

只能是以下范围中的一个,以冒号结尾:

• feat: 新功能
• fix: bug修复
• test: 增加测试用例
• refactor: 重构代码(既不是新增功能也不是修复bug)
• style: 空格,格式化,分号,文字错误等不影响功能的修改
• docs: 注释,文档等无关代码的修改
• build: 构建/持续集成相关的修改

2.1.1 根据提交内容,选择正确的标签

• BAD

feat: 修复丢失username无法登录的bug

• GOOD

fix: 修复丢失username无法登录的bug

2.1.2 原子化提交

• BAD

feat: 新增登录功能以及修复首页banner无法滑动的bug

• GOOD

feat: 新增登录功能
fix: 修复首页banner无法滑动的bug

2.2 subject

本次提交的描述信息(必填) 内容不超过200字

2.2.1 描述信息必须有意义

• BAD

feat: 提交msg

• GOOD

feat: 新增登录功能

2.2.2 描述信息必须清晰具体

• BAD

fix: 修复了一个bug

• GOOD

fix: 修复首页banner无法滑动的bug

2.3 body

本次提交的详细内容(可选) 如果一个提交逻辑比较复杂,subject无法描述时,则可以在此添加更加完善的描述信息

2.3.1 和subject之间保留一个空行

• BAD

fix: 修复首页banner无法滑动的bug
由于`swipe.js`插件版本问题,导致打包之后的压缩文件......

• GOOD

fix: 修复首页banner无法滑动的bug

由于`swipe.js`插件版本问题,导致打包之后的压缩文件......

3. commitlint详细配置