npm包 github-repositories 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，我们经常会使用开源组件和工具来提高我们的工作效率和代码质量。其中，npm包是前端最广泛使用的一种组件，可以让我们方便地引入代码库，并进行版本管理和依赖管理。而 github-repositories 这个npm包，可以让我们更方便地获取、搜索、过滤github上的代码库。本文将介绍如何使用github-repositories这个npm包，并提供一些实例代码，希望能对大家有所帮助。

安装 github-repositories 包

首先需要安装 github-repositories 包，在命令行中输入以下命令即可：

npm install github-repositories --save

这将会在你的项目中安装 github-repositories 包，并添加到 dependencies 中。

使用 github-repositories 包

在启用 github-repositories 包之前，需要引入它：

const gh = require('github-repositories');

获取 github 上的代码库

使用 gh 方法从 Github 上获取代码库：

gh('facebook/react')
  .then(repos => console.log(repos));

运行此代码，将在控制台输出包含 facebook/react 代码库信息的JSON对象。

如果要获取多个代码库，可以使用 Promise.all 和 map 结合起来：

Promise.all([
  gh('facebook/react'),
  gh('vuejs/vue'),
  gh('angular/angular')
]).then(reposList => console.log(reposList));

这将会输出包含三个代码库信息的数组。

搜索 github 上的代码库

要在 Github 上搜索代码库，可以使用 search 方法：

gh.search('webpack')
  .then(repos => console.log(repos));

这将会在控制台输出包含 webpack 关键字的代码库信息的JSON对象。

默认情况下，search 方法返回3个最受欢迎的代码库。如果要自定义结果数量，可以在搜索方法中传递 options 对象：

gh.search('webpack', { limit: 10 })
  .then(repos => console.log(repos));

该代码将返回包含 webpack 关键字的10个代码库的JSON对象。

根据条件过滤 github 上的代码库

你可以使用 filter 方法根据条件过滤 GitHub 上的代码库：

gh.filter({ language: 'JavaScript', stars: '>100', followers: '>500' })
  .then(repos => console.log(repos));

language：选定代码库所使用的主要编程语言
stars：选择有多少个星星或更多的 Github 代码库
followers：选择有多少个 GitHub 用户或更多人关注的代码库

这将会在控制台输出包含所选语言, 星数和关注数的代码库信息的JSON对象。

示例代码

下面是一个完整的实例代码，演示了如何使用 github-repositories 包获取、搜索、过滤 GitHub 上的代码库，并使用 console.table() 打印结果。

-- -------------------- ---- -------
----- -- - -------------------------------

--------------------
  ----------- -- -
    --------------- -- -------------- -------
    ---------------------
  ---

--------------------
  ----------- -- -
    --------------- ---- ------- -----------
    ---------------------
  ---

----------- --------- ------------- ------ ---------- ---------- ------- --
  ----------- -- -
    --------------- ------ ------ ---------
    ---------------------
  ---

运行以上代码，将会在控制台输出包含 facebook/react 代码库信息，带有 webpack 关键字的代码库信息以及符合指定条件的代码库信息。

结束语

使用 github-repositories 包可以让我们更方便地使用 GitHub 上的代码库，从而提高我们的工作效率和代码质量。希望本文对你有所帮助，欢迎大家使用和分享。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/making-the-repositories