npm 包 git-list-updated 使用教程

阅读时长 4 分钟读完

什么是 git-list-updated

git-list-updated 是一个用于获取 git 仓库中新提交的 commit 信息并返回的 npm 包,支持使用 git 命令或者 git web API 进行获取。

安装

如何使用

命令行使用

参数说明:

  • directory:要获取 git 仓库信息的目录,默认为当前目录。
  • --label=label:只显示指定的 label 的 commit。
  • --since=date:只显示提交时间从指定日期之后的 commit,date 格式为 YYYY-MM-DD。
  • --until=date:只显示提交时间在指定日期之前的 commit,date 格式为 YYYY-MM-DD。
  • --exclude-regex=regex: 排除符合正则表达式的 commit 信息。
  • --verbose:打印详细的 commit 信息。
  • --branch=branch: 获取指定分支的最新提交记录。
  • --github-token=token: 如果是获取 GitHub 上的仓库信息,则需要提供 GitHub Personal Access Token。

API 使用

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

参数说明:

  • path/to/repo: git 仓库目录路径,默认为当前目录。
  • since: 和命令行中的 --since 参数一致,只显示提交时间从指定日期之后的 commit,格式为 YYYY-MM-DD。
  • until: 和命令行中的 --until 参数一致,只显示提交时间在指定日期之前的 commit,格式为 YYYY-MM-DD。
  • label: 和命令行中的 --label 参数一致,只显示指定的 label 的 commit。
  • branch: 和命令行中的 --branch 参数一致,获取指定分支的最新提交记录。
  • githubToken: 和命令行中的 --github-token 参数一致,如果是获取 GitHub 上的仓库信息,则需要提供 GitHub Personal Access Token。
  • excludeRegex: 和命令行中的 --exclude-regex 参数一致,排除符合正则表达式的 commit 信息。
  • verbose: 和命令行中的 --verbose 参数一致,打印详细的 commit 信息。

示例代码

下面是一个获取 github 上某个仓库的指定日期范围内的 commit 的示例代码:

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

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

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

总结

git-list-updated 是一个非常实用的 npm 包,能够帮助我们轻松地获取 git 仓库中新提交的 commit 信息。本文介绍了如何安装和使用 git-list-updated,并给出了一些实用的示例代码。如果你正在开发一个需要获取 git 仓库信息的应用程序,那么 git-list-updated 绝对是一个值得尝试的工具。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/70992

纠错
反馈