如何从 GitHub 上直接安装 npm 包

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

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

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

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

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

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

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

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

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

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

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

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

接下来，我们来看一下具体的安装步骤。

步骤 1：找到 GitHub 仓库的地址

首先，要从 GitHub 上安装 npm 包，我们需要找到该仓库的地址。一般而言，我们可以直接在 npm 的包列表中找到该仓库的地址。

例如：

$ npm install https://github.com/user/repo.git

其中，https://github.com/user/repo.git 就是该仓库的地址。

步骤 2：从 GitHub 上 clone 该仓库

然后，我们需要使用 git 命令从 GitHub 中 clone 该仓库。这可以通过下面的命令完成：

$ git clone https://github.com/user/repo.git

该命令会将仓库中的代码 clone 到本地。

步骤 3：安装依赖

最后，我们需要进入到该仓库目录中，并运行 npm install 命令安装依赖。

$ cd repo
$ npm install

此时，npm 会读取该仓库中的 package.json 文件，并自动安装其依赖关系。

需要注意的是，在使用 git clone 命令后，我们得到的仅仅是该仓库的代码，该代码并没有发布到 npm 上。因此，如果我们想要发布自己的 npm 包，需要在该仓库中创建注册表文件（registry file）或者使用其他方法将其发布到 npm 上。

综上所述，从 GitHub 上安装 npm 包需要注意一些细节，并确保该仓库包含 package.json 文件。此外，我们也需要知道该仓库的访问权限，以避免出现安装错误。在正确理解这些细节后，我们就可以从 GitHub 安装自己需要的 npm 包了。