如何从 GitHub 上直接安装 npm 包

开发运维 2023-08-02 向阳逐梦 手机阅读

最近，有很多人问如何从 GitHub 上安装 npm 包。在这篇文章中，我们将简要介绍如何从 GitHub 上直接安装 npm 包，并且介绍一些需要注意的点。

首先，我们需要清楚从 GitHub 上安装 npm 包的一个基本原理：npm 会将 GitHub 上的仓库代码 clone 到本地，然后运行 npm install 命令安装该仓库中的 npm 包。因此，当我们从 GitHub 上安装 npm 包时，需要注意以下几点：

  • 先确认你使用的 npm 版本是否支持从 Github 安装依赖

    • 从 npm 的官方文档可知，从 npm 5.0.0 版本开始，npm 自带了支持从 GitHub 安装依赖的功能。因此，如果你的 npm 版本不够新，建议先升级 npm 的版本。

  • GitHub 上的仓库中必须包含 package.json 文件

    • 在介绍如何从 GitHub 上安装 npm 包前，我们要先提醒一点：我们只能从一个包含 package.json 文件的 GitHub 仓库上安装 npm 包。否则，npm 将无法确定该仓库中的包依赖关系，无法正确安装依赖。

    因此，当我们想要从 GitHub 上安装 npm 包时，需要先在该仓库中检查是否包含 package.json 文件。一般而言，GitHub 的仓库中都会包含这个文件。如果没有，就需要找其他能安装的渠道。

  • GitHub 仓库所在位必须是公共的或者需要认证

    • 在默认情况下，npm 是无法从未认证的私有仓库上下载依赖的。因此，当我们从 GitHub 上安装 npm 包时，需要知道该仓库所在位置的访问权限：

    • 如果该仓库是公共的，那么我们可以直接从 GitHub 上安装。

    • 如果该仓库位于私有仓库中，我们有两种方式安装：

      • 将该私有仓库加入到 npm 的 .npmrc 文件中，同时登录到该私有仓库。
      • 使用 GitHub Personal Access Token 来访问私有仓库。这需要从 GitHub 帐户中生成 Personal Access Token，并将其用作命令行参数。