引言
在开发各种前端应用程序时，我们往往会使用一些开源组件或者库。而这些组件和库常常都托管在 Github 上，在使用它们的过程中，了解这些组件和库的开发历程和贡献者也是非常重要的。因此，学习如何使用 npm 包 github-contributors-list，能够帮助我们更好地了解这些组件和库的历程和人员，同时也有助于我们更好地进行开发。
npm 包 github-contributors-list
github-contributors-list 是一个 npm 包，可以用于查询一个 Github 仓库的所有贡献者的信息，例如姓名、Github 主页、贡献次数等。
使用这个 npm 包，我们可以快速查看一个 Github 仓库的贡献者信息，方便我们了解其背景和历史。
安装
安装 github-contributors-list 可以通过 npm，运行以下命令：
npm i github-contributors-list
用法
安装完毕后，就可以开始对它进行调用了。根据官方文档和示例，我们可以了解到 github-contributors-list 提供了一些可以调用的方法：
- getContributors(repo, callback)
其中 repo 参数为 Github 仓库的名字和作者，例如 “facebook/react”，callback 为回调函数，当拉取完成后会调用该函数，返回贡献者信息。例如：
var contributors = require("github-contributors-list");
contributors.getContributors("facebook/react", function (err, data) {
if(err) console.log(err);
else console.log(data);
})这里我们传入了 “facebook/react” 作为仓库名，这样我们就可以获得所有在 react 仓库中的贡献者信息了，返回值为一个包含所有贡献者信息的数组。我们可以对其进行一些处理，例如打印每个贡献者的个人信息：
-- -------------------- ---- -------
--- ------------ - ------------------------------------
---------------------------------------------- -------- ----- ----- -
------- -----------------
---- -
--------------------- ------------- -
------------------------------ ----------------------
---
-
--在这段代码中，我们对 data 数组进行了遍历，并且打印了每个贡献者的 Github 用户名和主页链接。
总结
github-contributors-list 是一个很好用的 npm 包，它可以帮助我们了解 Github 仓库的贡献者信息，帮助我们掌握它们的背景和历史。在使用它时只需按照上述给出的方法进行调用，通过回调函数即可获取贡献者信息。
在实际应用中，我们可以结合其他的技术，将 github-contributors-list 获取到的贡献者信息展示在我们的网站中，例如将每位贡献者的信息展示在一个表格中，或者在搜索框中进行搜索。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedc859b5cbfe1ea06122ef