npm-link

创建包文件夹的符号链接

选择 CLI 版本

概要

npm link [<package-spec>]

alias: ln

描述

这对于安装你自己的东西非常有用，这样你就可以在上面工作并进行迭代测试，而无需不断地重新构建。

包链接是一个两步过程。

首先，在没有参数的包文件夹中运行 npm link 将在全局文件夹 {prefix}/lib/node_modules/<package> 中创建一个符号链接，该链接指向执行 npm link 命令的包。它还会将包中的任何 bin 链接到 {prefix}/bin/{name}。请注意，npm link 使用全局前缀（见 npm prefix -g 获取其值）。

接下来，在其他位置，npm link package-name 将从全局安装的 package-name 创建一个符号链接到当前文件夹的 node_modules/。

请注意，package-name 取自 package.json，而不是目录名称。

包名称可以可选地以作用域为前缀。见 scope。作用域必须以 @ 符号开头，后面跟着斜杠。

当为 npm publish 创建 tarball 时，如果链接的包包含在 bundleDependencies 中，则会通过解析符号链接将其“快照”到当前状态。

例如

cd ~/projects/node-redis    # go into the package directory
npm link                    # creates global link
cd ~/projects/node-bloggy   # go into some other package directory.
npm link redis              # link-install the package

现在，对 ~/projects/node-redis 的任何更改都将反映在 ~/projects/node-bloggy/node_modules/node-redis/ 中。请注意，链接应指向包名称，而不是该包的目录名称。

你也可以在一个步骤中完成这两个步骤。例如，要以更简短的方式完成上述用例

cd ~/projects/node-bloggy  # go into the dir of your main project
npm link ../node-redis     # link the dir of your dependency

第二行等效于执行

(cd ../node-redis; npm link)
npm link redis

也就是说，它首先创建全局链接，然后将全局安装的目标链接到你的项目的 node_modules 文件夹。

请注意，在这种情况下，你引用的是目录名称，node-redis，而不是包名称 redis。

如果你的链接包是作用域的（见 scope），你的链接命令必须包含该作用域，例如

npm link @myorg/privatepackage

请注意，以这种方式链接的包依赖项不会默认情况下保存到 package.json 中，假设是为了让链接代表一个普通的非链接依赖项。否则，例如，如果你依赖于 redis@^3.0.1 并运行 npm link redis，它将用 file:../path/to/node-redis 替换 ^3.0.1 依赖项，这可能不是你想要的！此外，你的项目中的其他用户或开发人员如果他们的文件夹设置与你的完全不同，就会遇到问题。

如果你要添加一个新依赖项作为链接，你应该通过运行 npm install <dep> --package-lock-only 将其添加到相关的元数据中。

如果你想将 file: 引用保存到 package.json 和 package-lock.json 文件中，你可以使用 npm link <dep> --save 来完成。

工作区使用

npm link <pkg> --workspace <name> 将将相关包链接为指定工作区（或工作区）的依赖项。请注意，如果不存在冲突的依赖项，它实际上可能被链接到父项目的 node_modules 文件夹。

npm link --workspace <name> 将创建一个指向指定工作区（或工作区）的全局链接。

配置

`save`

默认：true，除非使用 npm update，在这种情况下默认值为 false
类型：布尔值

将安装的包保存到 package.json 文件作为依赖项。

与 npm rm 命令一起使用时，会从 package.json 中删除依赖项。

如果设置为 false，也将阻止写入 package-lock.json。

`save-exact`

默认：false
类型：布尔值

保存到 package.json 的依赖项将使用精确版本进行配置，而不是使用 npm 的默认 semver 范围运算符。

`global`

默认：false
类型：布尔值

以“全局”模式运行，因此包将安装到 prefix 文件夹中，而不是当前工作目录。有关行为差异的更多信息，请参见文件夹。

包将安装到 {prefix}/lib/node_modules 文件夹中，而不是当前工作目录。
bin 文件链接到 {prefix}/bin
手册页链接到 {prefix}/share/man

`install-strategy`

默认值：“hoisted”
类型：“hoisted”、“nested”、“shallow” 或 “linked”

设置在 node_modules 中安装包的策略。hoisted（默认）：将非重复项安装到顶层，并在目录结构中根据需要重复安装。nested：（以前称为 --legacy-bundling）就地安装，不提升。shallow：（以前称为 --global-style）仅在顶层安装直接依赖项。linked：（实验性）安装在 node_modules/.store 中，就地链接，不提升。