npm 包 @bubltechnology/customizable-commit-analyzer 使用教程

在前端开发中，git 提交信息是非常重要的，能够更好地管理代码的版本，帮助开发人员更好地定位问题。而正确规范的 git 提交信息也能为项目管理和协作带来不少便利。@bubltechnology/customizable-commit-analyzer 是一个 npm 包，可以让我们更方便地规范和管理 git 提交信息。

什么是@bubltechnology/customizable-commit-analyzer?

@bubltechnology/customizable-commit-analyzer 是一个可以解析 git 提交信息的 npm 包，它可以帮助我们更好地规范 git 提交信息，同时也可以自定义 commit message 规则。

如何使用@bubltechnology/customizable-commit-analyzer?

安装

使用@bubltechnology/customizable-commit-analyzer 首先需要安装它。你可以通过运行以下命令安装最新版本：

npm install @bubltechnology/customizable-commit-analyzer --save-dev

配置

安装完成后，在 package.json 中配置：

"config": {
  "commitizen": {
    "path": "./node_modules/@bubltechnology/customizable-commit-analyzer"
  }
}

你可以在这个配置选项中定义你自己的 commit 格式。

使用

@bubltechnology/customizable-commit-analyzer 的使用需要与 Commitizen 工具配合使用：

npm install commitizen -g
commitizen init @bubltechnology/customizable-commit-analyzer --save-dev --save-exact

然后在提交代码的时候使用 cz 命令代替 git commit 即可。

npm run cz

自定义规则

你可以通过更改 package.json 中 config.commitizen.path 对应的自定义规则来自定义 commit message 规则。

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

示例代码

const analyzer = require('@bubltechnology/customizable-commit-analyzer');

console.log(analyzer.analyze('feat: add new features to the product')); // 解析成 { type: 'feat', subject: 'add new features to the product' }

console.log(analyzer.analyze('style: Fix issues appearance')); // 解析成 { type: 'style', subject: 'fix issues appearance' }

console.log(analyzer.analyze('test: write test cases for some feature')); // 解析成 { type: 'test', subject: 'write test cases for some feature' }

总结

通过@bubltechnology/customizable-commit-analyzer 的使用，我们可以更加方便地规范和管理 git 提交信息。同时，自定义 commit message 规则也让我们可以更好地适配自己团队的需求。

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