如何使用私有 Github repo 作为 NPM 依赖

在开发过程中，我们可能需要使用一些私有的 Github repo，但是这些 repo 并没有提供 NPM 包供我们使用。本文介绍如何将私有 Github repo 作为 NPM 依赖使用。

生成 access token

首先我们需要生成一个 Github access token，用于身份验证。在生成 access token 时，需要勾选 repo 以及 read:packages 两个权限，同时需要选择 write:packages 权限如果希望将自己的包发布到 Github Packages 中。

配置 .npmrc

在使用私有 Github repo 作为 NPM 依赖前，我们需要配置 .npmrc 文件。在命令行中输入以下命令：

npm login --scope=@my-org --registry=https://npm.pkg.github.com

其中 my-org 是我们的 Github 组织或用户名，https://npm.pkg.github.com是 Github Packages 的 registry 地址。

在执行完该命令后，会要求输入 Github 用户名、access token 以及邮箱信息。在输入完信息后，会在用户目录下生成 ~/.npmrc 文件，并将相关认证信息写入该文件中。

安装私有 Github repo 作为 NPM 依赖

在配置好 .npmrc 文件后，我们可以像安装一般 NPM 包一样，安装私有 Github repo 作为 NPM 依赖。在命令行中输入以下命令：

npm install @my-org/my-package

其中 my-org 是 Github 组织或用户名，my-package 是 Github repo 的名称。

如果 Github repo 是一个私有 repo，则需要在 package.json 文件中指定访问权限。在 dependencies 或 devDependencies 部分中添加以下信息：

{
  "dependencies": {
    "@my-org/my-private-package": "github:my-org/my-private-package#semver:^1.0.0"
  }
}

其中 semver:^1.0.0 是指定 Github repo 的版本号范围。

总结

通过以上步骤，我们可以使用私有 Github repo 作为 NPM 依赖。需要注意的是，在使用私有 repo 作为 NPM 依赖时，我们需要生成 access token 并配置 .npmrc 文件，同时需要在 package.json 文件中指定访问权限。