专栏首页方球commitlint 从0到1 (git commit 校验工具)

commitlint 从0到1 (git commit 校验工具)

背景

Commitlint git commit 格式校验工具。

安装

  • 安装npm包
npm install -g @commitlint/cli @commitlint/config-conventional
  • 新建配置文件
touch commitlint.config.js
// commitlint.config.js
module.exports = {
  extends: ['@commitlint/config-conventional']
}

配置文件

默认读取根目录下commitlint.config.js 配置文件

指定配置文件

commitlint --config <file path>

配置项

  • extends 继承外部配置文件或npm配置包
{
  extends: [
    // 使用本地共享配置文件
    './commitlint.local.js',
    // 使用第三方npm包
    '@commitlint/config-conventional',  
    // 以 `<scope>/commitlint-config` 格式的第三方包, 提供简写模式
    '@coolcompany',
    // commitlint-config-*
    'lerna',
  ]
}
  • parserPreset 解析器路径(必填)
{
   parserPreset: 'conventional-changelog-atom',
}
  • formatter 格式化工具(必填)
{
  formatter: '@commitlint/format',
}
  • rules 本地自定义规则, 优先级高于extends
{
  'type-enum': [2, 'always', ['foo']]
}
  • ignores 忽略函数, 帮助忽略某些不需要的提交信息
{
  ignores: [(commit) => commit === ''],
}
  • defaultIgnores 是否使用默认忽略配置
{
  defaultIgnores: true
}
  • helpUrl 帮助信息地址

'https://github.com/conventional-changelog/commitlint/#what-is-commitlint',

  • prompt 自定义提示信息
{
  prompt: {
    messages: {},
    questions: {
      type: {
        description: 'please input type:',
      },
    },
  },
}

自定义校验规则

规则格式

[规则名称]:[level, applicable, value]

  • level 校验等级
    • 0 禁用
    • 1 警告
    • 2 错误
  • applicable
    • always
    • nerver
  • value 参数值

规则可接收: 1. 规则数组 Array, 2. 返回规则数组的函数 () => arry , 3. Promise规则数组 Promise<array> ,作为值

{
  "rules":{
      "header-max-length": [0, "always", 72],
      "header-max-length": () => [0, "always", 72],
      "header-max-length": async () => [0, "always", 72],
  }
}

规则项

<header>

  • header-case 单词格式, 例如: upper-case 全大写
  • header-full-stop 结束符
  • header-max-length header 最大长度
  • header-min-length header 最小长度
  • references-empty
  • scope
    • scope-enum scope 可选值, 例如 [ 'components', 'utils', 'cli' ]
    • scope-case scope 单词格式
    • scope-empty 是否为空
    • scope-max-length scope最大内容长度
    • scope-min-length scope最小内容长度
  • subject
    • subject-case subject 单词格式
    • subject-empty subject 是否为空
    • subject-full-stop subject 中止符
    • subject-max-length subject 最大内容长度
    • subject-min-length subject 最小内容长度
    • subject-exclamation-mark 分割符
  • type
    • type-enum type 可选值 例如: [ 'feat', 'fix' ]
    • type-case type 单词格式
    • type-empty type是否为空
    • type-max-length type最大内容长度
    • type-min-length type最小内容长度
  • signed-off-by
  • trailer-exists

<body>

  • body-full-stop body 结束符
  • body-leading-blank body 开头空行
  • body-empty body 是否为空
  • body-max-length body最大内容长度
  • body-max-line-length body最大内容行数
  • body-min-length body最小内容长度
  • body-case 单词格式 , 例如: upper-case 全大写

<footer>

  • footer-leading-blank footer 开头空行
  • footer-empty footer是否为空
  • footer-max-length footer最大内容长度
  • footer-max-line-length footer最大内容行数
  • footer-min-length footer最小内容长度

规则插件

规则插件为我们提供自定义规则校验个能力。

本地插件

