feat(all): ✨ 新增工具
This commit is contained in:
+10
-10
@@ -5,7 +5,7 @@
|
||||
## 开发环境要求
|
||||
|
||||
- Node.js >= 18.12.0
|
||||
- pnpm 8.15.6
|
||||
- pnpm >= 10.0.0
|
||||
|
||||
## 快速开始
|
||||
|
||||
@@ -40,7 +40,7 @@ git checkout -b fix/your-bug-fix
|
||||
### 3. 开发与测试
|
||||
|
||||
```bash
|
||||
# 构建所有包
|
||||
# 构建所有包(Turbo)
|
||||
pnpm build
|
||||
|
||||
# 运行测试
|
||||
@@ -162,7 +162,7 @@ git push origin feat/your-feature-name
|
||||
### JavaScript/TypeScript
|
||||
|
||||
- 使用 ESLint + Prettier 进行代码检查和格式化
|
||||
- 遵循项目的 `.eslintrc` 配置
|
||||
- 遵循项目的 `eslint.config.js`(ESLint Flat Config)
|
||||
- 提交前运行 `pnpm lint` 和 `pnpm format`
|
||||
|
||||
### 测试
|
||||
@@ -170,7 +170,7 @@ git push origin feat/your-feature-name
|
||||
- 为新功能编写单元测试
|
||||
- 确保所有测试通过: `pnpm test`
|
||||
- 测试文件放在各包的 `test/` 目录下
|
||||
- 使用 Jest 作为测试框架
|
||||
- 使用 Vitest 作为测试框架
|
||||
|
||||
### 文档
|
||||
|
||||
@@ -187,20 +187,20 @@ r-util-js/
|
||||
│ ├── vue3/ # Vue3 工具
|
||||
│ ├── vue2/ # Vue2 工具
|
||||
│ └── uni-app/ # uni-app 工具
|
||||
├── scripts/ # 构建和发布脚本
|
||||
└── docs/ # 文档
|
||||
```
|
||||
|
||||
## 发布流程
|
||||
|
||||
发布由维护者负责,使用 `standard-version` 自动生成版本号和 CHANGELOG:
|
||||
发布由维护者负责,详细流程请查看 [发布流程文档](./RELEASE.md)。
|
||||
|
||||
常用命令:
|
||||
|
||||
```bash
|
||||
# 生成版本和 CHANGELOG
|
||||
pnpm changeset
|
||||
pnpm release:check
|
||||
pnpm release
|
||||
|
||||
# 发布到 npm
|
||||
pnpm publish -r
|
||||
pnpm release:publish
|
||||
```
|
||||
|
||||
## 需要帮助?
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
# 发布流程
|
||||
|
||||
本文档描述维护者发布 `@r-utils` monorepo 包的标准流程。
|
||||
|
||||
## 前置条件
|
||||
|
||||
- Node.js >= 18.12.0
|
||||
- pnpm >= 10.0.0
|
||||
- 已登录目标 npm 仓库(默认使用各包 `publishConfig.registry`)
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
## 推荐发布流程(分步)
|
||||
|
||||
### 1. 记录变更(changeset)
|
||||
|
||||
```bash
|
||||
pnpm changeset
|
||||
pnpm changeset:status
|
||||
```
|
||||
|
||||
### 2. 质量检查与构建
|
||||
|
||||
```bash
|
||||
pnpm release:check
|
||||
```
|
||||
|
||||
`release:check` 会依次执行:
|
||||
|
||||
- `pnpm test`
|
||||
- `pnpm build`
|
||||
|
||||
### 3. 更新版本号与 CHANGELOG
|
||||
|
||||
```bash
|
||||
pnpm release
|
||||
```
|
||||
|
||||
该命令等价于 `changeset version`,会更新受影响包版本及 changelog。
|
||||
|
||||
### 4. 发布到 npm 仓库
|
||||
|
||||
```bash
|
||||
pnpm release:publish
|
||||
```
|
||||
|
||||
该命令等价于 `changeset publish`。
|
||||
|
||||
## 一键发布(维护者)
|
||||
|
||||
```bash
|
||||
pnpm release:all
|
||||
```
|
||||
|
||||
`release:all` 会按顺序执行:
|
||||
|
||||
1. `pnpm release:check`
|
||||
2. `pnpm release`
|
||||
3. `pnpm release:publish`
|
||||
|
||||
## 发布后建议
|
||||
|
||||
发布完成后,手动提交并推送版本相关变更与 tag。
|
||||
Reference in New Issue
Block a user