npm install --global or --save-dev, it's a question

npm

一句话

如果你需要安装的带有CLI的npm包被某个项目依赖,请尽量使用--save-dev而不要使用--global安装。

引子

在我们启动一个前端项目时,总会用到一些 npm 上的带有 CLI 的包(package),我们在命令行下把这些包当作全局的系统命令来使用。比如 babel-cliexpress-generatorbrowserify 等等。我们往往在需要使用它们时这样做:

npm install -g babel-cli

之后,我们就理所当然的使用它们了:

babel script.js -o script-compiled.js

可是,这样真的好吗?

你在这样做时,也隐隐约约感觉到,这或许有些“脏”(dirty),有点像是泛滥的全局对象。

剥开看看

这种感觉没有错,拿 OSX 举例来说,如果我们使用 npm bin -g 来查看npm的全局包都装到哪了,会得到这样的结果:

/usr/local/bin

这个目录是系统中用来存放需要本地全局使用的二进制可执行文件的地方,属于系统环境的一部分,往往不仅仅被某个或某些应用依赖。

问题在哪

我们将带有CLI的npm包分为两类(非等价类):

  • 工程级
  • 系统级

如果我们仅仅是在现在的(或将来)某个项目中打算使用它,那么这类包更偏向于 工程级。比如之前文中提到的 browserifybabel-cli

如果我们更需要将它作为系统中的应用,而不限于在某个 Node.js 项目中依赖它,那么这类包更偏向于 系统级。比如 作为Node.js版本管理器的n

更直接一点说,如果某个npm包不被任何项目或应用依赖,那么它即属于 系统级

对于工程级的npm包,如果我们进行全局安装,那么会带来两个问题:

  • 全局安装的包会作为系统环境的一部分,但同一系统下的不同项目可能对于其依赖版本不同。
  • 项目在迁移或更换环境时,没有显性的依赖表明新环境需要该npm包

如何解决

npm 提供了一种针对于开发过程中依赖的安装方法:

npm install --save-dev <package>

使用这种方法安装的包,会在 package.json中被显性指出在 devDependencies中:

{
  "name": "my_package",
  "version": "1.0.0",
  "dependencies": {
    "my_dep": "^1.0.0"
  },
  "devDependencies" : {
    "my_test_framework": "^3.1.0"
  }
}

但这还有一个问题,如果使用 npm install --save-dev 安装的包,如何在项目中使用CLI呢?

首先,通过 --save-dev 安装的包的可执行文件都被放到了项目中的 ./node_modules/.bin/ 中。所以,我们可以通过该目录执行需要本地运行的CLI命令,比如:

./node_modules/.bin/babel script.js -o script-compiled.js

更进一步,我们也可以把命令放入package.jsonscripts中,比如:

{
    ...
    "scripts": {
        "babel": "babel"
    }
}

因为npm会在执行时首先检查当前项目中的 ./node_moduels/.bin/ 目录,这样在执行时只需要输入:

npm run babel -- script.js -o script-compiled.js

注意,传递参数前需要加 --

另外,还可以把 ./node_modules/.bin/ 加入到系统环境变量 PATH 中,但这样只能在包含 node_modules 的项目目录下使用CLI命令。这种做法其实更加增多了项目对系统环境的隐性依赖,不推荐。

结论

古人有云:“两害相较,则取其轻”。相比之前全局安装,使用 --save-dev 安装的npm包,在执行CLI命令时的确会比较麻烦,但这样做的好处也是显而易见且更为重要的,而对于增加的使用成本,另有许多成熟方法可以解决。在我们使用npm时,对于 工程级系统级 的包的区分有时并不是那么明显,希望通过这篇文章能让大家意识到使用全局安装的意义,并在管理项目依赖时多一些思考。

参考

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

推荐阅读更多精彩内容