zcf 3.1.2 → 3.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -3
- package/dist/chunks/simple-config.mjs +329 -70
- package/dist/cli.mjs +74 -19
- package/dist/i18n/locales/en/cli.json +2 -0
- package/dist/i18n/locales/en/errors.json +1 -0
- package/dist/i18n/locales/zh-CN/cli.json +2 -0
- package/dist/i18n/locales/zh-CN/errors.json +1 -0
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/package.json +1 -1
- package/templates/claude-code/common/settings.json +8 -6
- package/templates/codex/en/workflow/git/prompts/git-cleanBranches.md +102 -0
- package/templates/codex/en/workflow/git/prompts/git-commit.md +157 -0
- package/templates/codex/en/workflow/git/prompts/git-rollback.md +90 -0
- package/templates/codex/en/workflow/git/prompts/git-worktree.md +276 -0
- package/templates/codex/en/workflow/sixStep/prompts/workflow.md +140 -121
- package/templates/codex/zh-CN/workflow/git/prompts/git-cleanBranches.md +102 -0
- package/templates/codex/zh-CN/workflow/git/prompts/git-commit.md +157 -0
- package/templates/codex/zh-CN/workflow/git/prompts/git-rollback.md +90 -0
- package/templates/codex/zh-CN/workflow/git/prompts/git-worktree.md +276 -0
- package/templates/codex/zh-CN/workflow/sixStep/prompts/workflow.md +16 -33
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 交互式回滚 Git 分支到历史版本;列分支、列版本、二次确认后执行 reset / revert
|
|
3
|
+
allowed-tools: Read(**), Exec(git fetch, git branch, git tag, git log, git reflog, git checkout, git reset, git revert, git switch), Write()
|
|
4
|
+
argument-hint: [--branch <branch>] [--target <rev>] [--mode reset|revert] [--depth <n>] [--dry-run] [--yes]
|
|
5
|
+
# examples:
|
|
6
|
+
# - /git-rollback # 全交互模式,dry‑run
|
|
7
|
+
# - /git-rollback --branch dev # 直接选 dev,其他交互
|
|
8
|
+
# - /git-rollback --branch dev --target v1.2.0 --mode reset --yes
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Claude Command: Git Rollback
|
|
12
|
+
|
|
13
|
+
**目的**:安全、可视地将指定分支回滚到旧版本。
|
|
14
|
+
默认处于 **只读预览 (`--dry-run`)**;真正执行需加 `--yes` 或在交互中确认。
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
# 纯交互:列出分支 → 选分支 → 列最近 20 个版本 → 选目标 → 选择 reset 或 revert → 二次确认
|
|
22
|
+
/git-rollback
|
|
23
|
+
|
|
24
|
+
# 指定分支,其他交互
|
|
25
|
+
/git-rollback --branch feature/calculator
|
|
26
|
+
|
|
27
|
+
# 指定分支与目标 commit,并用 hard‑reset 一键执行(危险)
|
|
28
|
+
/git-rollback --branch main --target 1a2b3c4d --mode reset --yes
|
|
29
|
+
|
|
30
|
+
# 只想生成 revert 提交(非破坏式回滚),预览即可
|
|
31
|
+
/git-rollback --branch release/v2.1 --target v2.0.5 --mode revert --dry-run
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Options
|
|
35
|
+
|
|
36
|
+
| 选项 | 说明 |
|
|
37
|
+
| ---------------------- | ---------------------------------------------------------------------------------- |
|
|
38
|
+
| `--branch <branch>` | 要回滚的分支;缺省时交互选择。 |
|
|
39
|
+
| `--target <rev>` | 目标版本(commit Hash、Tag、reflog 引用都行);缺省时交互选择近 `--depth` 条记录。 |
|
|
40
|
+
| `--mode reset\|revert` | `reset`:硬回滚历史;`revert`:生成反向提交保持历史完整。默认询问。 |
|
|
41
|
+
| `--depth <n>` | 在交互模式下列出最近 n 个版本(默认 20)。 |
|
|
42
|
+
| `--dry-run` | **默认开启**,只预览即将执行的命令。 |
|
|
43
|
+
| `--yes` | 跳过所有确认直接执行,适合 CI/CD 脚本。 |
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## 交互流程
|
|
48
|
+
|
|
49
|
+
1. **同步远端** → `git fetch --all --prune`
|
|
50
|
+
2. **列分支** → `git branch -a`(本地+远端,过滤受保护分支)
|
|
51
|
+
3. **选分支** → 用户输入或传参
|
|
52
|
+
4. **列版本** → `git log --oneline -n <depth>` + `git tag --merged` + `git reflog -n <depth>`
|
|
53
|
+
5. **选目标** → 用户输入 commit hash / tag
|
|
54
|
+
6. **选模式** → `reset` 或 `revert`
|
|
55
|
+
7. **最终确认** (除非 `--yes`)
|
|
56
|
+
8. **执行回滚**
|
|
57
|
+
- `reset`:`git switch <branch> && git reset --hard <target>`
|
|
58
|
+
- `revert`:`git switch <branch> && git revert --no-edit <target>..HEAD`
|
|
59
|
+
9. **推送建议** → 提示是否 `git push --force-with-lease`(reset)或普通 `git push`(revert)
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## 安全护栏
|
|
64
|
+
|
|
65
|
+
- **备份**:执行前自动在 reflog 中记录当前 HEAD,可用 `git switch -c backup/<timestamp>` 恢复。
|
|
66
|
+
- **保护分支**:如检测到 `main` / `master` / `production` 等受保护分支且开启 `reset` 模式,将要求额外确认。
|
|
67
|
+
- **--dry-run 默认开启**:防止误操作。
|
|
68
|
+
- **--force 禁止**:不提供 `--force`;如需强推,请手动输入 `git push --force-with-lease`。
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## 适用场景示例
|
|
73
|
+
|
|
74
|
+
| 场景 | 调用示例 |
|
|
75
|
+
| ----------------------------------------------- | ---------------------------------------------------------------- |
|
|
76
|
+
| 热修补丁上线后发现 bug,需要回到 Tag `v1.2.0` | `/git-rollback --branch release/v1 --target v1.2.0 --mode reset` |
|
|
77
|
+
| 运维同事误推了 debug 日志提交,需要生成反向提交 | `/git-rollback --branch main --target 3f2e7c9 --mode revert` |
|
|
78
|
+
| 调研历史 bug,引导新人浏览分支历史 | `/git-rollback` (全交互,dry‑run) |
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## 注意
|
|
83
|
+
|
|
84
|
+
1. **reset vs revert**
|
|
85
|
+
- **reset** 会改变历史,需要强推并可能影响其他协作者,谨慎使用。
|
|
86
|
+
- **revert** 更安全,生成新提交保留历史,但会增加一次记录。
|
|
87
|
+
2. **嵌入式仓库** 常有大体积二进制文件;回滚前请确保 LFS/子模块状态一致。
|
|
88
|
+
3. 若仓库启用了 CI 强制校验,回滚后可能自动触发流水线;确认管控策略以免误部署旧版本。
|
|
89
|
+
|
|
90
|
+
---
|
|
@@ -0,0 +1,276 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 管理 Git worktree,在项目平级的 ../.zcf/项目名/ 目录下创建,支持智能默认、IDE 集成和内容迁移
|
|
3
|
+
allowed-tools: Read(**), Exec(git worktree add, git worktree list, git worktree remove, git worktree prune, git branch, git checkout, git rev-parse, git stash, git cp, detect-ide, open-ide, which, command, basename, dirname)
|
|
4
|
+
argument-hint: <add|list|remove|prune|migrate> [path] [-b <branch>] [-o|--open] [--track] [--guess-remote] [--detach] [--checkout] [--lock] [--migrate-from <source-path>] [--migrate-stash]
|
|
5
|
+
# examples:
|
|
6
|
+
# - /git-worktree add feature-ui # 从 main/master 创建新分支 'feature-ui'
|
|
7
|
+
# - /git-worktree add feature-ui -o # 创建 worktree 并直接用 IDE 打开
|
|
8
|
+
# - /git-worktree add hotfix -b fix/login -o # 创建新分支 'fix/login',路径为 'hotfix'
|
|
9
|
+
# - /git-worktree migrate feature-ui --from main # 将主分支未提交内容迁移到 feature-ui
|
|
10
|
+
# - /git-worktree migrate feature-ui --stash # 将当前 stash 迁移到 feature-ui
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Claude Command: Git Worktree
|
|
14
|
+
|
|
15
|
+
管理 Git worktree,支持智能默认、IDE 集成和内容迁移,使用结构化的 `../.zcf/项目名/` 路径。
|
|
16
|
+
|
|
17
|
+
直接执行命令并提供简洁结果。
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# 基本操作
|
|
25
|
+
/git-worktree add <path> # 从 main/master 创建名为 <path> 的新分支
|
|
26
|
+
/git-worktree add <path> -b <branch> # 创建指定名称的新分支
|
|
27
|
+
/git-worktree add <path> -o # 创建并直接用 IDE 打开
|
|
28
|
+
/git-worktree list # 显示所有 worktree 状态
|
|
29
|
+
/git-worktree remove <path> # 删除指定的 worktree
|
|
30
|
+
/git-worktree prune # 清理无效 worktree 记录
|
|
31
|
+
|
|
32
|
+
# 内容迁移
|
|
33
|
+
/git-worktree migrate <target> --from <source> # 迁移未提交内容
|
|
34
|
+
/git-worktree migrate <target> --stash # 迁移 stash 内容
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Options
|
|
38
|
+
|
|
39
|
+
| 选项 | 说明 |
|
|
40
|
+
| ------------------ | -------------------------------------------- |
|
|
41
|
+
| `add [<path>]` | 在 `../.zcf/项目名/<path>` 添加新的 worktree |
|
|
42
|
+
| `migrate <target>` | 迁移内容到指定 worktree |
|
|
43
|
+
| `list` | 列出所有 worktree 及其状态 |
|
|
44
|
+
| `remove <path>` | 删除指定路径的 worktree |
|
|
45
|
+
| `prune` | 清理无效的 worktree 引用 |
|
|
46
|
+
| `-b <branch>` | 创建新分支并检出到 worktree |
|
|
47
|
+
| `-o, --open` | 创建成功后直接用 IDE 打开(跳过询问) |
|
|
48
|
+
| `--from <source>` | 指定迁移源路径(migrate 专用) |
|
|
49
|
+
| `--stash` | 迁移当前 stash 内容(migrate 专用) |
|
|
50
|
+
| `--track` | 设置新分支跟踪对应的远程分支 |
|
|
51
|
+
| `--guess-remote` | 自动猜测远程分支进行跟踪 |
|
|
52
|
+
| `--detach` | 创建分离 HEAD 的 worktree |
|
|
53
|
+
| `--checkout` | 创建后立即检出(默认行为) |
|
|
54
|
+
| `--lock` | 创建后锁定 worktree |
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## What This Command Does
|
|
59
|
+
|
|
60
|
+
1. **环境检查**
|
|
61
|
+
- 通过 `git rev-parse --is-inside-work-tree` 验证 Git 仓库
|
|
62
|
+
- 检测是否在主仓库或现有 worktree 中,进行智能路径计算
|
|
63
|
+
|
|
64
|
+
2. **智能路径管理**
|
|
65
|
+
- 使用 worktree 检测自动从主仓库路径计算项目名
|
|
66
|
+
- 在结构化的 `../.zcf/项目名/<path>` 目录创建 worktree
|
|
67
|
+
- 正确处理主仓库和 worktree 执行上下文
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
# worktree 检测的核心路径计算逻辑
|
|
71
|
+
get_main_repo_path() {
|
|
72
|
+
local git_common_dir=$(git rev-parse --git-common-dir 2>/dev/null)
|
|
73
|
+
local current_toplevel=$(git rev-parse --show-toplevel 2>/dev/null)
|
|
74
|
+
|
|
75
|
+
# 检测是否在 worktree 中
|
|
76
|
+
if [[ "$git_common_dir" != "$current_toplevel/.git" ]]; then
|
|
77
|
+
# 在 worktree 中,从 git-common-dir 推导主仓库路径
|
|
78
|
+
dirname "$git_common_dir"
|
|
79
|
+
else
|
|
80
|
+
# 在主仓库中
|
|
81
|
+
echo "$current_toplevel"
|
|
82
|
+
fi
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
MAIN_REPO_PATH=$(get_main_repo_path)
|
|
86
|
+
PROJECT_NAME=$(basename "$MAIN_REPO_PATH")
|
|
87
|
+
WORKTREE_BASE="$MAIN_REPO_PATH/../.zcf/$PROJECT_NAME"
|
|
88
|
+
|
|
89
|
+
# 始终使用绝对路径防止嵌套问题
|
|
90
|
+
ABSOLUTE_WORKTREE_PATH="$WORKTREE_BASE/<path>"
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
**关键修复**: 在现有 worktree 内创建新 worktree 时,始终使用绝对路径以防止出现类似 `../.zcf/project/.zcf/project/path` 的路径嵌套问题。
|
|
94
|
+
|
|
95
|
+
3. **Worktree 操作**
|
|
96
|
+
- **add**: 使用智能分支/路径默认创建新 worktree
|
|
97
|
+
- **list**: 显示所有 worktree 的分支和状态
|
|
98
|
+
- **remove**: 安全删除 worktree 并清理引用
|
|
99
|
+
- **prune**: 清理孤立的 worktree 记录
|
|
100
|
+
|
|
101
|
+
4. **智能默认**
|
|
102
|
+
- **分支创建**: 未指定 `-b` 时,使用路径名创建新分支
|
|
103
|
+
- **基础分支**: 新分支从 main/master 分支创建
|
|
104
|
+
- **路径解析**: 未指定路径时使用分支名作为路径
|
|
105
|
+
- **IDE 集成**: 自动检测并提示 IDE 打开
|
|
106
|
+
|
|
107
|
+
5. **内容迁移**
|
|
108
|
+
- 在 worktree 之间迁移未提交改动
|
|
109
|
+
- 将 stash 内容应用到目标 worktree
|
|
110
|
+
- 安全检查防止冲突
|
|
111
|
+
|
|
112
|
+
6. **安全特性**
|
|
113
|
+
- **路径冲突防护**: 创建前检查目录是否已存在
|
|
114
|
+
- **分支检出验证**: 确保分支未被其他地方使用
|
|
115
|
+
- **绝对路径强制**: 防止在 worktree 内创建嵌套的 `.zcf` 目录
|
|
116
|
+
- **删除时自动清理**: 同时清理目录和 git 引用
|
|
117
|
+
- **清晰的状态报告**: 显示 worktree 位置和分支状态
|
|
118
|
+
|
|
119
|
+
7. **环境文件处理**
|
|
120
|
+
- **自动检测**: 扫描 `.gitignore` 文件中的环境变量文件模式
|
|
121
|
+
- **智能复制**: 复制 `.gitignore` 中列出的 `.env` 和 `.env.*` 文件
|
|
122
|
+
- **排除逻辑**: 跳过 `.env.example` 等模板文件
|
|
123
|
+
- **权限保护**: 保持原始文件权限和时间戳
|
|
124
|
+
- **用户反馈**: 提供已复制环境文件的清晰状态信息
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
# 环境文件复制实现
|
|
128
|
+
copy_environment_files() {
|
|
129
|
+
local main_repo="$MAIN_REPO_PATH"
|
|
130
|
+
local target_worktree="$ABSOLUTE_WORKTREE_PATH"
|
|
131
|
+
local gitignore_file="$main_repo/.gitignore"
|
|
132
|
+
|
|
133
|
+
# 检查 .gitignore 是否存在
|
|
134
|
+
if [[ ! -f "$gitignore_file" ]]; then
|
|
135
|
+
return 0
|
|
136
|
+
fi
|
|
137
|
+
|
|
138
|
+
local copied_count=0
|
|
139
|
+
|
|
140
|
+
# 检测 .env 文件
|
|
141
|
+
if [[ -f "$main_repo/.env" ]] && grep -q "^\.env$" "$gitignore_file"; then
|
|
142
|
+
cp "$main_repo/.env" "$target_worktree/.env"
|
|
143
|
+
echo "✅ 已复制 .env"
|
|
144
|
+
((copied_count++))
|
|
145
|
+
fi
|
|
146
|
+
|
|
147
|
+
# 检测 .env.* 模式文件(排除 .env.example)
|
|
148
|
+
for env_file in "$main_repo"/.env.*; do
|
|
149
|
+
if [[ -f "$env_file" ]] && [[ "$(basename "$env_file")" != ".env.example" ]]; then
|
|
150
|
+
local filename=$(basename "$env_file")
|
|
151
|
+
if grep -q "^\.env\.\*$" "$gitignore_file"; then
|
|
152
|
+
cp "$env_file" "$target_worktree/$filename"
|
|
153
|
+
echo "✅ 已复制 $filename"
|
|
154
|
+
((copied_count++))
|
|
155
|
+
fi
|
|
156
|
+
fi
|
|
157
|
+
done
|
|
158
|
+
|
|
159
|
+
if [[ $copied_count -gt 0 ]]; then
|
|
160
|
+
echo "📋 已从 .gitignore 复制 $copied_count 个环境文件"
|
|
161
|
+
fi
|
|
162
|
+
}
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
## Enhanced Features
|
|
168
|
+
|
|
169
|
+
### IDE 集成
|
|
170
|
+
|
|
171
|
+
- **自动检测**: VS Code → Cursor → WebStorm → Sublime Text → Vim
|
|
172
|
+
- **智能提示**: 创建 worktree 后询问是否在 IDE 中打开
|
|
173
|
+
- **直接打开**: 使用 `-o` 标志跳过提示直接打开
|
|
174
|
+
- **自定义配置**: 通过 git config 配置
|
|
175
|
+
|
|
176
|
+
### 内容迁移系统
|
|
177
|
+
|
|
178
|
+
```bash
|
|
179
|
+
# 迁移未提交改动
|
|
180
|
+
/git-worktree migrate feature-ui --from main
|
|
181
|
+
/git-worktree migrate hotfix --from ../other-worktree
|
|
182
|
+
|
|
183
|
+
# 迁移 stash 内容
|
|
184
|
+
/git-worktree migrate feature-ui --stash
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
**迁移流程**:
|
|
188
|
+
|
|
189
|
+
1. 验证源有未提交内容
|
|
190
|
+
2. 确保目标 worktree 干净
|
|
191
|
+
3. 显示即将迁移的改动
|
|
192
|
+
4. 使用 git 命令安全迁移
|
|
193
|
+
5. 确认结果并建议后续步骤
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## Examples
|
|
198
|
+
|
|
199
|
+
```bash
|
|
200
|
+
# 基本用法
|
|
201
|
+
/git-worktree add feature-ui # 从 main/master 创建新分支 'feature-ui'
|
|
202
|
+
/git-worktree add feature-ui -b my-feature # 创建新分支 'my-feature',路径为 'feature-ui'
|
|
203
|
+
/git-worktree add feature-ui -o # 创建并直接用 IDE 打开
|
|
204
|
+
|
|
205
|
+
# 内容迁移场景
|
|
206
|
+
/git-worktree add feature-ui -b feature/new-ui # 创建新功能 worktree
|
|
207
|
+
/git-worktree migrate feature-ui --from main # 迁移未提交改动
|
|
208
|
+
/git-worktree migrate hotfix --stash # 迁移 stash 内容
|
|
209
|
+
|
|
210
|
+
# 管理操作
|
|
211
|
+
/git-worktree list # 查看所有 worktree
|
|
212
|
+
/git-worktree remove feature-ui # 删除不需要的 worktree
|
|
213
|
+
/git-worktree prune # 清理无效引用
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
**示例输出**:
|
|
217
|
+
|
|
218
|
+
```
|
|
219
|
+
✅ Worktree created at ../.zcf/项目名/feature-ui
|
|
220
|
+
✅ 已复制 .env
|
|
221
|
+
✅ 已复制 .env.local
|
|
222
|
+
📋 已从 .gitignore 复制 2 个环境文件
|
|
223
|
+
🖥️ 是否在 IDE 中打开 ../.zcf/项目名/feature-ui?[y/n]: y
|
|
224
|
+
🚀 正在用 VS Code 打开 ../.zcf/项目名/feature-ui...
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
---
|
|
228
|
+
|
|
229
|
+
## Directory Structure
|
|
230
|
+
|
|
231
|
+
```
|
|
232
|
+
parent-directory/
|
|
233
|
+
├── your-project/ # 主项目
|
|
234
|
+
│ ├── .git/
|
|
235
|
+
│ └── src/
|
|
236
|
+
└── .zcf/ # worktree 管理
|
|
237
|
+
└── your-project/ # 项目 worktree
|
|
238
|
+
├── feature-ui/ # 功能分支
|
|
239
|
+
├── hotfix/ # 修复分支
|
|
240
|
+
└── debug/ # 调试 worktree
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
## Configuration
|
|
246
|
+
|
|
247
|
+
### IDE 配置
|
|
248
|
+
|
|
249
|
+
- 支持 VS Code、Cursor、WebStorm、Sublime Text、Vim
|
|
250
|
+
- 通过 git config 配置自定义 IDE
|
|
251
|
+
- 基于优先级的自动检测选择
|
|
252
|
+
|
|
253
|
+
### 自定义 IDE 设置
|
|
254
|
+
|
|
255
|
+
```bash
|
|
256
|
+
# 配置自定义 IDE
|
|
257
|
+
git config worktree.ide.custom.sublime "subl %s"
|
|
258
|
+
git config worktree.ide.preferred "sublime"
|
|
259
|
+
|
|
260
|
+
# 控制自动检测
|
|
261
|
+
git config worktree.ide.autodetect true # 默认
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
---
|
|
265
|
+
|
|
266
|
+
## Notes
|
|
267
|
+
|
|
268
|
+
- **性能**: worktree 共享 `.git` 目录,节省磁盘空间
|
|
269
|
+
- **安全**: 路径冲突防护和分支检出验证
|
|
270
|
+
- **迁移**: 仅限未提交改动;已提交内容需使用 `git cherry-pick`
|
|
271
|
+
- **IDE 要求**: 命令行工具必须在 PATH 中
|
|
272
|
+
- **跨平台**: 支持 Windows、macOS、Linux
|
|
273
|
+
- **环境文件**: 自动复制 `.gitignore` 中列出的环境文件到新 worktree
|
|
274
|
+
- **文件排除**: 模板文件如 `.env.example` 仅保留在主仓库中
|
|
275
|
+
|
|
276
|
+
---
|
|
@@ -9,16 +9,15 @@ description: '专业AI编程助手,提供结构化六阶段开发工作流(
|
|
|
9
9
|
## 使用方法
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
/workflow
|
|
13
|
-
<任务描述>
|
|
12
|
+
/zcf:workflow <任务描述>
|
|
14
13
|
```
|
|
15
14
|
|
|
16
15
|
## 上下文
|
|
17
16
|
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
17
|
+
- 要开发的任务:$ARGUMENTS
|
|
18
|
+
- 带质量把关的结构化 6 阶段工作流
|
|
19
|
+
- 面向专业开发者的交互
|
|
20
|
+
- MCP 服务集成以增强功能
|
|
22
21
|
|
|
23
22
|
## 你的角色
|
|
24
23
|
|
|
@@ -34,7 +33,7 @@ description: '专业AI编程助手,提供结构化六阶段开发工作流(
|
|
|
34
33
|
1. `[模式:研究]`:理解需求并评估完整性(0-10 分),低于 7 分时主动要求补充关键信息。
|
|
35
34
|
2. `[模式:构思]`:提供至少两种可行方案及评估(例如:`方案 1:描述`)。
|
|
36
35
|
3. `[模式:计划]`:将选定方案细化为详尽、有序、可执行的步骤清单(含原子操作:文件、函数/类、逻辑概要;预期结果;新库用 `Context7` 查询)。不写完整代码。完成后请求用户批准。
|
|
37
|
-
4. `[模式:执行]`:必须用户批准方可执行。严格按计划编码执行。计划简要(含上下文和计划)存入当前项目根目录的`.
|
|
36
|
+
4. `[模式:执行]`:必须用户批准方可执行。严格按计划编码执行。计划简要(含上下文和计划)存入当前项目根目录的`.codex/plan/任务名.md`。关键步骤后及完成时请求用户反馈。
|
|
38
37
|
5. `[模式:优化]`:在 `[模式:执行]` 完成后,必须自动进行本模式 `[模式:优化]`,自动检查并分析本次任务已实现(仅本次对话产生的相关代码),在 `[模式:执行]` 下产生的相关代码。聚焦冗余、低效、垃圾代码,提出具体优化建议(含优化理由与预期收益),用户确认后执行相关优化功能。
|
|
39
38
|
6. `[模式:评审]`:对照计划评估执行结果,报告问题与建议。完成后请求用户确认。
|
|
40
39
|
|
|
@@ -50,26 +49,16 @@ description: '专业AI编程助手,提供结构化六阶段开发工作流(
|
|
|
50
49
|
|
|
51
50
|
---
|
|
52
51
|
|
|
53
|
-
##
|
|
52
|
+
## 执行工作流
|
|
54
53
|
|
|
55
|
-
|
|
54
|
+
**任务描述**:$ARGUMENTS
|
|
56
55
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
**请描述您需要开发的具体任务**,我将根据您的需求启动相应的工作流程。
|
|
60
|
-
|
|
61
|
-
*等待您的任务描述...*
|
|
62
|
-
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
## 工作流模板(收到任务描述后自动执行)
|
|
56
|
+
正在启动带质量把关的结构化开发工作流...
|
|
66
57
|
|
|
67
58
|
### 🔍 阶段 1:研究与分析
|
|
68
59
|
|
|
69
60
|
[模式:研究] - 理解需求并收集上下文:
|
|
70
61
|
|
|
71
|
-
**分析用户提供的任务描述,然后执行以下流程:**
|
|
72
|
-
|
|
73
62
|
#### 需求完整性评分(0-10 分)
|
|
74
63
|
|
|
75
64
|
评分维度:
|
|
@@ -122,11 +111,11 @@ description: '专业AI编程助手,提供结构化六阶段开发工作流(
|
|
|
122
111
|
|
|
123
112
|
**自动获取的项目信息**(不需要询问):
|
|
124
113
|
|
|
125
|
-
- 技术栈(从 CLAUDE.md、package.json、requirements.txt 等获取)
|
|
126
|
-
- 框架版本(从 CLAUDE.md、配置文件获取)
|
|
114
|
+
- 技术栈(从 AGENTS.md、CLAUDE.md、package.json、requirements.txt 等获取)
|
|
115
|
+
- 框架版本(从 AGENTS.md、CLAUDE.md、配置文件获取)
|
|
127
116
|
- 项目结构(从文件系统获取)
|
|
128
|
-
- 现有代码规范(从 CLAUDE.md、配置文件和现有代码获取)
|
|
129
|
-
- 开发命令(从 CLAUDE.md 获取,如构建、测试、类型检查等)
|
|
117
|
+
- 现有代码规范(从 AGENTS.md、CLAUDE.md、配置文件和现有代码获取)
|
|
118
|
+
- 开发命令(从 AGENTS.md、CLAUDE.md 获取,如构建、测试、类型检查等)
|
|
130
119
|
|
|
131
120
|
#### 执行步骤
|
|
132
121
|
|
|
@@ -162,7 +151,7 @@ description: '专业AI编程助手,提供结构化六阶段开发工作流(
|
|
|
162
151
|
- 根据批准的计划实施
|
|
163
152
|
- 遵循开发最佳实践
|
|
164
153
|
- 在导入语句之前添加使用方法(关键规则)
|
|
165
|
-
- 在项目根目录 `.
|
|
154
|
+
- 在项目根目录 `.codex/plan/任务名.md` 中存储执行计划
|
|
166
155
|
- 在关键里程碑请求反馈
|
|
167
156
|
|
|
168
157
|
### 🚀 阶段 5:代码优化
|
|
@@ -187,7 +176,7 @@ description: '专业AI编程助手,提供结构化六阶段开发工作流(
|
|
|
187
176
|
|
|
188
177
|
```
|
|
189
178
|
project/ # 项目根目录
|
|
190
|
-
├── .
|
|
179
|
+
├── .codex/
|
|
191
180
|
│ └── plan/
|
|
192
181
|
│ └── 任务名.md # 执行计划和上下文(在项目根目录)
|
|
193
182
|
├── src/
|
|
@@ -202,10 +191,4 @@ project/ # 项目根目录
|
|
|
202
191
|
└── README.md
|
|
203
192
|
```
|
|
204
193
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
**📌 使用说明**:
|
|
208
|
-
1. 用户调用 `/workflow` 后,先显示欢迎信息
|
|
209
|
-
2. 等待用户在下一条消息中提供具体任务描述
|
|
210
|
-
3. 收到任务描述后,立即按上述 6 阶段模板执行工作流
|
|
211
|
-
4. 在每个阶段完成后报告进度并请求用户确认
|
|
194
|
+
**使用提供的任务描述开始执行,并在每个阶段完成后报告进度。**
|