记录一下npm常用的使用命令,方便快速查阅。
本地包安装
安装
如果需要在项目里通过require()
的方式引入包,则需要本地安装依赖。
npm install <package_name>
下载的依赖包会出现在项目根目录下的node_modules
文件夹下。
如果package.json
里有依赖包的依赖记录,install
子命令会下载符合semver规则的最新版本,否则install
会下载依赖包的最新latest
版本。
依赖在安装时同步到package.json,下次直接使用npm install
就能安装对应的依赖了。
其中,使用--save
或-S
同步项目依赖到dependencies
。
npm install <package_name> --save
使用
--save-dev
或-D
同步开发依赖到devDependencies
。
更新
可以不定时查看依赖包是否过期。
npm outdated
进行依赖更新。
npm update
卸载
卸载不需要的依赖包。
npm uninstall <package_name>
同步删除package.json中的配置。
npm uninstall <package_name> --save
删除开发依赖使用
--save-dev
。
全局安装包
安装
如果想要在命令行中使用包(比如grunt等打包用的包),可以进行全局安装。
npm install -g <package_name>
更新
查看需要更新的包。
npm outdated -g --depth=0
更新全局包。
npm update -g
更新npm.
npm install npm@latest -g
卸载
npm uninstall -g <package_name>
如果反馈EACCES error
,参考:How to Prevent Permissions Errors。
创建包
初始化
初始化包,并根据回答提示生成package.json。
npm init
也可以直接生成默认版本:
npm init -yes
配置package.json
package.json放在项目的根目录下,用来记录包的一些基本信息以及管理依赖包。
{
"name": "my-awesome-package",
"version": "1.0.0"
}
如上所说,package.json可以在npm init
时,根据提示生成。如果想要自定义回答提示,可以修改~/npm-init.js
。
module.exports = {
customField: 'Custom Field',
otherCustomField: 'This field is really cool'
}
更复杂的自定义尝试使用 init-package-json。
发布前
发布包前,最好能了解一下npm的包策略。
发布包需要登陆账号,如果没有,可以先创建。
npm adduser
访问网站来验证注册是否成功:https://npmjs.com/~username。
有了账号,就可以登陆了。
npm login
验证登陆的账号是否符合预期。
npm whoami
.gitignore
和.npmignore
中的文件将不会被发布。
项目根目录下最好能有
readme.md
,用来描述项目及使用方法。
发布
发布项目。
npm publish
访问:https://npmjs.com/package/<package>,会发现包的readme.md信息被展示,那么包就成功发布了!
更新
包被修改后,可以进行更新发布。
发布前,需要先迭代版本。
npm version <update_type>
其中,<update_type>
是major
,minor
,patch
值之一。
命令会更新package.json
中的version
字段值。
版本详情查看:semantic versioning。
更新版本号后,就可以发布了。
npm publish
通过访问https://npmjs.com/package/<package>会发现包版本被更新了。
如果只更新
readme.md
也需要更新版本并发布。
常用命令
- npm-install
- npm-update
- npm-outdated
- npm-uninstall
- npm-adduser
- npm-login
- npm-whoami
- npm-init
- npm-version
- npm-publish
更多命令参考:npm doc。