前言
GitHub 是全球最大的开源代码托管平台，其中有着非常多的优秀开源项目和贡献者。当我们需要使用或学习一个项目的时候，经常会去查看它的贡献者列表，以了解该项目的作者或者常常参与该项目的人。但是，当该项目有大量的贡献者时，手动查看贡献者列表就显得十分费力且效率低下。因此，我们可以使用npm 包 github-user-list 来快速获取一个 GitHub 项目的贡献者列表，从而方便我们了解该项目的贡献者信息。
在本文中，我们将详细介绍 npm 包 github-user-list 的安装、使用方法和注意事项，并给出具体的代码示例。值得注意的是，本篇文章假设读者已经掌握基本的 npm, Node.js, JavaScript 和 GitHub API 知识。
安装
要使用 npm 包 github-user-list，我们首先需要将它安装到本地项目中。使用以下命令安装：
npm install github-user-list
使用
快速上手
为了演示如何使用该 npm 包，我们以 Vue.js 项目为例。假设我们已经在 GitHub 上找到并 Fork 了该项目的仓库，现在我们想要查看该项目的贡献者名单。我们可以使用以下代码实现：
// 引入项目所需的 github-user-list 包
import { getUserList } from 'github-user-list'
// 使用 getUserList 方法获取项目贡献者名单
getUserList('vuejs', 'vue').then((users) => {
console.log(users)
})其中，getUserList() 方法接受两个参数：仓库所属组织或用户的名称和仓库的名称。例如，Vue.js 项目的仓库地址为 https://github.com/vuejs/vue，则其所属组织或用户的名称为 vuejs，仓库的名称为 vue。
运行以上代码，我们将得到 Vue.js 项目的贡献者名单。
进一步使用
getUserList() 方法将贡献者列表作为其返回值，并且会返回一个 Promise 对象。返回的贡献者列表是一个包含贡献者对象的数组，每个贡献者对象包含以下字段：
id：该贡献者的 GitHub ID。username：该贡献者的 GitHub 用户名。avatar_url：该贡献者的头像 URL。html_url：该贡献者的主页 URL。contributions：该贡献者在该项目中的贡献数。
我们可以根据这些信息自由发挥，比如可以将贡献者名单显示在页面上，或者按照某个字段进行排序。
下面是一个更完整的示例代码：
-- -------------------- ---- -------
------ - ----------- - ---- ------------------
------ ------- -
------ -
------ -
--------- ---
--------- --
-
--
--------- -
--------------------
--
-------- -
--------------- -
-- -- ------ --------
-------------------- ------------------- -- -
-- --------- -------- ---
------------- - -----
-------------- -- -
-- ---------------- -------- ---
------------- - --------------
--
-
-
-该示例代码中将 Vue.js 项目的贡献者名单保存到了 userList 变量中，并使用 Vue.js 初始化相关的方法来在网页上展示名单。若在获取名单时出现错误，则会将错误信息保存到 errorMsg 变量中，以便于查看和调试。
注意事项
- 使用该 npm 包需要注意 GitHub API 的访问限制。为了避免被 GitHub API 的访问速率限制，我们应该使用缓存等方法来减少 API 请求次数，以及尽量避免在短时间内多次请求同一 API。
- 由于大部分 GitHub 仓库都有访问控制，因此需要在获取贡献者列表时提供正确的 GitHub 账户信息，否则可能会遭遇 403 Forbidden 错误。
- 如果在使用该 npm 包时出现了其他错误，可以通过项目的 GitHub Issues 页面进行反馈和讨论。
结语
npm 包 github-user-list 是一个非常实用的工具，方便我们快速获取 GitHub 仓库的贡献者列表。希望通过本文的介绍，读者们能够掌握使用该 npm 包的方法，并且在实际项目中能够充分发挥该工具的作用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065f78238a385564ab693e