贡献文档

本地开发

安装 Rush

信息

如果你本地已存在 rush 命令则跳过此步骤,可通过rush -h检查

pnpm add @microsoft/rush --global

npm add -g @microsoft/rush

yarn add -g @microsoft/rush

恢复依赖项

通过 rush update 恢复依赖

执行项目内命令

在项目路径下执行 rushx [script_name] 此命令可运行项目内 scripts 命令

管理依赖

https://rushjs.io/zh-cn/pages/commands/rush_add/

rush add -p [package_name] 在对应项目路径下执行添加依赖, --dev 添加开发依赖, -m 为仓库内所有项目同步一致的版本

rush remove -p [package_name] 在对应项目路径下执行删除依赖

Rush 使用文档

Monorepo usage

项目结构

.
├── common
│   ├── autoinstallers # 与业务无关的依赖或命令脚本
│   ├── config         # 配置
│   ├── git-hooks
│   └── scripts        # rush 脚本
├── apps               # 项目文件夹
├── libraries          # 基础设施包文件夹
│   ├── commander      # 脚手架
│   ├── documents      # 文档项目
│   ├── eslint-config  # eslint 推荐配置包
│   ├── styles         # 通用样式库
│   └── utils          # 工具函数库
└── rush.json          # rush 配置文件