使用commitlint规范git提交

Miracle 发布于2019-08-22 18:50 / 1544人阅读

摘要：在我们开始一个项目的时候通常会用去规范代码。我们还可以用一些命令行工具去规范我们的提交信息以及在每次操作过程中执行一些测试，最快可以依据提交信息生成文件提交信息规范与验证使更容易自动生成并发布版本安装配置和使用具体参考相应官网

在我们开始一个项目的时候通常会用eslint去规范js代码。我们还可以用一些命令行工具去规范我们的git提交信息以及在每次git操作过程中执行一些测试，最快可以依据git提交信息生成CHANGELOG文件

commitlint: git 提交信息规范与验证
husky: 使ghook更容易
standard-version: 自动生成CHANGELOG 并发布版本

安装

npm install --save-dev @commitlint/{config-conventional,cli}
npm i --save-dev standard-version
npm install husky --save-dev

配置

commitlint
echo "module.exports = {extends: ["@commitlint/config-conventional"]}" > commitlint.config.js
// commitlint.config.js
 module.exports = {
  extends: ["@commitlint/config-conventional"],
  rules: {
  "type-enum": [2, "always", [
     "feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore", "revert"
   ]],
  "scope-empty": [2, "never"],
  "subject-full-stop": [0, "never"], 
  "subject-case": [0, "never"]
  }};

Standard-version 和 husky

// package.json
 "scripts": {
  "lint": "eslint .",
  "commitmsg": "commitlint -e $GIT_PARAMS",
  "release": "standard-version",
  "validate": "npm prune",
  "pre-commit": "npm run lint",
  "pre-push": "npm run validate",
  "npmi": "npm i",
  "post-merge": "npm run npmi",
  "post-rewrite": "npm run npmi"
 }

使用

具体参考相应官网

GPU云服务器云服务器维持整洁的 Git 提交记录使用规范 git使用流程 commitlint

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/96275.html

前端代码风格自动化系列（二）之Commitlint

摘要：文件配置配置说明由和配置数组组成，如，数组中第一位为，可选，为，为，为，第二位为应用与否，可选，第三位该的值。在有了Husky赋能之后，我们有能力在Git的钩子里做一些事情，首先不得不提的是代码的提交规范和规范的校验，优雅的提交，方便团队协作和快速定位问题。首推Commitlint，另外@加神推荐了Gitmoji也是一个很有意思的工具。安装 npm install --save-...

FuisonDesign 2019-08-23 14:33 评论0 收藏0
vue，react 配置 commitlint 和 eslint 钩子

摘要：官网仓库仓库中文官网一配置搭配的钩子后，每次提交版本信息的时候，会根据配置的规则进行校验，若不符合规则会失败，并提示相应信息。添加字段的配置跳过校验使用指令可以跳过检验规则代码规范强制提交测试关于 commitlint, husky, eslint 的具体信息可以见官网。 commitlint: 官网, github 仓库 husky： github 仓库 eslint 中文官...

chemzqm 2019-08-23 10:26 评论0 收藏0
Lint Your Code

摘要：形成良好统一的代码规范，有利于提高代码的可读性，减少潜在的错误，便于团队协作开发。其中是可选的，如果没有则禁用所有规则，如果有则禁用所有规则。也可以定义一个命令同时运行这两个命令，我在这里使用了我们定义了在钩子触发时会执行命令。形成良好统一的代码规范，有利于提高代码的可读性，减少潜在的错误，便于团队协作开发。本文简单介绍JS、CSS、 Git Commit 的规范工具及用法。 Lin...

hidogs 2019-08-23 10:27 评论0 收藏0
从0到1开发实战手机站（二）：Git提交规范配置

摘要：既然是实战项目，我们也得在写页面之前把相关的规范配置做好。使用来执行规范全局安装下需在前面加项目目录下执行配好后，之后用到命令时，改为使用。使用效验提交信息首先还是安装依赖也会安装但自且并不和之后的版本兼容。生活不能随意过，代码也不能随意写。前一篇文章我们已经把项目搭建好了，那是不是马上就开始写页面了呀？ NO！无论在哪家公司，都会有相应的代码规范。新入职的员工往往第一步就要接受...

nanchen2251 2019-08-23 14:44 评论0 收藏0
从0到1开发实战手机站（二）：Git提交规范配置

摘要：既然是实战项目，我们也得在写页面之前把相关的规范配置做好。使用来执行规范全局安装下需在前面加项目目录下执行配好后，之后用到命令时，改为使用。使用效验提交信息首先还是安装依赖也会安装但自且并不和之后的版本兼容。生活不能随意过，代码也不能随意写。前一篇文章我们已经把项目搭建好了，那是不是马上就开始写页面了呀？ NO！无论在哪家公司，都会有相应的代码规范。新入职的员工往往第一步就要接受...

Miracle_lihb 2019-08-16 14:28 评论0 收藏0