get-user-commits 是一个 Node.js 的 npm 包，它提供了一个简单的 API 去获取 GitHub 用户的提交记录。无论你是在开发自己的项目，还是在进行数据挖掘和分析，这个包都会对你的工作有所帮助。
在本篇文章中，我们将会学习如何使用 get-user-commits 包，包括安装它、使用它、以及它的一些限制和注意事项。
安装
安装这个包非常简单，我们只需要在命令行中运行：
npm install get-user-commits
这行代码会安装这个包到你的本地项目的 node_modules 目录中。
使用
使用 get-user-commits 很容易，只需要几行代码就可以了。首先，导入包：
const getCommits = require("get-user-commits");然后，我们可以使用 getCommits 函数来获取存储在 GitHub 上的某个用户的提交记录。
getCommits("username", "repository", "branch", "path")
.then(commits => console.log(commits))
.catch(error => console.log(error));其中，username 是 GitHub 用户名，repository 是仓库名，branch 是 git 分支名（可选），path 是 git 仓库下的文件路径（可选）。
getCommits 函数返回一个 Promise，它将返回一个包含 commit 记录对象的数组。每个 commit 对象都包括了 commit 的 SHA 哈希值、提交时间、提交信息和作者信息。例如：
-- -------------------- ---- -------
-
-
------ -------------------------------------------
------- ---------------------------
---------- ---------- ------ ------- ------
--------- -
------- ------- -------
-------- --------------------
-
--
-
------ -------------------------------------------
------- ---------------------------
---------- ------ --- --- ---------
--------- -
------- ------- -------
-------- --------------------
-
-
-- ---- ----------
-限制和注意事项
get-user-commits 包存在一些限制和注意事项。这些问题可能会影响到你使用这个包的体验和结果，所以我们需要注意一下：
可能会因为 GitHub 的 Request 上限而出现请求上限的问题。GitHub 对于匿名的 API 请求有一个 60 个请求每小时的限制。如果你想增加请求次数，你可以注册一个 GitHub 账户，并生成一个 API Key，并将其作为 http header 发送。
该包仅适用于 GitHub 上的仓库，无法用于其他 Git 托管服务。此外，
get-user-commits仅返回最多 100 条提交记录。如果你想要获取更多提交记录，你需要使用 GraphQL API。如果你提交了合并请求（pull request），
get-user-commits并不会列出相关的提交记录，然而如果已经将合并请求的头部（head）指向某个分支，本质上一系列的提交记录仍然是存在的，使用get-user-commits也能够取到这部分提交记录。
示例代码
以下是一个完整的例子来展示 get-user-commits 的用法。
const getCommits = require("get-user-commits");
getCommits("octocat", "Hello-World")
.then(commits => console.log(commits[0]))
.catch(error => console.log(error));这个例子就是获取 octocat 的 Hello-World 仓库的最近提交记录并将数组中的第一条打印到控制台中。
这是我们从控制台中得到的输出：
{ sha: '7fd1a60b01f91b314f59955a4e4d4e80d8edf11d',
date: '2012-02-29T21:34:34Z',
message: 'Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.',
author: { name: 'The Octocat', email: 'octocat@github.com' } }这是一个简单的例子，你可以根据自己的需求，灵活应用这个 npm 包。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056caf81e8991b448e61e1