npm 包管理器简介

Node包管理器(npm)是一个有Node.js官方提供的第三方包管理工具。npm是一个完全由JavaScript实现的命令行工具,通过Node.js执行,因此严格来说它不属于Node.js的一部分。在Node0.6以前安装完Node需要手动安装npm,后来包含在发行包中。

在介绍NPM之前先介绍CommonJS的包规范。

CommonJS的包规范 

包结构  +  包描述文件

包结构:用于组织包中各种文件。

包描述文件:用于描述包的相关信息,以供外部读取分析

包结构

包实际上是一个存档文件,即一个目录直接打包为zip或tar.gz格式文件,安装后解压还原为目录。完全符合CommonJS规范的包目录应该包含如下

package.json:包描述文件。

bin:用于存放可执行二进制文件的目录

lib:用于存放JavaScript代码的目录。

doc:用于存放文档的目录

test:用于存放单元测试用例的代码。

包描述文件

包描述文件用于表达非代码相关的信息,它是一个JSON格式的文件----package.json,位于报的根目录下,是包的重要组成部分。而NPM的所有行为都与包描述文件的字段息息相关。由于CommonJS规范尚处于草案阶段,NPM在实践中做了一定得取舍。

CommonJS为package.json文件定义了如下一些必要的字段。

name:包的名称,必须是唯一的,由小写英文字母、数字和下划线组成,不能包含空格。

description:包的简要说明。

version:符合语义化八本识别规范的版本字符串。

keywords:关键字数组,通常用于搜索。

maintainers:维护者数组,每个元素要包含name、email(可选)、web(可选)字段。

contributors:贡献者数组,格式与maintainers相同。包的作者应该是贡献者数组的第一个元素。

bugs:提交bug的地址,可以是网址或者电子邮件地址。

licenses:许可证数组,每个元素要包含type(许可证的名称)和url(链接到许可证文本的地址)字段。

repositories:仓库托管地址数组。每个元素要包含type(许可证的名称)和url(链接到许可证文本的地址)字段。

dependencies:包的依赖,一个关联数组,由包名称和版本组成。

除了必选字段外,规范还定义了一部分可选字段。home、os、cpu、engine、builtin、directories、implements、scripts(脚本说明对象。它主要被包管理器用来安装、编译、测试和卸载包)

"scripts":{

"install":"install.js",

"uninstall":"uninstall.js",

"build":"build.js",

"doc":"make-doc.js",

"test":"text.js"

}


包规范的定义可以帮助Node解决依赖包安装的问题,而NPM正是基于该规范进行了实现,与包描述文件的规范汇中,NPM实际上比包规范多了author、bin、main和 devDependencies这4个字段。

author : 包作者。

bin :一些包作者希望包作为命令行工具使用,配置好bin字段后,通过npm install packageName -g命令可以将脚本添加到执行路径中,之后可以在命令行中直接执行。

main:模块引入方法require()在引入包时,会优先检查这个字段,并将其作为包中其余模块的入口,如果不存在这个字段,require()方法会查找包目录下的index.js、index.node、index.json文件作为默认入口

devDependencies:一些模块只在开发时需要依赖,配置这个属性,可以提示包的后续开发者安装依赖包。


NPM 常用功能

CommonJS包规范是理论,NPM是其中的一种实现,借助NPM,用户可以快速安装和管理依赖包

1.查看帮助

npm -v 查看版本 

npm 查看到帮助引导说明

npm help <command>可以查看具体的命令说明


2.安装依赖包

npm install packageName

执行该命令后,npm会在当前目录下创建node_modules目录,然后在node_modules目录下创建安装的包目录,接着将包解压到这个目录下。

安装好依赖包后,直接在代码中调用require("包名")即可引入改包。require()方法在做路径分析的时候会通过模块路径查找到安装包所在的位置。

全局模式安装  npm install packageName -g (包中含有命令行工具)

创建package.json文件  npm init

3.分析包

在使用的过程中,不能确认当前目录下能否通过require()顺利引入想要的包,可以采用npm ls来分析包

这个命令可以分析当前路径下能够通过模块路径找到的所有包,并生成依赖树

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

推荐阅读更多精彩内容

  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,249评论 2 36
  • 1 Node.js模块的实现# 之前在网上查阅了许多介绍Node.js的文章,可惜对于Node.js的模块机制大都...
    七寸知架构阅读 2,054评论 1 50
  • JavaScript 模块化编程 网站越来越复杂,js代码、js文件也越来越多,会遇到什么问题? 命名冲突; 文件...
    magic_pill阅读 1,413评论 0 1
  • 1 Node.js模块的实现 之前在网上查阅了许多介绍Node.js的文章,可惜对于Node.js的模块机制大都着...
    zlx_2017阅读 1,232评论 0 1
  • 吃的啥呀,吃好一点,别整天算计,别以为春天来了就急着脱衣服,一早一晚的注意点哈,没事挂了吧,改天再打电话,挂了吧,...
    b379ea924164阅读 148评论 0 0