{
  rules: {
    // 添加规则
    'header-size-10': [2, 'always']
  }
  plugins: [
     // 定义插件
    {
      rules:{
        // 定义规则
        'header-size-10': ({header}) => {
           const pass = header.length > 10
           const message = `header 长度不能超过10个字符`
           return [pass, message]
        }
      }  
    }
  ]

官网其他插件方式

Prompt 提示器

提示器类似 commitizen 提供commit 提示工具。

安装

  • 包安装
npm i -D  @commitlint/cli  @commitlint/config-conventional @commitlint/prompt-cli
  • 配置文件
// commitlint.config.js
module.exports = {extends: ['@commitlint/config-conventional']}
  • package.json 设置
"scripts": {
  "commit": "commit"
}
  • 使用

git add *

npm run commit

commitizen 适配器

commitizen 作为 Prompt 的替代方案, 官方为他提供适配器 @commitlint/cz-commitlint

该适配器主要有两部分组成:

  • messages: 提示信息
  • questions: 交互配置

修改适配器

通过 commitlint.config.json 配置文件自定义类型提示

为命令配置中文提示

image.png

image.png

@commitline/cz-commitlint 详情

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 【Git】:Commit规范 + CHANGELOG生成

    从 git commit 的 message 开始进行规范化(主流:angular 规范),进而可以通过工具(例如:conventional-changelog...

    WEBJ2EE
  • 为什么 husky 放弃了传统的 JS 配置

    husky想必大家都不陌生。作为前端工程化中一个不可或缺的的工具,它可以向我们的项目中添加git hooks。同时配合lint-staged可以方便的在代码提交...

    前端森林
  • 让你的 commit 更有价值

    AngularJS 在开发者文档1中关于 git commit 的指导说明,提到严格的 git commit 格式规范可以在浏览项目历史的过程中看到更易读的信息...

    陈大鱼头
  • 你可能已经忽略的git commit规范

    在日常的开发工作中,我们通常使用 git 来管理代码,当我们对代码进行某项改动后,都可以通过 git commit 来对代码进行提交。

    前端森林
  • Commitizen 从0到1(git commit 规范工具)

    commitizen git commit 格式化工具, 为我们提供标准化的 commit 信息。 帮助我们统一项目commit , 便于信息的回溯或日志的生成...

    copy_left
  • 别乱提交代码了,看下大厂 Git 提交规范是怎么做的!

    现在市面上比较流行的方案是约定式提交规范(Conventional Commits),它受到了Angular提交准则的启发,并在很大程度上以其为依据。约定式提交...

    芋道源码
  • 别乱提交代码了,看下大厂 Git 提交规范是怎么做的

    现在市面上比较流行的方案是约定式提交规范(Conventional Commits),它受到了Angular提交准则的启发,并在很大程度上以其为依据。约定式提交...

    IT大咖说
  • 别乱提交代码了,看下大厂 Git 提交规范是怎么做的!

    现在市面上比较流行的方案是约定式提交规范(Conventional Commits),它受到了Angular提交准则的启发,并在很大程度上以其为依据。约定式提交...

    Erwin
  • Angular 工具篇之规范化Git版本管理

    目前很多的项目都已经使用 Git 作为版本控制工具,使用 Git 意味着我们每天都要与 Git Commit Message 打交道。Git Commit Me...

    阿宝哥
  • 别乱提交代码了,看下大厂 Git 提交规范是怎么做的!

    git是现在市面上最流行的版本控制工具,书写良好的commit message能大大提高代码维护的效率。但是在日常开发中由于缺少对于commit message...

    搜云库技术团队
  • 基于 Lerna 管理 packages 的 Monorepo 项目最佳实践

    对于维护过多个package的同学来说,都会遇到一个选择题,这些package是放在一个仓库里维护还是放在多个仓库里单独维护,本文通过一个示例讲述了如何基于Le...

    杨振涛
  • 开箱即用的代码提交规范

    在团队中代码提交(git commit)会有各种各样的风格,甚至有些人根本没有 commit 规范的概念,所以在我们回头去查找在哪个版本出现问题的时候,就会非常...

    用户4131414
  • Webpack5 搭建 Vue3 + TS 项目

    https://segmentfault.com/q/1010000024459339

    @超人
  • 让你的git message更加规范

    规范比业务开发搬砖更为重要,没有一个好的编码规范,维护老的代码或者是编写新的代码都非常痛苦

    w候人兮猗
  • 一文搞定 Conventional Commits

    规范化 git commit 对于提高 git log 可读性、可控的版本控制和 changelog 生成都有着重要的作用。然而阻碍我们脚步的不只是团队的推广,...

    用户1250838
  • 让你的git message更加规范

    规范比业务开发搬砖更为重要,没有一个好的编码规范,维护老的代码或者是编写新的代码都非常痛苦

    w候人兮猗
  • 受够了!这糟糕的git commit记录

    你是否再也无法忍受随意的风格?每次更新版本都不清楚更新了哪些功能?修复了哪些 bug?溯源的时候非常痛苦?不如试试国际知名项目angular.js的提交规范

    机智的程序员小熊
  • 从 0 开始手把手带你搭建一套规范的 Vue3.x 工程化项目

    Vue3 跟 Vite 正式版发布有很长一段时间了,生态圈也渐渐丰富起来,作者已在多个项目中使用,总结一下:就是快!也不用担心稳定性问题,开发体验真不是一般好!...

    XPoet
  • create-react-app + ts 项目工程规范

    Pre-commit Hook: 自动化矫正 npx mrm lint-staged

    踏浪

扫码关注云+社区

领取腾讯云代金券