1. 初始化项目 (npm init)
npm init
该命令创建一个新的package.json
文件,它是Node.js项目的核心配置文件。通过一系列交互式问题,用户可以定义项目的基本信息,如名称、版本、描述、主入口文件、关键词、作者、许可协议等。若要快速创建并接受默认配置,可使用 -y
参数:
npm init -y
2. 安装依赖
本地安装:
npm install <module-name>
或简写为
npm i <module-name>
本地安装将在当前项目目录下的
node_modules
文件夹内安装模块,同时将依赖关系添加到package.json
的dependencies
字段(除非使用了--save-dev
或-D
标志)。全局安装:
npm install -g <module-name>
全局安装将模块安装至系统范围内的位置,使得所有项目都可以访问这个模块,主要用于命令行工具或需要跨项目使用的工具包。
3. 安装依赖并保存到配置文件
生产依赖保存:
npm install <module-name> --save
或
npm i <module-name> -S
这将把模块作为生产依赖记录在
package.json
的dependencies
字段,意味着其他人在克隆该项目时,执行npm install
会自动安装这些依赖。开发依赖保存:
npm install <module-name> --save-dev
或
npm i <module-name> -D
这将模块作为开发依赖记录在
package.json
的devDependencies
字段,这些依赖仅在开发阶段有用,如构建工具、测试框架等。
4. 更新依赖
更新全部依赖到最新兼容版本:
npm update
此命令会检查
package.json
中已保存的依赖,并将其更新到符合语义化版本控制策略的新版本。更新指定依赖:
npm update <module-name>
5. 查看已安装依赖
查看本地安装的所有依赖:
npm list
或查看指定模块及其版本:
npm list <module-name>
查看全局安装的包:
npm list -g
6. 卸载依赖
卸载本地依赖:
npm uninstall <module-name>
或简写为
npm rm <module-name>
同时从
package.json
中移除对应依赖记录,可以添加--save
或-S
、--save-dev
或-D
参数以确定是从哪个依赖列表中移除。卸载全局包:
npm uninstall -g <module-name>
7. 设置和查看配置
查看当前配置:
npm config ls
若要查看详细配置信息:
npm config ls -l
设置配置项:
npm config set key value
如设置默认项目作者名称:
npm config set init-author-name "Your Name"
8. 查找包
查找npm仓库中的包:
npm search <keyword>
查看特定包的信息:
npm view <module-name>
9. 版本管理
查看当前npm版本:
npm -v
更新npm自身到最新版本:
npm install npm@latest -g
10. 运行包中的脚本
执行package.json中scripts字段定义的脚本:
npm run <script-name>
11. 清理缓存
清理npm的缓存:
npm cache clean --force
在较新版本的npm中,建议使用:
npm cache clean --force npm cache verify
12. 发布和管理包
登录npm账号:
npm login
发布包到npm仓库:
npm publish