简介
github-contributors 是一个 npm 包，可帮助开发者在 GitHub 上获取项目的贡献者信息。本文将介绍如何使用该包，并提供示例代码以帮助读者更好地理解。
安装
使用 npm 命令进行安装：
npm install --save-dev github-contributors
使用
1. 获得访问令牌
首先需要获得 GitHub API 的访问令牌。请在 GitHub Settings 中生成新的 token，在 repo 和 user 权限下勾选所有选项。
2. 导入和初始化
在 JavaScript 文件中导入包并初始化：
const GithubContributors = require('github-contributors');
// 初始化
const gc = new GithubContributors({
owner: 'owner',
repo: 'repository',
token: 'your-github-token',
});其中，owner 和 repo 分别是 GitHub 项目所属者和项目名称。
3. 获取贡献者列表
调用 getContributors() 方法即可获取贡献者列表：
gc.getContributors().then((contributors) => {
console.log(contributors);
}).catch((error) => {
console.log(error);
});4. 获取单个用户信息
如果想要获取某个用户的详细信息，可以调用 getUser(username) 方法：
gc.getUser('username').then((user) => {
console.log(user);
}).catch((error) => {
console.log(error);
});示例代码
下面是一个完整的示例代码，可以获取指定项目的所有贡献者和其中一个用户的详细信息：
-- -------------------- ---- ------- ----- ------------------ - ------------------------------- -- --- ----- -- - --- -------------------- ------ -------- ----- ------------- ------ -------------------- --- ---------------------------------------- -- - -------------------------- ---------------- -- - ------------------- --- ---------------------------------- -- - ------------------ ---------------- -- - ------------------- ---
结论
通过使用 github-contributors 包，我们可以很容易地在 JavaScript 中获取 GitHub 项目的贡献者列表和单个用户信息。这对于开发者来说非常有用，因为他们可以更好地了解项目中的贡献者和他们的贡献。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/50177