前端规范-Git工作流

2021-11-20 187 阅读1分钟

背景

本文主要介绍前端Git工作流规范Husky + Commintlint + Lint-staged，社区有多种commit message的写法规范。大多数企业都使用的是Angular规范，比较合理和系统化，并且有配套工具。本文就是如何在项目中配置的教程。

安装

首先需要安装husky，husky是git的钩子，在git add或者git commit，会执行相关的代码。

npm install --save-dev husky // 安装husky
npx husky install // 激活husky
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"' // 添加hook comit-msg hook
npx husky add .husky/pre-commit 'npx lint-staged' // 添加提交前的校验

配置

// 安装commitlint cli 和 conventional config
npm install --save-dev @commintlint/config-conventional
npm install --save-dev @commintlint/cli
// 自动生成commitlint.config.js配置
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

husky集成

// package.json 中配置如下代码
"husky": {
  "hooks": {
    "pre-commit": "lint-staged",
    "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS" // 校验commit时添加的描述信息是否符合配置的commit规范
  }
},
"lint-staged": {
  "*.{js,jsx,vue}": [
      "vue-cli-service lint"
    ]
}

文档：[Commit message] www.ruanyifeng.com/blog/2016/0…