Npm
什么是Npm?
npm 是 Node 的模块管理器,功能极其强大。它是 Node 获得成功的重要原因之一。
正因为有了npm,我们只要一行命令,就能安装别人写好的模块 。
$ npm install
本文介绍 npm 模块安装机制的细节,以及如何解决安装速度慢的问题。
Npm常用命令
npm install ModuleName
: 安装包npm install ModuleName -g
: 全局安装npm install ModuleName@1.0.0
: 安装指定版本的模块npm install ModuleName --save
: 安装包的同时,将信息写入到package.json中的 dependencies(依赖)配置中。npm install ModuleName --save-dev
: 安装包的同时,将信息写入到package.json中的 devDependencies(依赖)配置中。npm uninstall ModuleName
: 卸载模块npm remove ModuleName
: 移除模块npm update ModuleName
: 更新模块npm search ModuleName
: 搜索模块npm ls ModuleName
: 列出当前安装的了所有包npm root
: 查看当前包的安装路径npm root -g
: 查看全局的包的安装路径npm cache clear
: 清空 npm 本地缓存
package.json文件
package.json
文件可以手工编写,也可以使用npm init
命令自动生成。
npm init
这个命令采用互动方式,要求用户回答一些问题,然后在当前目录生成一个基本的package.json文件。所有问题之中,只有项目名称(name)和项目版本(version)是必填的,其他都是选填的。
有了package.json文件,直接使用npm install命令,就会在当前目录中安装所需要的模块。
npm install
如果一个模块不在package.json文件之中,可以单独安装这个模块,并使用相应的参数,将其写入package.json文件之中。
$ npm install express --save
$ npm install express --save-dev
package.json介绍
- name - 包名
- version - 包的版本号
- description - 包的描述
- homepage - 包的官网 url
- author - 包的作者姓名
- contributors - 包的其他贡献者姓名
- dependencies - 依赖包列表,如果依赖包没有安装,npm 会自动将依赖包安装在 node_module 目录下
- repository - 包代码存放的地方的类型,可以是 git 或 svn,git 可在 Github 上
- main - main 字段是一个模块ID,它是一个指向你程序的主要项目。就是说,如果你包的名字叫 express,然后用户安装它,然后require(“express”)
- keywords - 关键字
{
"name": "Hello World",
"version": "0.0.1",
"author": "张三",
"description": "第一个node.js程序",
"keywords":["node.js","javascript"],
"repository": {
"type": "git",
"url": "https://path/to/url"
},
"license":"MIT",
"engines": {"node": "0.10.x"},
"bugs":{"url":"http://path/to/bug","email":"bug@example.com"},
"contributors":[{"name":"李四","email":"lisi@example.com"}],
"scripts": {
"start": "node index.js"
},
"dependencies": {
"express": "latest",
"mongoose": "~3.8.3",
"handlebars-runtime": "~1.0.12",
"express3-handlebars": "~0.5.0",
"MD5": "~1.2.0"
},
"devDependencies": {
"bower": "~1.2.8",
"grunt": "~0.4.1",
"grunt-contrib-concat": "~0.3.0",
"grunt-contrib-jshint": "~0.7.2",
"grunt-contrib-uglify": "~0.2.7",
"grunt-contrib-clean": "~0.5.0",
"browserify": "2.36.1",
"grunt-browserify": "~1.3.0",
}
}
main字段
main
字段指定了加载的入口文件,require('moduleName')
就会加载这个文件。这个字段的默认值是模块根目录下面的index.js
。
scripts字段
scripts
指定了运行脚本命令的npm命令行缩写,比如start
指定了运行npm run start
时,所要执行的命令。
下面的设置指定了npm run preinstall
、npm run postinstall
、npm run start
、npm run test
时,所要执行的命令。
"scripts": {
"preinstall": "echo here it comes!",
"postinstall": "echo there it goes!",
"start": "node index.js",
"test": "tap test/*.js"
}
dependencies字段,devDependencies字段
dependencies
字段指定了项目运行所依赖的模块,devDependencies
指定项目开发所需要的模块。
它们都指向一个对象。该对象的各个成员,分别由模块名和对应的版本要求组成,表示依赖的模块及其版本范围。
{
"devDependencies": {
"browserify": "~13.0.0",
"karma-browserify": "~5.0.1"
}
}