在前端开发中，我们常常需要使用版本控制工具来管理代码的变更历史，帮助我们更好地跟踪和理解代码的进展。而在使用版本控制工具时，提交注释是极其重要的一环，它可以帮助团队成员更好地了解代码的变更情况。@northbrook/commit-types 是一款 Node.js 包，它可以帮助我们规范提交注释的格式，让我们的代码变更历史更加清晰易懂。本文将为大家介绍如何使用 @northbrook/commit-types 这个 npm 包。
@northbrook/commit-types 是什么？
@northbrook/commit-types 是一个 Node.js 包，它提供了一系列的 commit 类型和其对应的描述，用于规范团队成员的提交注释。你可以通过 npm 安装 @northbrook/commit-types，然后在你的项目中使用它来规范提交注释的格式。
如何使用 @northbrook/commit-types？
安装
在使用 @northbrook/commit-types 之前，我们需要先安装它。可以通过以下命令来进行安装：
npm install --save-dev @northbrook/commit-types
使用
@northbrook/commit-types 提供了一系列的 commit 类型，你可以在提交注释中使用它们，以便更好地描述代码变更类型。以下是几种 commit 类型及其对应的描述：
- feat ：新功能
- fix ：修复问题
- docs ：修改文档
- style ：修改了代码格式（不影响功能，例如缩进、空格、格式化、等等）
- refactor ：重构（不是修复问题也不是添加新功能）
- perf ：提高性能的代码更改
- test ：添加或修改测试
- build ：影响构建系统或外部依赖项（例如 scopes：gulp， broccoli， npm）
- ci ：影响 CI 配置文件和脚本（例如 scopes：Travis， Circle， BrowserStack， SauceLabs）
- chore ：对构建或辅助工具和库（例如文档生成）的更改
- revert ：撤销提交
在使用时，只需要在提交注释的开头加上一对方括号，即 []，再写上对应的 commit 类型即可。例如下面这个提交注释：
[feat] 增加了用户注册功能
其中 [feat] 就是 commit 类型，用来描述代码变更的类型；而 增加了用户注册功能 则是对代码变更的具体描述。
配置 commitlint
@northbrook/commit-types 提供了一系列的 commit 类型，但在使用时我们还需要配合其他工具来进行规范审查。这里我们推荐使用 commitlint 这个工具，它可以帮助我们审查提交注释的格式是否符合规范。
以下是如何配置 commitlint：
- 安装 commitlint：
npm install --save-dev @commitlint/config-conventional @commitlint/cli
这里我们安装了两个包，其中 @commitlint/config-conventional 是一个官方提供的 commit 规范配置文件，它已经定义好了包括 feat、fix、test 等在内的一系列 commit 类型；而 @commitlint/cli 则是 commitlint 的命令行工具。
- 在项目根目录下新建一个
.commitlintrc.js文件，并在其中加入以下内容：
module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {}
}; 这里我们使用了 @commitlint/config-conventional 提供的规范配置文件，并将其继承到我们的配置文件中。
- 在提交注释之前，我们需要先运行 commitlint 规范审查，以确定提交注释的格式是否符合规范。我们可以使用以下命令进行提交注释的审查：
npx commitlint --edit
这里使用了 npx 命令，它可以在我们不安装 commitlint 的前提下直接运行它。在使用时，我们只需要在 commit 命令前加上 npx 前缀即可：
npx commit
这样，就可以直接运行 commit 命令，并在提交前进行提交注释规范审查了。
示例代码
-- -------------------- ---- ------- - -- ------------------------ - ---------- --- ------- ---------- ------------------------ ------------------------------- --------------- - -- ---------- ---- --------------- - - -------- ------------------------------------ ------ --- --- - ---------------- - ------ --- ---------- ------
以上就是介绍 @northbrook/commit-types 的使用方法和配合 commitlint 进行提交注释规范审查的方式。希望本文内容能够帮助到大家。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bcd967216659e244a65