返回

万物皆可“npm link”，用npm link的11种方法

前端

深入探讨 npm link：一个方便的包链接实用工具

简介

npm link 是一种由 Node.js 包管理器 npm 提供的强大工具，它允许开发者在项目之间无缝链接 npm 包。这种机制使你可以轻松地在不同的项目中共享和测试正在开发的包，而无需将其发布到 npm 注册表。

npm link 的工作原理

当使用 npm link 命令时，它会在项目目录中创建一个软链接，将本地包链接到目标包的 node_modules 目录。这允许目标项目直接访问源包的代码，而无需将其安装为依赖项。

npm link 的 11 种强大用法

1. 将本地包链接到另一个项目

这种用法是最常见的，允许你将正在开发的包链接到其他项目进行测试或使用。

示例：

project-a/
  └───node_modules/
        └───my-package/

project-b/
  └───node_modules/

在项目 A 中运行：

npm link

在项目 B 中运行：

npm link my-package

现在，项目 B 可以访问项目 A 中 my-package 包的代码。

2. 将全局包链接到另一个项目

你还可以将全局安装的包链接到另一个项目。

示例：
在命令行中运行：

npm link -g my-package

在项目 B 中运行：

npm link my-package

现在，项目 B 可以访问全局安装的 my-package 包。

3. 将远程包链接到另一个项目

远程包也可以通过 npm link 链接。

示例：
在项目 B 中运行：

npm link my-package

现在，项目 B 可以访问远程安装的 my-package 包。

4. 将多个包链接到另一个项目

你可以同时链接多个包。

示例：

project-a/
  └───node_modules/
        └───my-package-1/
        └───my-package-2/

project-b/
  └───node_modules/

在项目 A 中运行：

npm link my-package-1 my-package-2

在项目 B 中运行：

npm link my-package-1 my-package-2

现在，项目 B 可以访问 my-package-1 和 my-package-2 包。

5. 将一个包链接到多个项目

一个包可以链接到多个项目。

示例：

project-a/
  └───node_modules/
        └───my-package/

project-b/
  └───node_modules/

project-c/
  └───node_modules/

在项目 A 中运行：

npm link my-package

在项目 B 和 C 中运行：

npm link my-package

现在，项目 B 和 C 都可以访问 my-package 包。

6. 将一个包链接到自身

这种用法允许你在开发和测试包时将其链接到自身。

示例：

project-a/
  └───node_modules/
        └───my-package/

project-a/
  └───src/
        └───main.js

在项目 A 中运行：

npm link my-package

在项目 A 中运行：

node src/main.js

现在，你可以开发和测试 my-package 包。

7. 使用别名链接一个包

别名可用于链接包的不同版本。

示例：

project-a/
  └───node_modules/
        └───my-package@1.0.0/

project-b/
  └───node_modules/
        └───my-package@2.0.0/

在项目 A 中运行：

npm link my-package@1.0.0

在项目 B 中运行：

npm link my-package@2.0.0

现在，项目 A 可以使用 my-package 包的 1.0.0 版本，而项目 B 可以使用 2.0.0 版本。

8. 使用 glob 模式链接多个包

glob 模式可用于链接目录下的所有包。

示例：

project-a/
  └───node_modules/
        └───package-1/
        └───package-2/
        └───package-3/

project-b/
  └───node_modules/

在项目 A 中运行：

npm link .

在项目 B 中运行：

npm link ../project-a/*

现在，项目 B 可以访问项目 A 中的所有包。

9. 使用 --production 选项链接一个包

该选项用于忽略开发依赖项。

示例：

project-a/
  └───node_modules/
        └───my-package/
            └───package.json
                └───dependencies
                    └───dev-dependency-1

project-b/
  └───node_modules/

在项目 A 中运行：

npm link my-package --production

在项目 B 中运行：

npm link my-package

现在，项目 B 可以使用 my-package 包，但不使用其开发依赖项。

10. 使用 --only-production 选项链接一个包

该选项用于仅包含生产依赖项。

示例：
在项目 A 中运行：

npm link my-package --only-production

在项目 B 中运行：

npm link my-package

现在，项目 B 可以使用 my-package 包，但只使用其生产依赖项。

11. 使用 --no-save 选项链接一个包

该选项用于不将包添加到 package.json 的依赖项中。

示例：

project-a/
  └───node_modules/
        └───my-package/

project-b/
  └───node_modules/

在项目 A 中运行：

npm link my-package --no-save

在项目 B 中运行：

npm link my-package

现在，项目 B 可以访问 my-package 包，但它不会被添加到 package.json 中。

结论

npm link 是一个功能强大的工具，可以极大地简化 npm 包的开发和测试。通过理解其用法，你可以更有效地利用此工具，并加速你的开发工作流程。

常见问题解答

  • npm link 会影响生产环境中的依赖项吗？
    不，npm link 仅在开发环境中链接包。

  • 我该如何断开链接的包？
    运行 npm unlink <package-name> 命令。

  • npm link 与 npm install 有何不同？
    npm link 链接本地包，而 npm install 从 npm 注册表安装远程包。

  • 是否可以在不同的操作系统上使用 npm link？
    是的，npm link 在 Windows、macOS 和 Linux 上都可以使用。

  • npm link 是否安全？
    只要你信任源代码，npm link 是安全的。