包和模块

了解一个生态系统的关键是学习它的词汇。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()的参数。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容