npm 包 @6river/commitlint-config-6river 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在团队协作开发中，遵循一定的代码规范是非常重要的。其中，Commit message 规范是团队协作及代码维护的基础。使用 @6river/commitlint-config-6river 包可以帮助你的团队对提交信息进行规范校验，提高代码规范性。本文介绍如何使用该 npm 包。

什么是 @6river/commitlint-config-6river

@6river/commitlint-config-6river 是一个针对 Commit message 进行校验的 npm 包，利用 commitlint 来验证提交信息的格式是否符合规范。该包提供了一套基于 angular 中 commit message 格式的校验规则。

安装和使用

安装

npm install @6river/commitlint-config-6river --save-dev

配置

方式一

在项目根目录下的 .commitlintrc.js 添加如下代码：

module.exports = {
  extends: ['@6river/commitlint-config-6river'],
  rules: {
    // 可以配置 Commit message 校验的钩子，如：type-enum、body-max-line-length 等
  },
};

方式二

在 package.json 中添加配置：

"commitlint": {
  "extends": [
    "@6river/commitlint-config-6river"
  ],
  "rules": {
    // 可以配置 Commit message 校验的钩子，如：type-enum、body-max-line-length 等
  }
},

其中，extends 字段指定使用 @6river/commitlint-config-6river 包提供的校验规则。

提交信息规范

使用 @6river/commitlint-config-6river 包后，在添加 commit message 时必须遵守以下规范：

<type>: <subject>

<body>

<footer>

其中，<type> 和 <subject> 是必填的，<body> 和 <footer> 是可选的。

type

<type> 代表改动类型，是必填项。目前包括以下几种类型：

feat: 新功能
fix: 修复 bug
docs: 文档修改
style: 格式、空格、缩进等修改
refactor: 重构代码，没有新增功能或修复 bug
perf: 优化相关，提高性能的修改
test: 测试相关修改
build: 修改构建相关的工具，如 webpack
ci: 修改 CI 相关的配置，如 Travis、CircleCi
chore: 其他修改，如修改了 .gitignore、license 等

subject

<subject> 是对修改内容的简短描述，是必填项。

body

<body> 是对修改内容的详细描述，是可选的。

footer

<footer> 是针对某个 issue 做出的修改，可以是可选的。

示例代码

在项目根目录下的 .commitlintrc.js 中添加如下代码：

-- -------------------- ---- -------
-------------- - -
  -------- -------------------------------------
  ------ -
    ------------ -
      --
      ---------
      -
        ------- -- ---
        ------ -- -- ---
        ------- -- ----
        -------- -- -----------
        ----------- -- -------------- ---
        ------- -- ------------
        ------- -- ------
        -------- -- ----------- -------
        ----- -- -- -- ------- ---------------
        -------- -- --------- ------------------ -
      --
    --
    --------------- ---- -- --------- ------
    -------------------- --- --------- -- --------- --------
    --------------------- --- --------- ---- -- --------- ------ --
    ----------------------- --- --------- ---- -- ------ ---- -- ---
    ------------------------- --- --------- ---- -- -------- ---- -- ---
  --
--

小结

以上就是 @6river/commitlint-config-6river 的使用教程。当你的 Commit message 格式不符合规范时，会收到相应的错误提示。这有助于其它开发者更好地理解你的提交内容，提高代码质量和版本控制的方案。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/100711