refactor: 删除所有 sh 脚本,改用直接命令行操作
- 删除 init.sh 脚本 - 删除 scripts/health-check.sh 脚本 - 删除 scripts/e2e-test.sh 脚本 - 更新 README.md 删除脚本引用 - 更新 PERDAS-GUIDE.md 改为直接命令行操作 - 更新 PROGRESS.md 删除脚本相关内容 - 配置 .gitignore 不再忽略脚本文件 开发流程改为: 1. pwd 确认目录 2. ./stock-tool-simple & 启动 3. cat feature_list.json 查看功能 4. 修改代码开发功能 5. jq 更新 feature_list.json 状态 6. vim 更新 PROGRESS.md 7. git commit 推送 简化开发流程,减少依赖外部脚本
This commit is contained in:
141
PERDAS-GUIDE.md
141
PERDAS-GUIDE.md
@@ -4,51 +4,31 @@
|
||||
|
||||
## 📋 5 分钟快速启动
|
||||
|
||||
### 第一步:启动开发环境
|
||||
### 第一步:确认目录
|
||||
|
||||
```bash
|
||||
cd /root/.openclaw/workspace/stock-tool
|
||||
./init.sh
|
||||
pwd
|
||||
# 输出: /root/.openclaw/workspace/stock-tool
|
||||
```
|
||||
|
||||
### 第二步:启动服务器
|
||||
|
||||
```bash
|
||||
# 编译(首次或更新代码后)
|
||||
go build -o stock-tool-simple main_simple.go
|
||||
|
||||
# 启动服务器
|
||||
./stock-tool-simple &
|
||||
```
|
||||
|
||||
**预期输出**:
|
||||
```
|
||||
🚀 启动 Stock Tool 开发环境...
|
||||
✅ 服务器启动成功!
|
||||
🚀 服务器启动成功!
|
||||
🌐 地址: http://localhost:8080
|
||||
💡 下一步:
|
||||
1. 在浏览器访问 http://localhost:8080
|
||||
2. 运行 ./scripts/health-check.sh 进行健康检查
|
||||
```
|
||||
|
||||
### 第二步:健康检查
|
||||
|
||||
```bash
|
||||
./scripts/health-check.sh
|
||||
```
|
||||
|
||||
**预期输出**:
|
||||
```
|
||||
📊 健康检查总结
|
||||
通过: 25
|
||||
失败: 0
|
||||
总计: 25
|
||||
✨ 所有检查通过!开发环境正常。
|
||||
```
|
||||
|
||||
### 第三步:端到端测试
|
||||
|
||||
```bash
|
||||
./scripts/e2e-test.sh
|
||||
```
|
||||
|
||||
**预期输出**:
|
||||
```
|
||||
✅ 所有测试通过!
|
||||
💡 提示: 测试截图已保存到 tests/screenshots/
|
||||
```
|
||||
|
||||
### 第四步:查看功能清单
|
||||
### 第三步:查看功能清单
|
||||
|
||||
```bash
|
||||
cat feature_list.json
|
||||
@@ -67,6 +47,12 @@ cat feature_list.json
|
||||
}
|
||||
```
|
||||
|
||||
### 第四步:查看进度
|
||||
|
||||
```bash
|
||||
cat PROGRESS.md
|
||||
```
|
||||
|
||||
### 第五步:开发新功能
|
||||
|
||||
**当前进行中的功能**:
|
||||
@@ -74,7 +60,7 @@ cat feature_list.json
|
||||
|
||||
**开发步骤**:
|
||||
1. 查看 feature_list.json 中 feat-006 的 steps
|
||||
2. 使用浏览器访问 http://localhost:8080
|
||||
2. 访问 http://localhost:8080 测试
|
||||
3. 手动测试功能
|
||||
4. 更新 feature_list.json(修改 passes: true)
|
||||
5. 提交代码
|
||||
@@ -88,19 +74,15 @@ cat feature_list.json
|
||||
```bash
|
||||
# 1. 确认目录
|
||||
pwd
|
||||
# 输出: /root/.openclaw/workspace/stock-tool
|
||||
|
||||
# 2. 启动环境
|
||||
./init.sh
|
||||
# 2. 启动服务器(如果未运行)
|
||||
./stock-tool-simple &
|
||||
|
||||
# 3. 健康检查
|
||||
./scripts/health-check.sh
|
||||
|
||||
# 4. 查看进度
|
||||
# 3. 查看进度
|
||||
cat PROGRESS.md
|
||||
|
||||
# 5. 查看功能清单
|
||||
jq '.features[] | select(.status=="in_progress")' feature_list.json
|
||||
# 4. 查看功能清单
|
||||
cat feature_list.json
|
||||
```
|
||||
|
||||
### 开发功能时
|
||||
@@ -115,29 +97,18 @@ jq '.features[] | select(.status=="in_progress")' feature_list.json
|
||||
- 测试功能
|
||||
- 验证效果
|
||||
|
||||
3. **运行测试**
|
||||
```bash
|
||||
./scripts/e2e-test.sh
|
||||
```
|
||||
|
||||
4. **保存截图**
|
||||
```bash
|
||||
# 在浏览器中测试后截图
|
||||
cp screenshot.png tests/screenshots/feat-006-xxx.png
|
||||
```
|
||||
|
||||
5. **更新状态**
|
||||
3. **更新状态**
|
||||
```bash
|
||||
# 修改 feature_list.json
|
||||
jq '.features[] | select(.id=="feat-006") | .passes = true' feature_list.json > tmp.json && mv tmp.json feature_list.json
|
||||
```
|
||||
|
||||
6. **更新进度文件**
|
||||
4. **更新进度文件**
|
||||
```bash
|
||||
vim PROGRESS.md
|
||||
```
|
||||
|
||||
7. **提交代码**
|
||||
5. **提交代码**
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "feat: 完成 feat-006 数据刷新功能"
|
||||
@@ -152,7 +123,6 @@ jq '.features[] | select(.status=="in_progress")' feature_list.json
|
||||
|------|------|----------|
|
||||
| `feature_list.json` | 功能清单 | **仅修改** `passes` 字段 |
|
||||
| `PROGRESS.md` | 进度跟踪 | 每会话更新 |
|
||||
| `init.sh` | 环境启动 | 必要时更新 |
|
||||
| `.gitignore` | 忽略规则 | 必要时更新 |
|
||||
| `README.md` | 项目文档 | 必要时更新 |
|
||||
|
||||
@@ -160,23 +130,24 @@ jq '.features[] | select(.status=="in_progress")' feature_list.json
|
||||
|
||||
## ⚠️ 强约束指令(必须遵守)
|
||||
|
||||
> **It is unacceptable to remove or edit tests because this could lead to missing or buggy functionality.**
|
||||
> **绝对禁止删除或修改测试用例**
|
||||
|
||||
### 绝对禁止的行为:
|
||||
|
||||
- ❌ 删除或修改测试用例
|
||||
- ❌ 删除或修改其他功能的代码
|
||||
- ❌ 修改 `feature_list.json` 中除 `passes` 字段外的任何内容
|
||||
- ❌ 未通过端到端测试就标记完成
|
||||
- ❌ 未保存截图证据就标记完成
|
||||
- ❌ 修改 `feature_list.json` 中除 `passes` 字段外的内容
|
||||
- ❌ 未通过测试就标记完成
|
||||
- ❌ 未保存截图就标记完成
|
||||
|
||||
### 正确的行为:
|
||||
|
||||
- ✅ 只修改当前要开发的功能
|
||||
- ✅ 功能完成后运行端到端测试
|
||||
- ✅ 测试通过后保存截图
|
||||
- ✅ 更新 `feature_list.json` 的 `passes` 字段
|
||||
- ✅ 更新 `PROGRESS.md` 记录本次工作
|
||||
- ✅ 功能完成后测试验证
|
||||
- ✅ 测试通过后更新状态
|
||||
- ✅ 保存截图证据
|
||||
- ✅ 更新 feature_list.json 的 `passes` 字段
|
||||
- ✅ 更新 PROGRESS.md 记录本次工作
|
||||
- ✅ 提交 Git commit
|
||||
|
||||
---
|
||||
@@ -186,20 +157,22 @@ jq '.features[] | select(.status=="in_progress")' feature_list.json
|
||||
### 服务器未运行
|
||||
|
||||
```bash
|
||||
./init.sh
|
||||
./stock-tool-simple &
|
||||
```
|
||||
|
||||
### 测试失败
|
||||
### 查看服务器日志
|
||||
|
||||
```bash
|
||||
# 查看服务器日志
|
||||
# 服务器日志保存在 logs/server.log
|
||||
cat logs/server.log
|
||||
```
|
||||
|
||||
# 检查 API 是否正常
|
||||
curl http://localhost:8080/api/stocks
|
||||
### 检查端口是否监听
|
||||
|
||||
# 重新测试
|
||||
./scripts/e2e-test.sh
|
||||
```bash
|
||||
netstat -tuln | grep 8080
|
||||
# 或
|
||||
ss -tuln | grep 8080
|
||||
```
|
||||
|
||||
### Git 冲突
|
||||
@@ -217,26 +190,22 @@ git push
|
||||
- **完整文档**: README.md
|
||||
- **进度跟踪**: PROGRESS.md
|
||||
- **功能清单**: feature_list.json
|
||||
- **健康检查**: scripts/health-check.sh
|
||||
- **端到端测试**: scripts/e2e-test.sh
|
||||
- **开发指南**: PERDAS-GUIDE.md
|
||||
|
||||
---
|
||||
|
||||
## 💡 常用命令速查
|
||||
|
||||
```bash
|
||||
# 启动环境
|
||||
./init.sh
|
||||
|
||||
# 健康检查
|
||||
./scripts/health-check.sh
|
||||
|
||||
# 端到端测试
|
||||
./scripts/e2e-test.sh
|
||||
# 启动服务器
|
||||
./stock-tool-simple &
|
||||
|
||||
# 查看功能
|
||||
jq '.features[] | select(.status=="in_progress")' feature_list.json
|
||||
|
||||
# 更新功能状态
|
||||
jq '.features[] | select(.id=="feat-006") | .passes = true' feature_list.json > tmp.json && mv tmp.json feature_list.json
|
||||
|
||||
# 查看提交历史
|
||||
git log --oneline -10
|
||||
|
||||
@@ -261,7 +230,7 @@ git push
|
||||
|
||||
2. 启动服务器并测试:
|
||||
```bash
|
||||
./init.sh
|
||||
./stock-tool-simple &
|
||||
http://localhost:8080
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user