包和模块

了解一个生态系统的关键是学习它的词汇。Node.js和npm有一个非常特别的包和模块的定义,很容易弄混淆。我们会在这里讨论这些定义,使他们截然不同,并且解释为什么这些默认的文件是这样命名的。

tr;dr

  • 包是一个文件或者一个目录在package.json里描述的。这可以发生在很多不同的方式里。
  • 模块是一个任何文件或者目录可以通过Node.js' require()加载的。同样,有各种方式做到这种。

什么是包

包可以是下面的任何一种:

  • a) 一个目录包含一个被package.json文件描述的程序
  • b) 一个包含(a)的gzip压缩文件
  • c) 一个指向(b)的url
  • d) 一个带着(c)的发布到registry的<name>@<version>
  • e) 一个<name>@<tag>指向(d)
  • f) 一个有着latest标记满足(e)的<name>
  • g) 一个cloned的giturl,就成为了(a)这样

看到所有的这些package可能,因此,即使你没有发布你的包到公共注册中心,依然可以通过使用npm获取很多好处:

  • 如果你仅仅想写一个node程序,and/or
  • 如果也想在打包成一个压缩文件后容易的安装

Git urls可以是这种形式:

git://github.com/user/project.git#commit-ish
git+ssh://user@hostname:project.git#commit-ish
git+http://user@hostname/project/blah.git#commit-ish
git+https://user@hostname/project/blah.git#commit-ish

commit-ish可以是任何tag,sha或者branch可以应用作为git checkout的参数。默认的是master

什么是模块

模块是一个可以在Node.js程序里通过require()加载的anything.下面的所有的例子可以被加载成模块:

  • package.json文件里包含一个main字段
  • 文件夹里有 index.js
  • 一个javascript文件

大多数的包是模块

一般地,在Node.js程序里使用的npm package被require加载,就是一个模块。但是,没有要求npm 包就是一个模块。

一些模块,比如:cli包仅仅包含一个可执行的命令行接口,并且没有为Node.js程序提供main字段。这些包就不是一个模块。

大多数npm包(至少在Node程序里)里面包含很多模块(因为每个使用require()加载的就是一个模块)。

在Node程序里的上下文,module同样是一个从文件加载。比如,在下面的程序:

var req = require('request');

我们可以说

变量req指向request模块

在Node.js和npm生态系统里的文件和目录名

  • 所以,为什么是node_modules文件夹,但是package.json文件
  • 为什么不是node_packages或者module.json?

package.json文件定义包。
node_modules文件夹是Node.js寻找模块的地方。
比如,如果在node_module/foo.js创建一个文件,然后写上var f = require('foo.js'),他就会加载模块。但是,foo.js在这个例子里不是包,因为没有package.json

还有就是,如果创建的包里不包含index.js或者package.json里不包含main字段,它也不是模块。即使被安装在node_modules,不会被作为require()的参数。

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

推荐阅读更多精彩内容