PNPM(Performant NPM)是一个高效的 NPM 包管理器,它使用硬链接和符号链接来减少磁盘空间的使用,并提高了安装速度。
1. 环境要求
v9 的 PNPM 需要 Node.js v18+。
2. 安装
npm i -g pnpm
3 基本功能
3.1 安装 NPM 包
- 安装单个包,可以使用以下两种方式:
pnpm add 包名
pnpm i 包名
i 是 install 的简写,例:npm i jest
- 安装项目中所有依赖
pnpm i
3.2 移除包
pnpm remove 包名
4 进阶功能
4.1 管理 Node.js 版本(替代 nvm 或者 n )
- 使用 Node.js 最新版本,如没有则自动安装。
pnpm env use -g lts
- 使用特定版本,如没有则自动安装
pnpm env use -g 18
- 安装版本(以下为安装最新版本以及 18 版本)
pnpm env add -g lts 18
- 卸载版本
pnpm env remove -g 18
4.2 更新依赖项(替代 npm-check-updates)
根据指定的范围将程序包更新到其最新版本。如: ^6.3.1 可以更新到 ^6.5.1。
pnpm up
将所有依赖项更新为最新版本。如: ^6.3.1 更新到 ^7.5.3。
pnpm up -L
up 是 update 的简写
4.3 执行脚本
- 执行 package.json 中的脚本:
pnpm run 脚本名称
- 在项目范围内执行命令
当该命令没有全局安装,只在此项目下安装,则使用以下命令(类似 NPM 中的 npx):
pnpm exec 某个命令,如:eslint
- 临时下载的软件包运行可执行命令(类似 NPM 中的 npx)
pnpm dlx 命令,如:create-react-app ./my-app
4.4 Monorepo 支持(替代 Lerna&Yarn)
如果是组件库项目,可在项目根目录下创建 components,用于存放各个组件;如果是类库项目,则可创建 packages 文件夹,来存放各个类库。
在项目根目录下创建 pnpm-workspace.yaml,以下内容按需填写(packages 和 components 选其一)。
packages:
# 目录中的所有软件包/
- 'packages/*'
# 组件子目录中的所有软件包/
- 'components/**'
# 排除测试目录内的软件包
- '!**/test/**'
目录大概为:
├── packages
│ ├── packageA
│ │ └── package.json
│ └── packageB
│ └── package.json
├── package.json
└── pnpm-workspace.yaml
- 全局安装依赖,以安装 vue 为例:
pnpm add vue -w
- 安装本地的某个子包作为依赖,下方前者是需要在某个包下进行安装,后者是要安装的包名
pnpm -F "./packages/**" add "./packages/**"
要保证 ./packages/( 替换成对应的文件夹或者文件名)下存在 package.json 文件。
这里的 ./packages/** 也可以替换成对应 package.json 中的 name 名。
- 所有子包批量发布
pnpm -r publish