当前位置：首页 > ai >正文

项目改 pnpm 并使用 Monorepo 发布至 npm 上

ai 2025/5/9 11:29:07

将 npm 项目迁移到 pnpm

安装 pnpm
```
npm i pnpm -g
```
查看是否安装成功及版本号
```
pnpm -v
```
基本迁移
- 删除 npm 的锁定文件和 node_modules：
```
rm -rf node_modules package-lock.json
```
- 使用 pnpm 安装依赖：
```
pnpm install
```
这会创建 pnpm-lock.yaml 文件代替 package-lock.json

更新 package.json 脚本

将 npm 命令替换为 pnpm：

{"scripts": {"dev": "pnpm run dev",  // 原先是 npm run dev"build": "pnpm run build"}
}

改造为 Monorepo

1. 配置工作区

在项目根目录创建 pnpm-workspace.yaml

packages:- 'packages/*'

  配置：- `packages/*`       - 存放共享的库/包- `!**/__tests__`    - 排除测试目录

或者在 package.json 中添加

{"private": true,  // monorepo 项目需要设置为私有"type": "module",  // 使用 ESM 模块系统"workspaces": ["packages/*"  // 指定工作空间目录]
}

  两种选一种配置即可，	如果同时存在 package.json 的 workspaces 和 pnpm-workspace.yaml：pnpm-workspace.yaml 优先级更高，pnpm 会忽略 package.json 的 workspaces 配置。

2. 创建子包

创建共享库包

在根目录下创建 packages 目录，以及子包的目录：task-processor，thread-pool，shared
进入这两个目录中分别执行命令：

pnpm init

编辑生成的 package.json 的 name：

{"name": "@my-monorepo/shared","version": "1.0.0","description": "","main": "index.js","scripts": {"test": "echo \"Error: no test specified\" && exit 1"},"keywords": [],"author": "","license": "ISC"
}

3. 安装依赖

安装全局依赖（所有包共享）
```
pnpm add -D -w typescript vite @types/node
# 或
pnpm add -Dw typescript vite @types/node
```
-D 表示开发依赖，没有则是生产依赖
-w 表示在 Monorepo 的根目录（工作区根目录）执行操作，而不是在某个具体的子包中执行。

安装 packages 的子包的依赖

pnpm add moment --filter @my-monorepo/thread-pool
pnpm add lodash --filter @my-monorepo/task-processor

--filter：指定在特定子项目中安装依赖。

子包之间相互依赖
```
pnpm add @my-monorepo/shared@workspace:* --filter @my-monorepo/thread-pool
```
workspace:* 表示总是使用工作区内的最新版本

4. 常用命令
- 在所有包中运行命令
```
pnpm -r run build
```
  -r 表示递归执行
- 在特定包中运行命令
```
pnpm --filter @my-monorepo/web run dev
```
- 安装所有依赖
```
pnpm install
```

5. 高级配置

共享配置

可以在根目录创建共享的配置文件（如 tsconfig.base.json），然后在各包中继承：

{"extends": "../../tsconfig.base.json","compilerOptions": {"outDir": "./dist"}
}

限制依赖版本

在根目录 package.json 中添加：

{"pnpm": {"overrides": {"react": "18.2.0","typescript": "^4.9.0"}}
}

版本管理、发布

安装并初始化 Changesets

pnpm add -Dw @changesets/cli
pnpm changeset init

这会创建 .changeset 目录和配置文件。

流程

添加变更说明
```
pnpm changeset
```
交互式命令行会引导您：
- 选择要版本化的包
- 选择版本更新类型 (major/minor/patch) 【未选中时，点击回车切换更新类型】
- 编写变更描述
  
  这会生成一个 changeset 文件在 .changeset 目录中。
版本升级
```
pnpm changeset version
```
这个命令会：
- 根据 changeset 文件更新包版本
- 更新依赖关系
- 生成 CHANGELOG.md 文件
- 删除已处理的 changeset 文件
发布到 npm
在各个子包的 package.json 中添加：
```
  "publishConfig": {"access": "public","registry": "https://registry.npmjs.org/"}
```
否则会报错：402 Payment Required - PUT https://registry.npmjs.org/xxx - You must sign up for private packages

然后需要在 npm 中创建对应的组织

然后执行命令：
```
	nrm use npmnpm loginpnpm changeset publish
```
npm login 前需要切换至 npm 源，不能使用 cnpm 或者 taobao 等源；
扩展：在 git 中设置并提交对应的 tag 为此次的版本发布