快捷搜索:

Node.js入门:包结构

来源:http://www.shanghai-sourcing.com 作者:真人注册 人气:127 发布时间:2019-12-23
摘要:   JavaScript缺少包布局。CommonJS致力于更改这种现状,于是定义了包的组织正式()。而NPM的产出则是为着在CommonJS规范的根底上,落成化解包的设置卸载,信任管理,版本管理等主题材

    JavaScript缺少包布局。CommonJS致力于更改这种现状,于是定义了包的组织正式( )。而NPM的产出则是为着在CommonJS规范的根底上,落成化解包的设置卸载,信任管理,版本管理等主题材料。require的找寻体制明了从此以后,大家来看一下包的内部原因。

Node.js入门:包结构。    二个顺应CommonJS标准的包应该是之类这种布局:

  • Node.js入门:包结构。二个package.json文件应当留存于包一级目录下 
  • 二进制文件应该包罗在bin目录下。 
  • JavaScript代码应该包蕴在lib目录下。 
  • 文书档案应该在doc目录下。 
  • Node.js入门:包结构。单元测量检验应该在test目录下。

    Node.js在未有找到对象文件时,会将当前目录当做多少个包来尝试加载,所以在package.json文件中最要害的贰个字段正是main。而实质上,那生龙活虎处是Node.js的扩大,标准定义中并不包罗此字段,对于require,只须求main属性就可以。然则在除了这么些之外包须要承担安装、卸载、依赖管理,版本管理等流程,所以CommonJS为package.json文件定义了之类一些供给的字段:

  • name:包名,供给在NPM上是独一无二的。无法带有空格。 
  • description:包简单介绍。平常会来得在有的列表中。 
  • version:版本号。叁个语义化的版本号( ),日常为x.y.z。该版本号拾贰分重视,日常用于一些版本调控的场所。 
  • keywords:关键字数组。用于NPM中的分类寻觅。 
  • maintainers:包维护者的数组。数组成分是四个富含name、email、web五个属性的JSON对象。 
  • contributors:包贡献者的数组。第贰个正是包的小编自个儿。在开源社区,若是提交的patch被merge进master分支的话,就应该加上这几个贡献patch的人。格式满含name和email。
  • bugs:七个得以交给bug的U汉兰达L地址。能够是邮件地址(mailto:mailxx@domain),也可以是网页地址( 
  • licenses:包所使用的许可证。
  • repositories:托管源代码之处数组。 
  • dependencies:当前包需求的依赖。这几个特性十一分主要,NPM会通过那个天性,帮您活动加载信赖的包。

    以下是Express框架的package.json文件,值得参照他事他说加以调查。

1 "name": "express", 
2 "description": "Sinatra inspired web development framework", 
3 "version": "3.0.0alpha1-pre", 
4 "author": "TJ Holowaychuk",

    除了前方提到的多少个必选字段外,我们还开采了后生可畏部分附加的字段,如bin、scripts、engines、devDependencies、author。这里能够入眼聊到一下scripts字段。包微电脑(NPM)在对包举办安装大概卸载的时候要求开展局地编写翻译可能肃清的行事,scripts字段的靶子指明了在张开操作时运维哪个文件,恐怕进行拿条命令。如下为贰个较康健的scripts案例:

1 "scripts": { 
2     "install": "install.js", 
3     "uninstall": "uninstall.js", 
4     "build": "build.js", 
5     "doc": "make-doc.js", 
6     "test": "test.js", 
7 }

    尽管你到家了和煦的JavaScript库,使之完成了CommonJS的包规范,那么您能够透过NPM来揭橥自身的包。

npm publish <folder>

    命令拾分差不离。不过在此在此之前你需求通过npm adduser命令在NPM上注册一个帐户,以便后续包的掩护。NPM会剖判该文件夹下的package.json文件,然后上传目录到NPM的站点上。

    客户在采用你的包时,也不行总的来说:

npm install <package>

    以至对于NPM无法安装的包(因为一些奇异的互联网原因),可以经过github手动下载其安静版本,解压之后通过以下命令进行设置:

npm install <package.json folder>

    只需将路线指向package.json存在的目录就能够。然后在代码中require('package'卡塔尔(英语:State of Qatar)就可以使用。

    Node.js中的require内部流程之复杂,而艺术调用之轻便,实在值得拍桌惊叹。

本文由金沙澳门官网55网址发布于真人注册,转载请注明出处:Node.js入门:包结构

关键词:

上一篇:没有了

下一篇:没有了

最火资讯