npm 包 @1stg/commitlint-config 使用教程

前言

在开发过程中，为了团队协作和代码管理的需求，我们需要对代码 commit 进行规范和约束。commitlint 就是一个很好的工具来解决这个问题。而 @1stg/commitlint-config 作为一个 commitlint 的配置包，可以帮助我们非常便捷地规定 commit message 的格式和内容，提高协作效率和代码质量。

本文将详细介绍如何使用 @1stg/commitlint-config，让我们更好地使用 commitlint。

安装

首先，通过 npm 安装 @1stg/commitlint-config：

npm i -D @1stg/commitlint-config

配置

接着，在你的项目根目录下创建 commitlint.config.js 文件，并将以下代码添加进去：

module.exports = {
  extends: ["@1stg/commitlint-config"]
}

以上代码即是使用 @1stg/commitlint-config 的配置代码，通过 extends 继承了这个配置包。

使用

接下来我们可以通过 git commit 命令进行 commit，并且 commitlint 会对我们的 commit 进行验证。

例如，你要进行一次 commit，并提交代码到 git 服务器。你可以使用以下命令：

git add .
git commit -m "feat: add new function"
git push

其中，feat 是指添加一个新功能的 commit 类型，add new function 是 commit 描述。

如果你使用以上的命令，会被 commitlint 判定为错误的 commit 形式。因为我们默认只接受英文的表述，如下面的命令：

git add .
git commit -m "feat: add new function"
git push

定制化

如果你不想使用默认配置，可以进行自定义的配置。你可以根据 @1stg/commitlint-config 的配置自定义修改，并添加进入 commitlint.config.js 文件，例如：

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

以上配置即是一个比默认配置更严格的规则，强制要求 commit type 必须为特定的值，而且 subject 以句子形式书写。

结束语

本文介绍了如何使用 @1stg/commitlint-config，进而掌握 commitlint 工具。commitlint 可以帮助我们规范 commit 形式，提高代码质量和协作效率，希望对您有所帮助。

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