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

1

在这个路径中执行:

npm init -f

1

执行之后,目录中生成了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"

}

1

2

3

4

5

6

7

8

9

10

11

12

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

"bin": "bin/foo"

1

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

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

#!/usr/bin/env node

console.log('foo run success');

1

2

3

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

node bin/foo

1

接下来,执行链接命令:

npm link

1

可以看到输出内容为:

...

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

1

2

3

4

5

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

tool

1

使命令在全局环境可运行,这就是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'

1

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

ECHO "from cmd"

1

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

最后总结一下:

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342

推荐阅读更多精彩内容