npm 包 @sergioalonso.es/github-miner 使用教程

背景

GitHub 是全球最大的开源软件开发平台，数百万开发者积极地在此交流代码、创建项目、并协助开发更好的解决方案。GitHub 的数据也因此成为了一个重要的数据来源，可以用于分析行业趋势、项目健康度、个人贡献度等等。

@sergioalonso.es/github-miner 是一个 npm 包，它提供了一种轻松、快速地获取 GitHub 数据的方式。有了这个包，你可以使用 GitHub 的 REST API 和 GraphQL API 获取数据，支持多种数据获取和筛选方式。

在这篇文章中，我们将深入了解 @sergioalonso.es/github-miner，包括如何安装它、如何在项目中使用它，以及如何进行高级数据筛选。

安装

你可以使用 npm 在你的项目中安装 @sergioalonso.es/github-miner：

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

接着你可以在你的代码中引入它：

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

使用

通过 GithubMiner 类，我们可以使用 GitHub 的 REST API 和 GraphQL API 获取数据。不要忘记在使用之前设置你的 GitHub 凭证，这可以在你的代码中指定：

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

获取用户信息

获取用户信息可以使用 REST API，例如我们想获取 user001 的信息：

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

你将看到类似下面的输出：

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

获取仓库信息

获取仓库信息同样可以使用 REST API，例如获取 sergioalonso.es/github-miner 的信息：

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

你将看到类似下面的输出：

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

获取仓库的 commits

使用 GraphQL API 可以获取仓库的 commits。以下代码将获取 sergioalonso.es/github-miner 的最近 10 条 commit：

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

你将看到类似下面的输出：

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

获取仓库的 fork 数

这里我们来演示一下如何使用 GraphQL API，筛选 fork 数。以下代码将获取 sergioalonso.es/github-miner 的 fork 数：

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

你将看到类似下面的输出：

-

获取用户或组织下的所有成员

同样是使用 GraphQL API，以下代码将获取 sergioalonso.es 组织下所有的成员：

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

你将看到类似下面的输出：

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

高级使用

在查询中使用参数

在上面的例子中，我们是使用 query string 传递参数的。但是在某些情况下，我们会想要在查询中使用参数。这需要使用 GraphQL API，以下是一个例子：

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

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

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

我们通过 query 变量中的 $organizationName 定义了一个参数，在 variables 中传递变量值。这里我们使用了 query 方法，该方法允许我们使用 GraphQL API。

支持多种数据筛选方式

GitHub 的 API 支持多种数据筛选方式，包括：分页、排序、筛选等。我们可以通过 GithubMiner 的方法传递这些参数，以下是一个例子：

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

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

在这个例子中，我们获取的是 sergioalonso.es/github-miner 的最近 10 条 commit，并且使用了 author、since、until 参数进行筛选。你可以在 官方文档 中找到更多参数。

总结

在这篇文章中，我们深入了解了 @sergioalonso.es/github-miner，包括安装、使用、高级使用。通过使用该 npm 包，我们可以轻松获取 GitHub 的数据，包括用户信息、仓库信息、commits 信息等等。同时，我们也可以使用 REST API 和 GraphQL API 实现高级数据筛选，提高了数据的准

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005543e81e8991b448d1919

阅读全文

