npm是 Node.js 官方提供的包管理工具,它已经成了 Node.js 包的标准发布平台,用于 Node.js 包的发布、传播、依赖控制。npm 提供了命令行工具,使你可以方便地下载、安装、升级、删除包,也可以让你作为开发者发布并维护包。
npm 是随同 Node.js 一起安装的包管理工具,能解决 Node.js 代码部署上的很多问题,常见的场景有以下几种:
- 允许用户从 npm 服务器下载别人编写的第三方包到本地使用。
- 允许用户从 npm 服务器下载并安装别人编写的命令行程序到本地使用。
- 允许用户将自己编写的包或命令行程序上传到 npm 服务器供别人使用。
安装
- 新版的nodejs已经集成了npm,测试版本:
$npm -v
6.9.0
- 升级
$sudo npm install npm -g
- windows 环境
npm install npm -g
- 查看npm拥有的全部命令
$ npm --help
$ npm help
查看某一个npm命令的详细用法
$ npm --help
$ npm help
使用
- 包管理
npm install
例如安装express:
$npm install express # 本地安装
$npm install express -g # 全局安装
指定一个版本:
$npm install [email protected]
- 查看模块的当前版本号
npm view 模块名 version
需要注意的是查看到的模块版本是该模块再远程仓库的版本号,并不是当前项目中所依赖的版本号。
- 查看当前项目中应用的某个模块的版本号的命令为
npm list 模块名 version
- 查看模块的历史版本和当前版本
npm view 模块名 versions
- 查看一个模块的所有信息
npm view 模块名
本地安装的话,包会安装当前目录node_modules文件夹下
在全局模式下面,NPM会把包安装到/usr/local/lib/node_module
常见错误:
npm err! Error: connect ECONNREFUSED 127.0.0.1:8087
运行 npm config set proxy null
- 查看全局安装
$npm list -g --depth 0
- 设置环境变量
下面命令等于为 npm init 设置了默认值,以后执行 npm init 的时候,package.json 的作者姓名、邮件、主页、许可证字段就会自动写入预设的值。这些信息会存放在用户主目录的 ~/.npmrc文件,使得用户不用每个项目都输入。如果某个项目有不同的设置,可以针对该项目运行npm config
$ npm set init-author-name 'Your name'
$ npm set init-author-email 'Your email'
$ npm set init-author-url 'http://yourdomain.com'
$ npm set init-license 'MIT'
- npm常用命令
- npm init 会引导你创建一个package.json文件,包括名称、版本、作者这些信息等
- npm install
安装nodejs的依赖包 - npm install
-g 将包安装到全局环境中 - npm install
--save 安装的同时,将信息写入package.json中。项目路径中如果有package.json文件时,直接使用npm install方法就可以根据dependencies配置安装所有的依赖包 - npm remove
移除 - npm update
更新 - npm ls 列出当前安装的了所有包
- npm root 查看当前包的安装路径
- npm root -g 查看全局的包的安装路径
- npm info 命令可以查看每个模块的具体信息。
- npm prune 清除未被使用到的模块
5.使用 package.json
通常我们使用npm init命令来创建一个npm程序时,会自动生成一个package.json文件。package.json文件会描述这个NPM包的所有相关信息,包括作者、简介、包依赖、构建等信息,格式是严格的JSON格式。
- 命令行方式创建package.json
$ npm init //生成一个package.json
然后在当前目录生成一个基本的package.json文件。所有问题之中,只有项目名称(name)和项目版本(version)是必填的,其他都是选填的,一路下一步。
- 查看生成的package
$cat package.json
{
"name": "test",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
-
属性介绍
name
name和version是package.json中最重要的两个字段,也是发布到NPM平台上的唯一标识,如果没有正确设置这两个字段,包就不能发布和被下载。version
包的版本号。如"1.0.0"。
在node.js中的package.json配置文件中,我们需要配置版本号,比如0.1.2
第一位数字:主版本号
第二位数字:子版本号
第三位数字:补丁版本号description
包的描述信息,将会在npm search的返回结果中显示,以帮助用户选择合适的包。keywords
包的关键词信息,是一个字符串数组,同上也将显示在npm search的结果中。homepage
包的主页地址。bugs
包的bug跟踪主页地址。license
包的开源协议名称。author
包的作者。contributors, maintainers
包的贡献者,是一个数组。files(较少用)
包所包含的所有文件,可以取值为文件夹。通常我们还是用.npmignore来去除不想包含到包里的文件。main
包的入口文件。bin(较少用)
如果你的包里包含可执行文件,通过设置这个字段可以将它们包含到系统的PATH中,这样直接就可以运行,很方便。
-
man(较少用)
为系统的man命令提供帮助文档。帮助文件的文件名必须以数字结尾,如果是压缩的,需要以.gz结尾。
"man": ["./man/foo.1", "./man/bar.1", "./man/foo.2" ]
directories(较少用)
CommonJS包所要求的目录结构信息,展示项目的目录结构信息。字段可以是:lib, bin, man, doc, example。值都是字符串。repository
包的仓库地址。
"repository": {
"type": "git",
"url": "git+https://github.com/rainnaZR/es6-react.git"
},scripts
通过设置这个可以使NPM调用一些命令脚本,封装一些功能。
"scripts": {"start": "babel-node src/pages/index.js",
"build": "webpack --config config/webpack.config.js",
"watch": "webpack-dev-server --config config/webpack.config.js --hot --inline --progress"
}config
添加一些设置,可以供scripts读取用,同时这里的值也会被添加到系统的环境变量中。
"config": {
"port": "8080"
}
npm start的时候会读取到npm_package_config_port环境变量。dependencies
指定依赖的其它包,这些依赖是指包发布后正常执行时所需要的,也就是线上需要的包。使用下面的命令来安装:
npm install --save packageName
如果是开发中依赖的包,可以在devDependencies设置。devDependencies
这些依赖只有在开发时候才需要。使用下面的命令来安装:
npm install --save-dev packageNamepeerDependencies
相关的依赖,如果你的包是插件,而用户在使用你的包时候,通常也会需要这些依赖(插件),那么可以将依赖列到这里。bundledDependencies
绑定的依赖包,发布的时候这些绑定包也会被一同发布。optionalDependencies(较少用)
即使这些依赖没有,也可以正常安装使用。engines(较少用)
指定包运行的环境。
"engines": {
"node": ">=0.10.3 < 0.12",
"npm": "~1.0.20"
}os(较少用)
指定你的包可以在哪些系统平台下运行。
"os": [ "darwin", "linux", "!win32" ]
cpu(较少用)
可以指定包运行的cpu架构。private
设为true这个包将不会发布到NPM平台下。publishConfig(较少用)
这个字段用于设置发布时候的一些设定。尤其方便你希望发布前设定指定的tag或registry。
当你有了一个完整的 package.json 文件的时候,就可以让人一眼看出来,这个模块的基本信息,和这个模块所需要依赖的包。我们可以通过 npm install就可以很方便的下载好这个模块所需要的包。
npm install 默认会安装 dependencies 字段和 devDependencies 字段中的所有模块,如果使用 --production 参数,可以只安装 dependencies 字段的模块:
$npm install
和
$npm install --production
一旦安装了某个模块,就可以在代码中用 require 命令加载这个模块,例如:
let backbone = require('backbone')
package.json 的版本控制
例如:
"cluster": ">= 0.7.7",
"commander": "^2.6.0",
"async" : "*",
第一种:
貌似通过字面意思你应该懂得, cluster 版本必须大于等于 0.7.7
npm 安装的时候你也可以这样指定:
npm install cluster@">=0.7.7"
甚至你可以把版本范围指定到更小
npm install cluster@">=0.7.7<0.8.0"
让安装的版本大于0.7.7并且小于 0.8.0
第二种:
^ 符号表示,可以接受小版本和补丁版本的变化.简单说就是大版本不变即可,其他版本随便更新.
"commander":"^2.6.0"
当我们npm install 的时候,安装到 node_modules 目录下的
commander开源包可能是 2.6.0 或 2.7.3 或 2.8.9
第三种:
"async": " * "
最糟糕的一种版本控制,一点限制没有.
第四种:
当主版本号/次版本号/修订版本号为X or x or *时,
那么update或install是会下载该分支最新的版本号
第五种:
波浪号(~)是限定模块的次要版本
~1.5.1允许安装版本号大于1.5.1但小于1.6.0版本的模块
scripts 脚本
npm 不仅可以用于模块管理,还可以用于执行脚本。package.json 文件有一个 scripts 字段,可以用于指定脚本命令,供 npm 直接调用。
顾名思义,scripts就是一些脚本代码,可以通过
npm run script-key
来调用,例如在这个 package.json 的文件夹下使用npm run dev
就相当于运行了node build/dev-server.js
这一段代码。使用 scripts 的目的就是为了把一些要执行的代码合并到一起,使用 npm run 来快速的运行,方便省事。
npm run 是 npm run-script 的缩写,一般都使用前者,但是后者可以更好的反应这个命令的本质。
更换源
- 全局安装nrm
$ npm install -g nrm
- 列出可选的源:
带*号的表示当前在使用的源
$nrm ls
* npm ---- https://registry.npmjs.org/
cnpm --- http://r.cnpmjs.org/
taobao - https://registry.npm.taobao.org/
nj ----- https://registry.nodejitsu.com/
npmMirror https://skimdb.npmjs.com/registry/
edunpm - http://registry.enpmjs.org/
- 切换成淘宝源:
$ nrm use taobao
Registry has been set to: https://registry.npm.taobao.org/
- 测试所有源的响应时间:
$nrm test
npm ---- 314ms
cnpm --- 350ms
* taobao - 300ms
nj ----- Fetch Error
npmMirror 1153ms
edunpm - Fetch Error