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来分析包
这个命令可以分析当前路径下能够通过模块路径找到的所有包,并生成依赖树
网友评论