Node.js
当你需要配置这个仓库当前实际使用的开发环境时,看这页。
这个环境目前用于哪些模块
当前仓库是一个 Node.js workspace。这个环境目前用于:
packages/protocolpackages/clientpackages/serverapps/browser-simple-mdp-clientapps/chrome-extensionapps/vscode-extensiondocsscripts
准备 Node.js
本地开发建议使用 Node.js 20 或更高版本。仓库里既有面向 Node 的构建目标,也有依赖要求较新的 Node.js 版本。
最简单的准备流程是:
- 安装 Node.js
- 启用
corepack - 校验
node和pnpm - 安装 workspace 依赖
例如:
bash
node -v
corepack enable
pnpm -v安装依赖
以仓库根目录作为工作目录,先执行:
bash
pnpm install仓库在 packageManager 中声明了 pnpm@10.28.0,因此更推荐使用 corepack 管理的 pnpm,而不是混用其他包管理器。
常用根命令
bash
pnpm test:unit
pnpm build
pnpm test
pnpm docs:dev
pnpm docs:buildpnpm build会递归构建packages/**和apps/**下的 workspace。pnpm test会在 smoke test 前重新构建 package 产物,确保端到端校验使用最新 dist。pnpm docs:dev和pnpm docs:build会先自动构建文档站点依赖的浏览器 bundle,再准备docs/public/assets。
另外几个常用的根级辅助命令:
bash
pnpm build:packages
pnpm build:apps
pnpm typecheck
pnpm typecheck:packages
pnpm typecheck:apps应用级校验
如果你只改一个 app,先从它自己的命令开始:
bash
pnpm --filter @modeldriveprotocol/browser-simple-mdp-client test
pnpm --filter @modeldriveprotocol/browser-simple-mdp-client build
pnpm --filter @modeldriveprotocol/chrome-extension typecheck
pnpm --filter @modeldriveprotocol/chrome-extension test
pnpm --filter @modeldriveprotocol/chrome-extension build
pnpm --filter @modeldriveprotocol/vscode-extension typecheck
pnpm --filter @modeldriveprotocol/vscode-extension test
pnpm --filter @modeldriveprotocol/vscode-extension build