如果你是一名 Web 前端开发，你一定经常会使用 Git 这个版本控制工具来协同开发吧？而当我们开发完成后，我们一般都要将代码 push 到远程仓库中，但是在了解到项目的某一个版本信息时，我们需要查看日志记录，一条一条的寻找可能会消耗很多时间。那么有没有快速的方式帮助你查找这些信息呢？答案是肯定的，那就是使用 @vivaxy/git-info。
什么是 @vivaxy/git-info
@vivaxy/git-info 是一个能够帮助你快速查找 Git 版本信息的工具，它对 commit、tag、branch 等 Git 相关信息进行提取，免去了需要到远程仓库中查找这些历史记录的繁琐步骤，从而提高你的开发效率。
如何使用
安装
使用 npm 进行安装：
npm i @vivaxy/git-info
API
getVersionInfo
此方法用于获取版本信息：
const { getVersionInfo } = require('@vivaxy/git-info');
const { commit, branch, tag } = getVersionInfo();获取到的版本信息的格式如下：
{
commit: 'e55e6ab',
branch: 'master',
tag: 'v0.0.1'
}其中 commit 为该 commit 对应的 hash 值， branch 为本地分支名称，tag 为最近的 tag 名称。
getLogInfo
此方法用于获取当前版本与上一个版本之间的 log 信息：
const { getLogInfo } = require('@vivaxy/git-info');
const logs = getLogInfo();
console.log(logs);获取到的 log 信息格式化如下：
-- -------------------- ---- -------
-
-
--------- ---------
------- ------- --------
------- ----------
---------- ------- -------
-- -
--------- ---------
------- ------ --- ------------------
------- ----------
---------- ------ --- -----------------
-
-其中 author 为 commit 的作者，body 为 commit 的详细说明，hash 为该 commit 的 hash 值，subject 为该 commit 的提交说明。
使用示例
下面我们结合实例来演示如何使用 @vivaxy/git-info。
假设我们在项目中安装并使用了 @vivaxy/git-info：
npm i @vivaxy/git-info
然后在我们的项目中编写如下代码：
-- -------------------- ---- ------- ----- - --------------- ---------- - - ---------------------------- ----- ----------- - ----------------- -------------------- ------------- ----- ---- - ------------- -------------------- ------
然后我们在本地新建并切换到一个分支然后进行 commit 操作，并添加 tag，记录一些 log 信息。
我们将修改的代码 push 到远程仓库中，并在 GitHub 中新建一个 Release，选择刚刚添加的 tag，发布成功后再在本地将代码 pull 下来，并执行以下命令：
npm run build
此时你会发现你得到的结果为：
-- -------------------- ---- -------
----- - ------- ---------- ------- ------------------------ ---- -------- -
----- -
-
--------- ---------
------- ------- --------
------- ----------
---------- ------- -------
-- -
--------- ---------
------- ------ --- ------------------
------- ----------
---------- ------ --- -----------------
-
-通过这些信息，我们可以快速了解当前版本信息以及与上一个版本之间发生了什么变化，而不用再在远程仓库中进行查找。这样就大大提高了我们的工作效率。
总结
@vivaxy/git-info 是一个功能强大，易于安装和使用的 npm 包。通过使用 @vivaxy/git-info，我们可以更加方便地了解当前版本信息和变化历史，从而在开发处理中更加得心应手。
当然，如果你对 Git 比较熟练，那么手动操作也是可以做到的，但是使用 @vivaxy/git-info 可以更加便捷，同时， @vivaxy/git-info 还支持导出数据为 json、xml、yaml 等格式，如果需要导出为其他格式，也是十分方便的。
总之，我们推荐使用 @vivaxy/git-info 这个高效、方便的 npm 包，它能帮助你更好地开发 Web 项目。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005583681e8991b448d5660