首页 > 建站教程 > nodejs,electron >  npm link 命令的作用浅析正文

npm link 命令的作用浅析

npm link命令可以将一个任意位置的npm包链接到全局执行环境,从而在任意位置使用命令行都可以直接运行该npm包。

那么,当运行npm link时发生了什么?

下面就以Windows平台为例来展示它的处理过程。


简要地讲,这个命令主要做了两件事:

  • 为npm包目录创建软链接,将其链到{prefix}/lib/node_modules/<package>

  • 为可执行文件(bin)创建软链接,将其链到{prefix}/bin/{name}


以上两个路径是官方文档给出的路径,这两个路径是Linux平台上的。在Windows平台中,这两个路径为:

  • 目录: C:\Users\{Username}\AppData\Roaming\npm\node_modules\<package>

  • 文件: C:\Users\{Username}\AppData\Roaming\npm\<name>


并且对于可执行文件(bin)的处理并不仅仅创建了文件的软链接。接下来通过一个实例来看一下。


首先,创建如下目录:

C:\code\tool


在这个路径中执行:

npm init -f


执行之后,目录中生成了package.json文件,用编辑器打开它,其内容为:

{
  "name": "tool",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}


在里面添加一个字段,表示本npm包的可执行文件位于bin/foo:

"bin": "bin/foo"


在C:\code\tool中创建目录bin, 并在bin中创建文件foo,这便是本npm包的可执行文件。


用编辑器打开foo,输入代码并保存:

#!/usr/bin/env node
console.log('foo run success');


在C:\code\tool中执行以下命令可看到输出foo run success:

node bin/foo


接下来,执行链接命令:

npm link


可以看到输出内容为:

...
C:\Users\{Username}\AppData\Roaming\npm\tool -> C:\Users\{Username}\AppData\Roaming\npm\node_modules\tool\bin\foo
C:\Users\{Username}\AppData\Roaming\npm\node_modules\tool -> C:\code\tool


此时,在任意一个位置执行以下命令都可以看到输出foo run success:

tool


使命令在全局环境可运行,这就是npm link的作用了。


此时进入到C:\Users\{Username}\AppData\Roaming\npm\node_modules\中发现有个名为tool的目录,从其图标可以看出它类似一个快捷方式,实际是一个软链接,指向C:\code\tool。


而在C:\Users\{Username}\AppData\Roaming\npm\中可看到有以下两个文件:

tool
tool.cmd


之所以这里生成的文件叫tool,是因为package.json中的name字段值为tool,而name字段的值又是执行npm init -f时根据目录名确定的。


tool文件里是一段Shell脚本,而tool.cmd里是一段cmd脚本,两者的作用都是去调用C:\Users\{Username}\AppData\Roaming\npm\node_modules\tool\bin\foo这个可执行文件。


由此可以合理推测:

tool文件是在git-bash之类的工具中执行tool命令时运行的脚本

tool.cmd文件是在Windows的CMD中执行tool命令时运行的脚本


打开tool文件,在倒数第二行加上一句

echo 'from shell'


再打开tool.cmd文件,在最后一行加上一句

ECHO "from cmd"


保存之后,分别在 git-bash 和 cmd 中执行tool命令,便可以发现 git-bash 中输出foo run success之后又输出了from shell,而cmd中输出foo run success之后又输出了from cmd,证明推论正确。


最后总结一下:

npm link命令通过链接目录和可执行文件,实现npm包命令的全局可执行。