跳到主要内容

npm 1.0: 链接

Isaac Schlueter

npm 1.0 处于发布候选模式。快去获取!

在 npm 0.x 中,有一个名为 link 的命令。有了它,你可以“链接安装”一个包,使更改能够实时反映出来。在你真正在构建东西时,这尤其方便。你可以做几处修改,再次运行该命令,瞧,新代码就会运行,而不必每次都重新安装。

当然,编译后的模块仍然必须重新构建。这并不理想,不过这是一个需要更强大魔法才能解决的问题。

在 npm 0.x 中,这是一个相当糟糕的权宜之计。那时,每个包都存在于类似下面这样的文件夹中:

prefix/lib/node/.npm/my-package/1.3.6/package

并且包的版本和名称可以从路径中推断出来。然后,会建立类似下面这样的符号链接:

prefix/lib/node/my-package@1.3.6 -> ./.npm/my-package/1.3.6/package

把这个符号链接指向另一个位置很容易。不过,由于 package.json 文件可能会变化,版本和文件夹之间的关联并不可靠。

起初,我们只是通过说“如果更改版本,就重新链接”来处理这个问题。然而,随着越来越多的边缘情况出现,最终的解决方案是给链接包赋予这个“9999.0.0-LINK-hash”式的假版本,以便 npm 知道它是冒牌货。有时,这个包会被当作具有 9999.0.0 版本;有时,又会被当作具有 package.json 中指定的版本。

更好的方式

对于 npm 1.0,我们退后一步,审视了实际的使用场景。大多数时候,当你链接某个东西时,想要的是以下之一:

  1. 全局安装我正在开发的这个包,这样我就可以运行它创建的命令,并在开发过程中测试它的功能。
  2. 将我的东西本地安装到某个依赖它的_其他_东西中,以便另一个东西可以 require() 它。

而且,在这两种情况下,更改都应该立即显现,并且不需要任何重新链接。

另外,还有第三个使用场景,直到我开始编写更多、依赖也更多的程序时,我才真正意识到它:

  1. 全局安装某个东西,在一堆项目的开发过程中使用它,然后一次性全部更新,让它们都使用最新版本。

实际上,上面的第二种情况是这第三种情况的特例。

链接开发版 → 全局

第一步是将你的本地项目链接到全局安装空间。(关于这种全局/本地机制,请参阅全局安装与本地安装。)

我在开发 node 项目时会这么做(包括 npm 本身)。

cd ~/dev/js/node-tap  # go into the project dir
npm link              # create symlinks into {prefix}


由于我的电脑配置方式——以 /usr/local 作为安装前缀——最终会得到一个从 /usr/local/lib/node_modules/tap 指向 ~/dev/js/node-tap 的符号链接,以及链接到 /usr/local/bin/tap 的可执行文件。

当然,如果你以不同的方式设置路径,那么结果也会不同。(这就是为什么我倾向于用 prefix 而不是 /usr/local 来表述。)

全局 → 本地链接

当你想把已全局安装的包链接到本地开发文件夹时,运行 npm link pkg,其中 pkg 是你想要安装的包名。

例如,假设我想为我的 node-glob 包编写一些 tap 测试。我会 先 执行上面的步骤,把 tap 链接到全局安装空间,然后 再这样做:

cd ~/dev/js/node-glob  # go to the project that uses the thing.
npm link tap           # link the global thing into my project.


现在,当我在 ~/dev/js/node-tap 中做出更改时,它们会立即反映在 ~/dev/js/node-glob/node_modules/tap 中。

链接到你 不 构建的内容

假设我有 15 个站点都使用 express。我希望获得本地开发的好处,但也希望能够一次性更新所有开发文件夹。你可以全局安装 express,然后将它链接到你的本地开发文件夹中。

npm install express -g  # install express globally
cd ~/dev/js/my-blog     # development folder one
npm link express        # link the global express into ./node_modules
cd ~/dev/js/photo-site  # other project folder
npm link express        # link express into here, as well

                        # 时光流逝
                        # TJ 发布了一些新东西。
                        # 你想要这个新东西。

npm update express -g   # update the global install.
                        # 这也会更新我的项目文件夹。


注意事项:不适用于真实服务器

npm link 是一个开发工具。它 非常适合 用于在本地开发机上管理包。但使用 npm link 进行部署基本上就是在自找麻烦,因为它会让人非常容易在不知不觉中更新内容。

注意事项 2:抱歉,Windows!

我非常怀疑原生 Windows 的 node 是否真能拥有与 Unix 系统所提供的相当的符号链接支持。我知道有 junction 之类的东西,也听说过关于 Windows 7 上符号链接的传说。

当出现 Node 的原生 windows 移植版时,如果这个原生 windows 移植版对 fs.symlink 和 fs.readlink 的支持与它们在 Unix 上的工作方式完全一致,那么这应该可以正常工作。

不过我可不抱太大期望。任何关于它在原生 Windows 系统(即非 Cygwin)上无法正常运行的 bug,都很可能会被以 wontfix 关闭。

旁注:功劳该归谁就归谁

早在 Node 0.1 时期那场伟大的包管理大战之前,在 npm、kiwi、mode 或 seed.js 还几乎干不了什么的时候,更不用说它们当中任何一个的用户数都还没超过 2 个的时候,Mikeal Rogers 邀请我去 Couch.io 的办公室吃午饭,聊我提过想做的那个 npm 注册表小玩意儿。(也就是说,是为了说服我用 CouchDB 来做它。)

既然他自告奋勇要来做它的第一个版本,而且 couch 对这个用例来说几乎就是理想选择,我很容易就被说服了。

我在那儿的时候,他说:“听着。你得能把一个项目目录链接进来,就好像它已经作为一个包安装好了一样,然后让这一切都能开箱即用。你能做到吗?”

我当时回道:“嗯,我不知道…我是说,有这些边界情况,而且它跟现有的文件夹结构也不太吻合…”

“哥们。要么你来做,要么我就得自己做,然后 node 里就会多出 another 个包管理器,而不是为 npm 写注册表了,而且反正也做得没那么好。别搞得跟 python 似的。”

剩下的就是历史了。