一、安装
- 通常在安装Node.js时会自动安装npm。
- 检查是否安装成功及查看版本
- 在终端(命令提示符或PowerShell等)中运行
npm -v
,如果显示版本号则表示安装成功且能看到当前版本。
- 在终端(命令提示符或PowerShell等)中运行
二、初始化项目
- 进入项目目录
- 在终端中使用
cd
命令进入到你要创建项目的文件夹。
- 在终端中使用
- 生成
package.json
文件- 运行
npm init
,然后根据提示依次输入项目名称、版本、描述等信息,最后生成一个包含项目基本信息的package.json
文件。 - 如果你想使用默认值快速生成,可以使用
npm init -y
。
- 运行
三、安装依赖
- 本地安装依赖包
- 安装单个包:
npm install <package_name>
,例如npm install lodash
,包会被安装到项目目录下的node_modules
文件夹中,同时在package.json
的dependencies
字段中添加相应记录。 - 安装指定版本:
npm install <package_name>@<version>
,例如npm install lodash@4.17.21
。 - 安装多个包:
npm install <package_name1> <package_name2>...
- 安装单个包:
- 安装为开发依赖(通常是开发过程中使用的工具等,如测试框架等)
npm install <package_name> --save-dev
或npm install <package_name> -D
,在package.json
的devDependencies
字段添加记录。
- 全局安装
- 某些工具需要在全局环境下使用:
npm install -g <package_name>
,例如npm install -g create-react-app
(注意:在部分系统上可能需要管理员权限使用sudo
)。
- 某些工具需要在全局环境下使用:
- 从本地目录安装(对于本地开发的未发布包)
- 如果在项目目录外有一个包含
package.json
的模块文件夹,进入项目目录后运行npm install /path/to/local/package
。
- 如果在项目目录外有一个包含
四、卸载依赖
- 卸载本地项目中的依赖包
npm uninstall <package_name>
,同时会从package.json
文件中移除相应记录。- 如果是开发依赖则
npm uninstall <package_name> -D
。
- 卸载全局安装的包
npm uninstall -g <package_name>
。
五、更新依赖
- 更新单个包
npm update <package_name>
。
- 检查哪些包有更新
npm outdated
,它会列出当前项目中可以更新的包以及当前版本、期望版本等信息。
- 更新所有包
- 一种较为暴力的方法是删除
node_modules
文件夹然后重新运行npm install
(不推荐在生产环境中随意这样做)。
- 一种较为暴力的方法是删除
六、运行脚本
在 package.json
的 scripts
字段中定义脚本:
"scripts": {
"start": "node server.js",
"build": "webpack",
"test": "jest"
}
然后在终端中运行:
npm run start
运行启动脚本npm run build
运行构建脚本等
七、查看信息
- 查看项目中已安装的所有依赖列表(树状结构)
npm list
(在项目目录下)npm list -g
查看全局安装的包列表。
- 查看某个包的详细信息
npm info <package_name>
。
八、设置配置
- 查看所有配置
npm config list -l
- 设置配置项 ,例如设置镜像源
npm config set registry https://registry.npm.taobao.org
(设置淘宝镜像源为例)
九、缓存管理
- 清除缓存
npm cache clean --force
十、发布包(如果自己开发包并发布)
- 登录npm
npm adduser
(输入用户名、密码、邮箱等信息) 或npm login
(如果已经注册过)
- 在包含
package.json
的包的根目录下发布npm publish
(注意:包名在npm中必须唯一等限制条件)
十一、其他
- 使用
npm shrinkwrap
锁定依赖版本等高级功能(在复杂项目管理依赖关系场景)。 - 利用
npm link
在本地开发中调试自己开发的npm包等。