在前端开发过程中，我们经常需要从 GitHub 上搜索特定的代码库，但在 GitHub 上并不能直接按关键词搜索库，这就需要使用第三方包来进行搜索。在这篇文章中，我们将会讲解如何使用 npm 包 swgg-github-search 来进行 GitHub 代码库的搜索。
什么是 swgg-github-search
swgg-github-search 是一个基于 Node.js 的 npm 包，是 GitHub 官方 API 的一个轻量级包装。使用该包，我们可以直接使用 Node.js 来搜索 GitHub 上的代码库。
在使用该包之前，我们需要一个 GitHub 账号，并且要在 GitHub 上创建一个 Access Token 。这个 Access Token 会被用于进行 GitHub API 的权限认证，确保我们有权限搜索 GitHub 上的代码库。
安装 swgg-github-search
使用 npm 进行安装：
npm install swgg-github-search --save
使用 swgg-github-search
使用 swgg-github-search 进行搜索的过程主要包含以下几个步骤：
- 初始化 GitHub API 的认证信息
- 使用
search方法进行搜索 - 处理搜索结果
接下来我们将会逐步讲解如何进行搜索过程。
初始化认证信息
使用 swgg-github-search 进行 GitHub API 之前，我们需要将 Access Token 配置好。在代码中，我们通常会将 Access Token 存在环境变量中，使用 process.env.ACCESS_TOKEN 来进行获取。
const search = require('swgg-github-search');
search.setAccessToken(process.env.ACCESS_TOKEN);搜索
搜索功能是由 search 方法实现的。我们可以将搜索条件作为参数传递给该方法。例如，在以下的示例中，我们将会搜索 swgg-github-search 这个关键词所对应的代码库。
search.repositories({
q: 'swgg-github-search',
per_page: 10
})该方法接收的参数包括：
q：搜索的关键词per_page：每页显示的搜索结果数量，默认为 10
处理搜索结果
搜索结果是一个包含搜索结果信息的对象，我们可以根据需求对其进行处理。
在以下的示例中，我们将会将获取到的搜索结果输出到控制台。
search.repositories({
q: 'swgg-github-search',
per_page: 10
}).then(res => {
console.log(res);
}).catch(err => {
console.error(err);
})示例代码
以下是一个完整的代码示例，用于搜索 swgg-github-search 关键词所对应的代码库。
-- -------------------- ---- ------- ----- ------ - ------------------------------ -- ------- ------------------------------------------------ -- -- --------------------- -- --------------------- --------- -- ----------- -- - ----------------- ------------ -- - ------------------- --
总结
使用 swgg-github-search 可以方便地搜索 GitHub 上的代码库，减少了我们的工作量和时间成本。此文详细介绍了在 Node.js 中使用该包的过程和示例代码，希望可以帮助读者更好地使用该包进行开发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065b42c6eb7e50355dbd95