猜你喜欢

  • npm 包 react-scrollable-tab-view 使用教程

    在前端开发中，有时我们需要实现类似选项卡的内容切换效果，react-scrollable-tab-view 是一个优秀的 npm 包，它可以帮助我们实现可滚动的选项卡组件。

    2 年前
  • npm 包 youtube-castv2-client 使用教程

    引言 本文主要介绍 npm 包 youtube-castv2-client 的使用方法。如果你是一个前端开发者，想要将 Youtube 视频投放到你的 Chromecast 设备上，或者你正在学习如何...

    2 年前
  • npm 包 fis3-deploy-exit 使用教程

    fis3-deploy-exit 是一个基于 fis3 的部署插件，可以在 fis3 部署过程中检测是否有文件未上传，如果有则中断部署，打印出未上传的文件列表，让用户可以及时处理文件，避免因为文件遗漏...

    2 年前
  • npm 包 fis3-release-exit 使用教程

    前言 在前端开发中，我们经常会用到构建工具来自动化打包、压缩等操作，其中 fis3 是一个非常流行的构建工具，它可以高效地完成从源代码到最终产物的构建过程。 在 fis3 中，利用插件机制可以方便地扩...

    2 年前
  • npm 包 lqjs 使用教程

    在前端开发中，我们时常需要使用各种库和工具，而 npm （Node.js 包管理器）是前端最常用的包管理器之一。今天我们来介绍一个实用的 npm 包 lqjs，它能帮助我们更快地搭建前端项目并提供各种...

    2 年前
  • npm包search-google使用教程

    引言 如果你正在开发一个 Web 应用并需要引入搜索引擎到你的应用程序中，那么 search-google 这个 npm 包就是你需要的。 在本文中，我们将会学习如何使用 search-google，...

    2 年前
  • npm 包 spodl 使用教程

    前言 npm 包 spodl 是一个可以将 Spotify 歌单和专辑以 mp3 格式下载到本地的命令行工具。它可以帮助用户将喜欢的音乐保存到本地，方便离线收听。本文将会详细介绍 spodl 的使用方...

    2 年前
  • npm 包 @clicksion/angular2 使用教程

    @clicksion/angular2 是一个用于 Angular2 的支持开发和构建 Web 应用程序的 npm 包。它提供了一些相关功能和组件，可以极大地便利前端开发人员的工作。

    2 年前
  • npm 包 aalsi 使用教程

    简介 aalsi 是一个方便前端开发的 npm 包，可以解决需要在不同浏览器以及终端上进行测试调试的难题，同时支持用户自定义配置。 安装 可以通过以下命令安装 aalsi： --- ------- -...

    2 年前
  • npm 包 lionsoft-common-tools 使用教程

    随着前端技术的不断发展，我们的工作变得越来越复杂。而 npm 包的引入则成为我们提高工作效率，提高代码质量的重要途径之一。lionsoft-common-tools 就是这样一个功能强大的 npm 包...

    2 年前
  • npm包ng2-ring-chart使用教程

    介绍 ng2-ring-chart是一个Angular2+的环形图表组件，使用简单，可定制性强，在web应用中使用广泛。 安装 在项目根目录下使用npm安装： --- ------- --------...

    2 年前
  • npm包gulp-graceful-error使用教程

    前言 在前端开发中，经常会用到gulp自动化构建工具来提高开发效率，而在使用gulp的过程中，我们也经常会用到相关的npm包来增强gulp的功能。本篇文章介绍的是npm包gulp-graceful-e...

    2 年前
  • npm 包 pure-typography-i 使用教程

    简介 pure-typography-i 是一个提供基于现代 CSS 网格的响应式排版样式表的 npm 包。它的主要特点包括： 基于现代 CSS 网格，适应性强，适用于各种设备 提供了多种样式组合方...

    2 年前
  • npm 包 redux-react-session-immutable 使用教程

    前言 当我们在使用 React 和 Redux 开发应用时，随着代码复杂度的提升，我们往往需要一个中心化的管理工具来存储应用的状态数据。Redux 是一种管理应用状态的流行方式，其基本思路是使用单一的...

    2 年前
  • npm 包 hologram-node 使用教程

    在前端开发中，代码的可维护性和可读性是非常重要的，而好的文档可以帮助开发者更好地理解和维护代码。Hologram 是一个能够自动生成文档的工具，然而 Hologram 的使用需要一定的学习和配置，因此...

    2 年前
  • npm 包 zenypass-account-model 使用教程

    简介 zenypass-account-model 是一个可以用于前端开发的 npm 包，用于管理用户账户的模型层，提供了包括账号创建、账号密码更新、删除、查询等方法，能够方便地与后端接口进行交互。

    2 年前
  • npm 包 clean-files 使用教程

    在前端开发中，我们经常需要删除一些生成的文件或者旧文件，或者清空某个文件夹，以便于下一次的构建或者打包。手动进行这些操作不光麻烦，而且容易犯错。为了解决这个问题，我们可以使用 npm 包 clean-...

    2 年前
  • npm 包 email-multiplexer 使用教程

    在日常的开发中，邮件服务经常是企业和个人需要用到的功能之一。如果我们需要给不同的收件人发送不同的邮件，可能需要写很多的邮件模板和发送邮件的逻辑，这个过程可能较为繁琐。

    2 年前
  • npm 包 hostify 使用教程

    在 Web 开发中，我们时常会需要测试一个网站在不同环境下的表现，比如在 localhost 或者特定的 IP 地址下查看是否能正常访问，但是每次手动更改 hosts 文件太繁琐。

    2 年前
  • npm 包 simple-exec-promise 使用教程

    前言 在前端开发过程中，经常需要执行一些命令行指令，例如构建项目、部署应用等。而在 JavaScript 中，我们可以通过 child process 模块来执行这些指令。

    2 年前

相关推荐

    暂无文章