clawt 3.7.0 → 3.8.0
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/.claude/agents/docs-sync-updater.md +44 -24
- package/.clawt/postCreate.sh +2 -0
- package/CLAUDE.md +10 -0
- package/README.md +50 -2
- package/dist/index.js +180 -29
- package/dist/postinstall.js +33 -1
- package/docs/alias.md +114 -0
- package/docs/completion.md +55 -0
- package/docs/config-file.md +49 -0
- package/docs/config.md +93 -0
- package/docs/cover-validate.md +94 -0
- package/docs/create.md +105 -0
- package/docs/home.md +70 -0
- package/docs/init.md +89 -0
- package/docs/list.md +73 -0
- package/docs/log.md +67 -0
- package/docs/merge.md +152 -0
- package/docs/notification.md +94 -0
- package/docs/post-create-hook.md +142 -0
- package/docs/project-config.md +139 -0
- package/docs/projects.md +135 -0
- package/docs/remove.md +90 -0
- package/docs/reset.md +37 -0
- package/docs/resume.md +132 -0
- package/docs/run.md +150 -0
- package/docs/spec.md +431 -0
- package/docs/status.md +345 -0
- package/docs/sync.md +128 -0
- package/docs/tasks.md +74 -0
- package/docs/update-check.md +95 -0
- package/docs/validate.md +416 -0
- package/package.json +1 -1
- package/src/commands/create.ts +5 -0
- package/src/commands/run.ts +12 -0
- package/src/constants/config.ts +1 -1
- package/src/constants/git.ts +3 -0
- package/src/constants/messages/index.ts +2 -0
- package/src/constants/messages/post-create.ts +29 -0
- package/src/constants/project-config.ts +4 -0
- package/src/hooks/index.ts +1 -0
- package/src/hooks/post-create.ts +198 -0
- package/src/types/command.ts +4 -0
- package/src/types/index.ts +1 -0
- package/src/types/postCreateHook.ts +24 -0
- package/src/types/projectConfig.ts +3 -1
- package/src/utils/claude.ts +2 -1
- package/src/utils/git-core.ts +4 -0
- package/src/utils/index.ts +1 -0
- package/src/utils/shell.ts +3 -0
- package/src/utils/task-executor.ts +5 -1
- package/tests/unit/commands/create.test.ts +1 -0
- package/tests/unit/commands/run.test.ts +1 -0
- package/tests/unit/constants/messages-post-create.test.ts +112 -0
- package/tests/unit/hooks/post-create.test.ts +434 -0
- package/tests/unit/utils/claude.test.ts +76 -1
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
### 5.7 默认配置文件
|
|
2
|
+
|
|
3
|
+
**路径:** `~/.clawt/config.json`
|
|
4
|
+
|
|
5
|
+
**生成时机:** 全局安装后自动生成(通过 `postinstall` 脚本)。
|
|
6
|
+
|
|
7
|
+
**升级策略:** 配置文件已存在时,执行增量合并而非简单跳过:
|
|
8
|
+
|
|
9
|
+
- **新版本新增的配置项** → 使用默认值补充到用户配置中
|
|
10
|
+
- **用户已有的配置项** → 保留用户的值,不覆盖
|
|
11
|
+
- **新版本已移除的配置项** → 从用户配置中删除
|
|
12
|
+
|
|
13
|
+
仅在合并后配置发生变化时才写入文件。配置文件损坏或无法解析时,视为不存在,重新生成默认配置。
|
|
14
|
+
|
|
15
|
+
**默认内容:**
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"autoDeleteBranch": false,
|
|
20
|
+
"claudeCodeCommand": "claude",
|
|
21
|
+
"autoPullPush": false,
|
|
22
|
+
"confirmDestructiveOps": true,
|
|
23
|
+
"maxConcurrency": 0,
|
|
24
|
+
"terminalApp": "auto",
|
|
25
|
+
"resumeInPlace": false,
|
|
26
|
+
"aliases": {},
|
|
27
|
+
"autoUpdate": true,
|
|
28
|
+
"conflictResolveMode": "ask",
|
|
29
|
+
"conflictResolveTimeoutMs": 300000
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
**配置项说明:**
|
|
34
|
+
|
|
35
|
+
| 配置项 | 类型 | 默认值 | 说明 |
|
|
36
|
+
| ------------------ | --------- | --------- | -------------------------------------------------- |
|
|
37
|
+
| `autoDeleteBranch` | `boolean` | `false` | 移除 worktree 时是否自动删除对应本地分支(无需每次确认);merge 成功后是否自动清理 worktree 和分支;run 任务被中断(Ctrl+C)后是否自动清理本次创建的 worktree 和分支 |
|
|
38
|
+
| `claudeCodeCommand` | `string` | `"claude"` | Claude Code CLI 启动指令,用于 `clawt run` 不传 `--tasks` 时和 `clawt resume` 在 worktree 中打开交互式界面 |
|
|
39
|
+
| `autoPullPush` | `boolean` | `false` | merge 成功后是否自动执行 git pull 和 git push |
|
|
40
|
+
| `confirmDestructiveOps` | `boolean` | `true` | 执行破坏性操作(reset、validate --clean)前是否提示确认 |
|
|
41
|
+
| `maxConcurrency` | `number` | `0` | run 命令默认最大并发数,`0` 表示不限制 |
|
|
42
|
+
| `terminalApp` | `string` | `"auto"` | 批量 resume 使用的终端应用:`auto`(自动检测)、`iterm2`、`terminal`(macOS) |
|
|
43
|
+
| `resumeInPlace` | `boolean` | `false` | resume 单选时是否在当前终端就地打开,`false` 则通过 `terminalApp` 在新 Tab 中打开 |
|
|
44
|
+
| `aliases` | `Record<string, string>` | `{}` | 命令别名映射,键为别名,值为目标内置命令名 |
|
|
45
|
+
| `autoUpdate` | `boolean` | `true` | 是否启用自动更新检查(每 24 小时通过 npm registry 检查一次新版本) |
|
|
46
|
+
| `conflictResolveMode` | `string` | `"ask"` | merge 冲突时的解决模式:`ask`(询问是否使用 AI)、`auto`(自动 AI 解决)、`manual`(手动解决) |
|
|
47
|
+
| `conflictResolveTimeoutMs` | `number` | `300000` | Claude Code 冲突解决超时时间(毫秒),默认 300000(5 分钟) |
|
|
48
|
+
|
|
49
|
+
---
|
package/docs/config.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
### 5.10 交互式查看和修改全局配置
|
|
2
|
+
|
|
3
|
+
**命令:**
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
# 交互式修改配置(等同于 config set 无参数)
|
|
7
|
+
clawt config
|
|
8
|
+
|
|
9
|
+
# 修改配置项(无参数进入交互式,有参数直接设置)
|
|
10
|
+
clawt config set [key] [value]
|
|
11
|
+
|
|
12
|
+
# 获取单个配置项的值
|
|
13
|
+
clawt config get <key>
|
|
14
|
+
|
|
15
|
+
# 将配置恢复为默认值
|
|
16
|
+
clawt config reset
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
#### 交互式修改配置(`config` / `config set`)
|
|
20
|
+
|
|
21
|
+
直接执行 `clawt config` 或 `clawt config set`(不带参数)进入交互式配置修改模式。
|
|
22
|
+
|
|
23
|
+
**运行流程:**
|
|
24
|
+
|
|
25
|
+
1. 读取全局配置文件 `~/.clawt/config.json`
|
|
26
|
+
2. 列出所有配置项供用户选择(`Enquirer.Select`),每项显示:
|
|
27
|
+
- 配置项名称
|
|
28
|
+
- 当前值(布尔值绿色/黄色,字符串和数字青色)
|
|
29
|
+
- 配置项描述(暗淡色 dim)
|
|
30
|
+
- 对象类型配置项(如 `aliases`)标灰不可选,提示用户通过专用命令管理
|
|
31
|
+
3. 用户选择某个配置项后,根据值类型自动选择提示策略:
|
|
32
|
+
- **boolean 类型** → `Select`(true / false)
|
|
33
|
+
- **number 类型** → `Input`(带数字校验)
|
|
34
|
+
- **string 类型 + 有 `allowedValues`** → `Select`(枚举列表)
|
|
35
|
+
- **string 类型 + 无 `allowedValues`** → `Input`(自由输入)
|
|
36
|
+
4. 将修改后的配置持久化到配置文件
|
|
37
|
+
5. 输出成功提示:`✓ <key> 已设置为 <value>`
|
|
38
|
+
|
|
39
|
+
#### 直接设置配置项(`config set <key> <value>`)
|
|
40
|
+
|
|
41
|
+
当带参数执行 `clawt config set <key> <value>` 时,直接修改指定配置项。
|
|
42
|
+
|
|
43
|
+
**参数:**
|
|
44
|
+
|
|
45
|
+
| 参数 | 必填 | 说明 |
|
|
46
|
+
| ---- | ---- | ---- |
|
|
47
|
+
| `key` | 否 | 配置项名称(不传则进入交互式模式) |
|
|
48
|
+
| `value` | 否 | 配置值(传了 `key` 时必填) |
|
|
49
|
+
|
|
50
|
+
**运行流程:**
|
|
51
|
+
|
|
52
|
+
1. 校验 `key` 是否为有效的配置项名称(基于 `DEFAULT_CONFIG` 的键列表),无效则输出错误及可用配置项列表
|
|
53
|
+
2. 校验 `value` 是否缺失,缺失则提示:`缺少配置值,用法: clawt config set <key> <value>`
|
|
54
|
+
3. 根据目标配置项的类型解析并校验值:
|
|
55
|
+
- **boolean** → 仅接受 `true` 或 `false`
|
|
56
|
+
- **number** → `Number()` 解析,`NaN` 报错
|
|
57
|
+
- **string + 有 `allowedValues`** → 校验值是否在枚举列表中
|
|
58
|
+
- **string + 无 `allowedValues`** → 无额外校验
|
|
59
|
+
4. 加载配置、修改目标项、持久化
|
|
60
|
+
5. 输出成功提示:`✓ <key> 已设置为 <value>`
|
|
61
|
+
|
|
62
|
+
#### 获取单个配置项(`config get <key>`)
|
|
63
|
+
|
|
64
|
+
**参数:**
|
|
65
|
+
|
|
66
|
+
| 参数 | 必填 | 说明 |
|
|
67
|
+
| ---- | ---- | ---- |
|
|
68
|
+
| `key` | 是 | 配置项名称 |
|
|
69
|
+
|
|
70
|
+
**运行流程:**
|
|
71
|
+
|
|
72
|
+
1. 校验 `key` 是否为有效的配置项名称,无效则输出错误及可用配置项列表
|
|
73
|
+
2. 读取配置文件,获取目标配置项的值
|
|
74
|
+
3. 输出:`<key> = <value>`
|
|
75
|
+
|
|
76
|
+
#### 恢复默认配置(`config reset`)
|
|
77
|
+
|
|
78
|
+
**运行流程:**
|
|
79
|
+
|
|
80
|
+
1. 始终提示确认(显示即将执行的操作和后果:当前配置将被覆盖为默认值),不受 `confirmDestructiveOps` 配置控制。用户取消则退出
|
|
81
|
+
2. 将默认配置写入 `~/.clawt/config.json`(覆盖现有配置文件)
|
|
82
|
+
3. 输出成功提示:`✓ 配置已恢复为默认值`
|
|
83
|
+
|
|
84
|
+
**实现要点:**
|
|
85
|
+
|
|
86
|
+
- 配置项类型定义:`ConfigItemDefinition` 新增可选字段 `allowedValues`(`readonly string[]`),仅对 string 类型有效,用于枚举值校验和交互式 Select 提示
|
|
87
|
+
- 值解析与提示策略:`src/utils/config-strategy.ts` 中的 `parseConfigValue()`(CLI 字符串解析)和 `promptConfigValue()`(交互式提示),基于类型和 `allowedValues` 自动分发
|
|
88
|
+
- 交互式配置编辑:`handleInteractiveConfigSet` 调用通用的 `interactiveConfigEditor`(`src/utils/config-strategy.ts`),传入 `CONFIG_DEFINITIONS` 和 `disabledKeys`(对象类型配置项禁用映射),不再在 config 命令中直接构建选择列表和调用 `promptConfigValue`
|
|
89
|
+
- `saveConfig(config)`:`src/utils/config.ts` 中的通用配置写入函数,将完整配置对象持久化到文件
|
|
90
|
+
- `formatConfigValue(value)`:支持 boolean(绿色/黄色)和 string/number(青色)的格式化显示。`undefined` / `null` 值显示为暗淡色的 `(未设置)`
|
|
91
|
+
- 对象类型配置项(如 `aliases`)的显示逻辑在 `interactiveConfigEditor` 的列表构建中处理:通过 `JSON.stringify` 以暗淡色显示值,并标记为不可选(disabled),提示用户通过 `clawt alias` 命令管理
|
|
92
|
+
|
|
93
|
+
---
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
### 5.21 将验证分支修改覆盖回目标 Worktree
|
|
2
|
+
|
|
3
|
+
**命令:**
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
clawt cover
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
> 无需指定分支名,自动从当前验证分支名(`clawt-validate-<branchName>`)中推导目标分支。
|
|
10
|
+
|
|
11
|
+
**参数:**
|
|
12
|
+
|
|
13
|
+
无额外参数。必须在验证分支上执行。
|
|
14
|
+
|
|
15
|
+
**使用场景:**
|
|
16
|
+
|
|
17
|
+
在 `validate` 验证过程中,用户可能会在主 worktree(验证分支上)对代码进行修改(如修复测试失败、调整逻辑等)。`cover` 命令用于将这些修改覆盖回目标 worktree,使目标 worktree 的代码与验证分支上的最新状态同步。
|
|
18
|
+
|
|
19
|
+
**运行流程:**
|
|
20
|
+
|
|
21
|
+
##### 步骤 1:前置校验
|
|
22
|
+
|
|
23
|
+
1. **主 worktree 校验**(`requireMainWorktree`)
|
|
24
|
+
2. **HEAD 校验**(`requireHead`)
|
|
25
|
+
3. **项目级配置校验**(`requireProjectConfig`)
|
|
26
|
+
4. **验证分支校验**:当前分支必须以 `clawt-validate-` 开头,否则报错退出
|
|
27
|
+
|
|
28
|
+
##### 步骤 2:查找目标 worktree
|
|
29
|
+
|
|
30
|
+
从验证分支名中提取目标分支名(去掉 `clawt-validate-` 前缀),然后在项目的 worktree 列表中精确匹配目标分支对应的 worktree。如果目标 worktree 不存在(可能已被移除),报错退出。
|
|
31
|
+
|
|
32
|
+
##### 步骤 3:校验快照存在并读取
|
|
33
|
+
|
|
34
|
+
校验目标分支的 validate 快照是否存在。如果快照不存在,提示用户先执行 `clawt validate -b <branch>` 创建快照。读取快照中的 tree hash(`snapshotTreeHash`),作为增量计算的基准。
|
|
35
|
+
|
|
36
|
+
##### 步骤 3.5:工作区干净检查
|
|
37
|
+
|
|
38
|
+
检测主 worktree(验证分支上)的工作区和暂存区是否干净(`isWorkingDirClean`):
|
|
39
|
+
|
|
40
|
+
- **不干净**(有修改)→ 正常继续,这是 cover 的典型使用场景
|
|
41
|
+
- **干净**(无修改)→ 输出提示信息 `当前验证分支的工作区和暂存区没有任何修改,可能为误操作`,并通过 `confirmAction` 询问用户 `是否继续执行覆盖?`:
|
|
42
|
+
- 用户确认 → 继续执行
|
|
43
|
+
- 用户取消 → 直接返回,不执行后续步骤
|
|
44
|
+
|
|
45
|
+
> 工作区干净时通常意味着用户没有在验证分支上做任何修改就执行了 cover,这大概率是误操作。增加确认提示可以避免不必要的覆盖操作。
|
|
46
|
+
|
|
47
|
+
##### 步骤 4:计算增量 patch
|
|
48
|
+
|
|
49
|
+
通过 `computeIncrementalPatch()` 计算验证分支上相对于快照的增量变更:
|
|
50
|
+
|
|
51
|
+
1. 保存当前暂存区的 tree hash(`savedIndexTreeHash`),用于后续恢复
|
|
52
|
+
2. `git add .` + `git write-tree` 获取当前工作区的完整 tree hash(`currentTreeHash`)
|
|
53
|
+
3. 通过 `git read-tree` 恢复原始暂存区状态(无论成功失败都执行,在 `finally` 块中)
|
|
54
|
+
4. 比较 `snapshotTreeHash` 与 `currentTreeHash`:
|
|
55
|
+
- **相同** → 无增量变更,输出提示后返回
|
|
56
|
+
- **不同** → 通过 `git diff-tree` 生成 patch
|
|
57
|
+
|
|
58
|
+
##### 步骤 5:应用 patch 到目标 worktree
|
|
59
|
+
|
|
60
|
+
将增量 patch 通过 `git apply --binary` 应用到目标 worktree 的工作区。如果 patch apply 失败,报错退出并提示用户检查目标 worktree 工作区状态。
|
|
61
|
+
|
|
62
|
+
##### 步骤 6:更新快照
|
|
63
|
+
|
|
64
|
+
将 `currentTreeHash` 写入快照的 `.tree` 文件,使后续再次 cover 时的基准正确。**只更新 `treeHash`,不更新 `headCommitHash` 和 `stagedTreeHash`**(保留 validate 时写入的原值)。
|
|
65
|
+
|
|
66
|
+
##### 步骤 7:输出成功提示
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
✓ 已将验证分支上的修改覆盖到 worktree => <branchName>
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**错误消息:**
|
|
73
|
+
|
|
74
|
+
| 消息常量 | 触发条件 | 提示内容 |
|
|
75
|
+
| -------- | -------- | -------- |
|
|
76
|
+
| `COVER_VALIDATE_NOT_ON_VALIDATE_BRANCH` | 当前分支不是验证分支 | 提示先通过 `clawt validate` 切换到验证分支 |
|
|
77
|
+
| `COVER_VALIDATE_TARGET_NOT_FOUND` | 目标 worktree 不存在 | 提示确认该 worktree 尚未被移除 |
|
|
78
|
+
| `COVER_VALIDATE_NO_SNAPSHOT` | 无快照 | 提示先执行 `clawt validate -b <branch>` 创建快照 |
|
|
79
|
+
| `COVER_VALIDATE_NO_CHANGES` | 无增量变更 | 提示无需覆盖 |
|
|
80
|
+
| `COVER_VALIDATE_WORKING_DIR_CLEAN` | 工作区干净 | 提示可能为误操作,需确认是否继续 |
|
|
81
|
+
| `COVER_VALIDATE_APPLY_FAILED` | patch 应用失败 | 提示检查目标 worktree 工作区状态后重试 |
|
|
82
|
+
|
|
83
|
+
**实现要点:**
|
|
84
|
+
|
|
85
|
+
- 命令注册名为 `cover`(非 `cover-validate`),用户通过 `clawt cover` 调用
|
|
86
|
+
- 核心函数:`handleCoverValidate()`(`src/commands/cover-validate.ts`)
|
|
87
|
+
- 辅助函数:
|
|
88
|
+
- `extractTargetBranchName()`:从验证分支名提取目标分支名
|
|
89
|
+
- `findTargetWorktreePath()`:查找目标 worktree 路径
|
|
90
|
+
- `computeIncrementalPatch()`:计算增量 patch
|
|
91
|
+
- 消息常量:`COVER_VALIDATE_MESSAGES`(`src/constants/messages/cover-validate.ts`)
|
|
92
|
+
- `writeSnapshot` 调用时只传 `treeHash`,利用其可选参数特性保留磁盘上的 `headCommitHash` 和 `stagedTreeHash` 原值
|
|
93
|
+
|
|
94
|
+
---
|
package/docs/create.md
ADDED
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
### 5.1 批量创建 Worktree(Worktree 对应分支)
|
|
2
|
+
|
|
3
|
+
**命令:**
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
clawt create -b <branchName> [-n <count>] [--no-post-create]
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
**参数:**
|
|
10
|
+
|
|
11
|
+
| 参数 | 必填 | 说明 |
|
|
12
|
+
| ---- | ---- | ----------------------------------------------------- |
|
|
13
|
+
| `-b, --branch` | 是 | 分支名 |
|
|
14
|
+
| `-n, --number` | 否 | 需要创建的 worktree 数量,默认 `1` |
|
|
15
|
+
| `--post-create` | 否 | 执行 postCreate hook(默认开启,`--no-post-create` 跳过)。详见 [post-create-hook.md](./post-create-hook.md) |
|
|
16
|
+
|
|
17
|
+
**运行流程:**
|
|
18
|
+
|
|
19
|
+
通过 `runPreChecks(PRE_CHECK_CREATE)` 执行统一前置校验,包含以下检查项:
|
|
20
|
+
|
|
21
|
+
1. **主 worktree 校验**(`requireMainWorktree`)(2.1)
|
|
22
|
+
2. **HEAD 存在性校验**(`requireHead`):确保仓库有至少一次 commit
|
|
23
|
+
3. **确保在主工作分支上**(`ensureOnClawtMainWorkBranch`):在创建 worktree 之前,确保当前处于配置的主工作分支(`clawtMainWorkBranch`)上。
|
|
24
|
+
- 如果当前分支**是** `clawtMainWorkBranch`,正常继续
|
|
25
|
+
- 如果当前在**验证分支**(`clawt-validate-` 前缀)上:
|
|
26
|
+
- 验证分支上的修改视为可丢弃的临时状态
|
|
27
|
+
- 如果工作区有未提交更改,自动执行 `git reset --hard HEAD && git clean -fd` 清理;若已干净则跳过清理
|
|
28
|
+
- 然后自动切换到主工作分支,继续创建流程
|
|
29
|
+
- 如果当前在**其他普通分支**上:
|
|
30
|
+
- 首先显示警告:`当前分支 <currentBranch> 与配置的主工作分支 <mainBranch> 不一致,如需更新请执行 clawt init`
|
|
31
|
+
- 然后通过 `confirmAction('是否继续执行?')` 让用户确认是否继续;用户拒绝则抛出"已取消操作"退出
|
|
32
|
+
- 用户确认后,如果工作区有未提交的更改,提供交互式选择(避免将修改意外带到主工作分支上):
|
|
33
|
+
```
|
|
34
|
+
⚠ 当前分支有未提交的更改,请选择处理方式:
|
|
35
|
+
|
|
36
|
+
❯ reset - 丢弃所有更改 (git reset --hard HEAD && git clean -fd)
|
|
37
|
+
stash - 暂存更改 (git add . && git stash)
|
|
38
|
+
exit - 退出,手动处理
|
|
39
|
+
```
|
|
40
|
+
- 选择 reset → 执行 `git reset --hard HEAD && git clean -fd`
|
|
41
|
+
- 选择 stash → 执行 `git add . && git stash push -m "clawt:auto-stash"`
|
|
42
|
+
- 选择 exit → 抛出错误"用户选择退出,请手动处理工作区更改后重试"
|
|
43
|
+
- 处理完成后再次校验工作区是否干净,不干净则报错"工作区仍然不干净,请手动处理"
|
|
44
|
+
- 执行 `git checkout <clawtMainWorkBranch>`,然后继续创建流程
|
|
45
|
+
4. **主分支工作区干净校验**(`requireCleanWorkingDir`):确保主工作分支的工作区和暂存区干净,存在未提交更改时报错"主 worktree 有未提交的更改,请先处理"
|
|
46
|
+
5. **创建数量校验**:校验 `-n` 参数必须为正整数,否则报错 `无效的创建数量: "<value>",请输入正整数`
|
|
47
|
+
6. **分支名合法性校验与转换** (2.3)
|
|
48
|
+
7. **分支名存在性校验** (2.4)
|
|
49
|
+
- 若 `n = 1`:校验 `branchName`
|
|
50
|
+
- 若 `n > 1`:校验 `branchName-1` 到 `branchName-n`
|
|
51
|
+
- 所有分支名在创建任何 worktree **之前**完成全部校验
|
|
52
|
+
8. **批量创建 worktree + 验证分支**
|
|
53
|
+
- 若 `n = 1`:
|
|
54
|
+
```bash
|
|
55
|
+
git worktree add -b <branchName> ~/.clawt/worktrees/<project>/<branchName>
|
|
56
|
+
git branch clawt-validate-<branchName>
|
|
57
|
+
```
|
|
58
|
+
- 若 `n > 1`:
|
|
59
|
+
```bash
|
|
60
|
+
git worktree add -b <branchName>-1 ~/.clawt/worktrees/<project>/<branchName>-1
|
|
61
|
+
git branch clawt-validate-<branchName>-1
|
|
62
|
+
git worktree add -b <branchName>-2 ~/.clawt/worktrees/<project>/<branchName>-2
|
|
63
|
+
git branch clawt-validate-<branchName>-2
|
|
64
|
+
...
|
|
65
|
+
git worktree add -b <branchName>-n ~/.clawt/worktrees/<project>/<branchName>-n
|
|
66
|
+
git branch clawt-validate-<branchName>-n
|
|
67
|
+
```
|
|
68
|
+
9. **执行 postCreate hook**:调用 `runPostCreateHooks(worktrees, !options.postCreate)` 以 fire-and-forget 模式后台异步并行执行 postCreate hook(用户自定义的初始化操作)。`--no-post-create` 时跳过。详见 [post-create-hook.md](./post-create-hook.md)
|
|
69
|
+
10. **输出创建日志**
|
|
70
|
+
|
|
71
|
+
**输出格式:**
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
✓ 已创建 3 个 worktree
|
|
75
|
+
|
|
76
|
+
目录路径1:
|
|
77
|
+
~/.clawt/worktrees/main-project/feature-scheme-1
|
|
78
|
+
分支名: feature-scheme-1
|
|
79
|
+
验证分支: clawt-validate-feature-scheme-1
|
|
80
|
+
────────────────────────────────────────
|
|
81
|
+
目录路径2:
|
|
82
|
+
~/.clawt/worktrees/main-project/feature-scheme-2
|
|
83
|
+
分支名: feature-scheme-2
|
|
84
|
+
验证分支: clawt-validate-feature-scheme-2
|
|
85
|
+
────────────────────────────────────────
|
|
86
|
+
目录路径3:
|
|
87
|
+
~/.clawt/worktrees/main-project/feature-scheme-3
|
|
88
|
+
分支名: feature-scheme-3
|
|
89
|
+
验证分支: clawt-validate-feature-scheme-3
|
|
90
|
+
────────────────────────────────────────
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
**实现要点:**
|
|
94
|
+
|
|
95
|
+
- 前置校验配置定义在 `src/constants/pre-checks.ts` 的 `PRE_CHECK_CREATE` 常量中
|
|
96
|
+
- 分支名清理逻辑在 `src/utils/branch.ts` 的 `sanitizeBranchName` 中
|
|
97
|
+
- 分支名生成逻辑在 `src/utils/branch.ts` 的 `generateBranchNames` 中
|
|
98
|
+
- worktree 批量创建逻辑在 `src/utils/worktree.ts` 的 `createWorktrees` 中
|
|
99
|
+
- 确保在主工作分支的逻辑在 `src/utils/validate-branch.ts` 的 `ensureOnMainWorkBranch` 中
|
|
100
|
+
- 脏工作区交互处理逻辑在 `src/utils/validate-branch.ts` 的 `handleDirtyWorkingDir` 中
|
|
101
|
+
- 相关消息常量定义在 `src/constants/messages/create.ts` 和 `src/constants/messages/common.ts` 中
|
|
102
|
+
- postCreate hook 执行逻辑在 `src/hooks/post-create.ts` 中,通过 `src/utils/index.js` 统一导出 `runPostCreateHooks`
|
|
103
|
+
- hook 相关消息常量定义在 `src/constants/messages/post-create.ts` 中
|
|
104
|
+
|
|
105
|
+
---
|
package/docs/home.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
### 5.20 切换回主工作分支
|
|
2
|
+
|
|
3
|
+
**命令:**
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
clawt home
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
**参数:**
|
|
10
|
+
|
|
11
|
+
无参数。
|
|
12
|
+
|
|
13
|
+
**功能说明:**
|
|
14
|
+
|
|
15
|
+
切换回项目的主工作分支。当用户在主 worktree 中处于验证分支或其他分支时,可通过 `clawt home` 一键切换回 `clawtMainWorkBranch` 所记录的主工作分支。
|
|
16
|
+
|
|
17
|
+
**运行流程:**
|
|
18
|
+
|
|
19
|
+
1. **场景判断**:根据当前所在位置区分三种场景:
|
|
20
|
+
- **场景 1:不在 git 仓库中** → 输出错误提示 `请在主 worktree 的根目录下执行 clawt`,退出
|
|
21
|
+
- **场景 2:在子 worktree 中** → 输出提示信息,引导用户先 `cd` 到主 worktree 路径
|
|
22
|
+
- **场景 3:在主 worktree 中** → 执行前置校验后切换到主工作分支
|
|
23
|
+
2. **前置校验**(仅场景 3):调用 `runPreChecks` 执行统一前置校验:
|
|
24
|
+
- `requireHead`:校验 HEAD 是否存在(仓库至少有一次 commit)
|
|
25
|
+
- `requireProjectConfig`:校验项目配置文件是否存在且合法
|
|
26
|
+
- `requireMainBranchExists`:校验配置中的主工作分支在 git 仓库中是否存在
|
|
27
|
+
3. **获取分支信息**(仅场景 3):
|
|
28
|
+
- 通过 `getMainWorkBranch()` 获取主工作分支名
|
|
29
|
+
- 通过 `getCurrentBranch()` 获取当前所在分支名
|
|
30
|
+
4. **判断是否需要切换**:
|
|
31
|
+
- 当前分支 === 主工作分支 → 输出提示信息,无需切换
|
|
32
|
+
- 当前分支 !== 主工作分支 → 调用 `ensureOnMainWorkBranch()` 执行切换
|
|
33
|
+
5. **输出结果**
|
|
34
|
+
|
|
35
|
+
**输出格式:**
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
# 不在 git 仓库中
|
|
39
|
+
✗ 请在主 worktree 的根目录下执行 clawt
|
|
40
|
+
|
|
41
|
+
# 在子 worktree 中
|
|
42
|
+
💡 当前在子 worktree 中,请先切换到主 worktree:
|
|
43
|
+
cd <主 worktree 路径>
|
|
44
|
+
|
|
45
|
+
# 已在主工作分支上
|
|
46
|
+
已在主工作分支 main 上,无需切换
|
|
47
|
+
|
|
48
|
+
# 切换成功
|
|
49
|
+
✓ 已从 clawt-validate-feat-login 切换到主工作分支 main
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
**消息常量:**
|
|
53
|
+
|
|
54
|
+
定义在 `src/constants/messages/home.ts`:
|
|
55
|
+
|
|
56
|
+
| 常量 | 说明 |
|
|
57
|
+
| --- | --- |
|
|
58
|
+
| `HOME_ALREADY_ON_MAIN(branch)` | 已在主工作分支上,无需切换 |
|
|
59
|
+
| `HOME_SWITCH_SUCCESS(from, to)` | 切换成功提示,显示原分支和目标分支 |
|
|
60
|
+
| `HOME_NOT_IN_MAIN_WORKTREE(mainPath)` | 在子 worktree 中,提示 cd 到主 worktree 路径 |
|
|
61
|
+
|
|
62
|
+
**实现要点:**
|
|
63
|
+
|
|
64
|
+
- 命令注册函数 `registerHomeCommand` 位于 `src/commands/home.ts`
|
|
65
|
+
- 不在 git 仓库中或在子 worktree 中的场景不需要 `runPreChecks`,直接在命令处理函数中判断并输出
|
|
66
|
+
- 前置校验通过 `runPreChecks` 统一调用,传入 `requireHead`、`requireProjectConfig`、`requireMainBranchExists` 三项校验(仅场景 3)
|
|
67
|
+
- 主逻辑依赖 `ensureOnMainWorkBranch`、`getCurrentBranch`、`getMainWorkBranch`、`isMainWorktree`、`isInsideGitRepo`、`getMainWorktreePath` 等工具函数
|
|
68
|
+
- `ensureOnMainWorkBranch()` 仅在需要切换时才调用(当前分支不等于主工作分支时)
|
|
69
|
+
|
|
70
|
+
---
|
package/docs/init.md
ADDED
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
### 5.19 初始化项目级配置
|
|
2
|
+
|
|
3
|
+
**命令:**
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
# 设置主工作分支(使用当前分支)
|
|
7
|
+
clawt init
|
|
8
|
+
|
|
9
|
+
# 设置主工作分支(指定分支名)
|
|
10
|
+
clawt init -b <branchName>
|
|
11
|
+
|
|
12
|
+
# 交互式查看和修改项目配置
|
|
13
|
+
clawt init show
|
|
14
|
+
|
|
15
|
+
# 以 JSON 格式输出项目配置
|
|
16
|
+
clawt init show --json
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
**参数:**
|
|
20
|
+
|
|
21
|
+
| 参数/子命令 | 必填 | 说明 |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| `-b` | 否 | 指定主工作分支名。不传则使用当前分支 |
|
|
24
|
+
| `show` | 否 | 交互式查看和修改项目配置 |
|
|
25
|
+
| `show --json` | 否 | 以 JSON 格式输出项目配置(跳过交互式流程) |
|
|
26
|
+
|
|
27
|
+
**功能说明:**
|
|
28
|
+
|
|
29
|
+
初始化项目级配置,将指定分支记录为该项目的主工作分支(`clawtMainWorkBranch`)。该配置用于 `create` / `run` 时检测当前分支是否为主工作分支,并在偏离时提醒用户。`init show` 子命令提供交互式面板,可查看和修改所有项目配置项(如 `validateRunCommand`、`postCreate`)。项目级配置的完整说明见 [project-config.md](./project-config.md)。
|
|
30
|
+
|
|
31
|
+
**运行流程(设置模式):**
|
|
32
|
+
|
|
33
|
+
1. **主 worktree 校验** (2.1)
|
|
34
|
+
2. **加载现有配置**:尝试读取 `~/.clawt/projects/<projectName>/config.json`(可能为 `null`)
|
|
35
|
+
3. **确定主工作分支名**:
|
|
36
|
+
- 传了 `-b` → 使用指定的分支名
|
|
37
|
+
- 未传 `-b` → 先验证 HEAD 存在,再使用当前分支名(`git rev-parse --abbrev-ref HEAD`)
|
|
38
|
+
4. **合并并写入项目级配置**:将 `clawtMainWorkBranch` 合并到现有配置并写入 `~/.clawt/projects/<projectName>/config.json`
|
|
39
|
+
- 配置文件不存在 → 创建新配置
|
|
40
|
+
- 配置文件已存在 → 合并现有配置,仅更新 `clawtMainWorkBranch` 字段(保留其他配置项不变)
|
|
41
|
+
5. **输出成功提示**:
|
|
42
|
+
- 已有配置 → `✓ 已将主工作分支从 <旧分支> 更新为 <新分支>`
|
|
43
|
+
- 无已有配置 → `✓ 项目初始化成功,主工作分支设置为: <分支名>`
|
|
44
|
+
|
|
45
|
+
**运行流程(show 模式):**
|
|
46
|
+
|
|
47
|
+
1. **主 worktree 校验** (2.1)
|
|
48
|
+
2. **项目配置校验**(`requireProjectConfig`):读取 `~/.clawt/projects/<projectName>/config.json`
|
|
49
|
+
- 配置不存在 → 抛出错误 `项目尚未初始化,请先执行 clawt init 设置主工作分支`
|
|
50
|
+
- 配置缺少 `clawtMainWorkBranch` 字段 → 抛出错误 `项目配置缺少主工作分支信息,请重新执行 clawt init 设置主工作分支`
|
|
51
|
+
- 配置存在且合法 → 继续
|
|
52
|
+
2.5. **`--json` 模式判断**:如果指定了 `--json` 选项,直接以 JSON 格式输出当前项目配置,跳过交互式流程并返回
|
|
53
|
+
3. **交互式配置编辑**:调用 `interactiveConfigEditor`(`src/utils/config-strategy.ts`),基于 `PROJECT_CONFIG_DEFINITIONS` 构建配置项列表(详见 [project-config.md](./project-config.md))
|
|
54
|
+
- 列出所有项目配置项,显示名称、当前值和描述
|
|
55
|
+
- 用户选择配置项后,根据值类型自动选择输入方式(与全局配置的交互式编辑逻辑一致)
|
|
56
|
+
4. **持久化修改**:将修改后的值合并到当前配置并写入配置文件
|
|
57
|
+
5. **输出成功提示**:`✓ 项目配置 <key> 已设置为 <value>`
|
|
58
|
+
|
|
59
|
+
**输出格式:**
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
# 首次初始化
|
|
63
|
+
✓ 项目初始化成功,主工作分支设置为: main
|
|
64
|
+
|
|
65
|
+
# 更新已有配置
|
|
66
|
+
✓ 已将主工作分支从 develop 更新为 main
|
|
67
|
+
|
|
68
|
+
# show 交互式修改成功
|
|
69
|
+
✓ 项目配置 validateRunCommand 已设置为 npm test
|
|
70
|
+
|
|
71
|
+
# show --json 输出
|
|
72
|
+
{"clawtMainWorkBranch":"main","validateRunCommand":"npm test","postCreate":"npm install"}
|
|
73
|
+
|
|
74
|
+
# show 未初始化(抛出错误)
|
|
75
|
+
项目尚未初始化,请先执行 clawt init 设置主工作分支
|
|
76
|
+
|
|
77
|
+
# show 配置缺少主工作分支字段(抛出错误)
|
|
78
|
+
项目配置缺少主工作分支信息,请重新执行 clawt init 设置主工作分支
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
**重复执行:** 支持重复执行,后一次会合并到现有配置中更新 `clawtMainWorkBranch`,不影响其他配置项。
|
|
82
|
+
|
|
83
|
+
**实现要点:**
|
|
84
|
+
|
|
85
|
+
- `init show` 子命令从 JSON 展示改为交互式面板,调用 `interactiveConfigEditor`(`src/utils/config-strategy.ts`)实现通用交互式配置编辑
|
|
86
|
+
- 配置项定义来自 `PROJECT_CONFIG_DEFINITIONS`(`src/constants/project-config.ts`),详见 [项目级配置文档](./project-config.md)
|
|
87
|
+
- 消息常量:`MESSAGES.INIT_SELECT_PROMPT`(选择配置项提示语)、`MESSAGES.INIT_SET_SUCCESS`(修改成功提示),定义在 `src/constants/messages/init.ts`
|
|
88
|
+
|
|
89
|
+
---
|
package/docs/list.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
### 5.8 获取当前项目所有 Worktree
|
|
2
|
+
|
|
3
|
+
**命令:**
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
clawt list [--json]
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
**参数:**
|
|
10
|
+
|
|
11
|
+
| 参数 | 必填 | 说明 |
|
|
12
|
+
| -------- | ---- | ---------------------------------------- |
|
|
13
|
+
| `--json` | 否 | 以 JSON 格式输出(仅包含 path 和 branch) |
|
|
14
|
+
|
|
15
|
+
**运行流程:**
|
|
16
|
+
|
|
17
|
+
1. **主 worktree 校验** (2.1)
|
|
18
|
+
2. **获取项目名** (2.2)
|
|
19
|
+
3. 获取项目的所有 worktree 列表(扫描 `~/.clawt/worktrees/<project>/` 目录,与 `git worktree list` 交叉验证)
|
|
20
|
+
4. 根据 `--json` 选项决定输出格式:
|
|
21
|
+
- 指定 `--json` → 以 JSON 格式输出(仅包含 path 和 branch)
|
|
22
|
+
- 未指定 → 以文本格式输出(包含变更状态信息)
|
|
23
|
+
|
|
24
|
+
**文本输出格式(默认):**
|
|
25
|
+
|
|
26
|
+
每个 worktree 会显示路径、分支名和变更状态。每个 worktree 条目下方额外显示一行状态信息(提交数、变更行数、未提交修改),各条目之间以空行分隔。如果某个 worktree 处于空闲状态(0 个提交、无变更、无未提交修改),其路径会以橙色高亮显示,方便用户快速识别可能需要清理或还未开始工作的 worktree。
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
当前项目: main-project
|
|
30
|
+
|
|
31
|
+
~/.clawt/worktrees/main-project/feature-scheme-1 [feature-scheme-1]
|
|
32
|
+
3 个提交 +120 -30 (未提交修改)
|
|
33
|
+
|
|
34
|
+
~/.clawt/worktrees/main-project/feature-scheme-2 [feature-scheme-2]
|
|
35
|
+
1 个提交 +45 -10
|
|
36
|
+
|
|
37
|
+
~/.clawt/worktrees/main-project/feature-scheme-3 [feature-scheme-3] ← 橙色路径(空闲)
|
|
38
|
+
0 个提交 无变更
|
|
39
|
+
|
|
40
|
+
~/.clawt/worktrees/main-project/bugfix-login [bugfix-login]
|
|
41
|
+
2 个提交 +80 -25
|
|
42
|
+
|
|
43
|
+
共 4 个 worktree
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
如果没有 worktree:
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
当前项目: main-project
|
|
50
|
+
|
|
51
|
+
(无 worktree)
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
**JSON 输出格式(`--json`):**
|
|
55
|
+
|
|
56
|
+
```json
|
|
57
|
+
{
|
|
58
|
+
"project": "main-project",
|
|
59
|
+
"total": 4,
|
|
60
|
+
"worktrees": [
|
|
61
|
+
{
|
|
62
|
+
"path": "~/.clawt/worktrees/main-project/feature-scheme-1",
|
|
63
|
+
"branch": "feature-scheme-1"
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"path": "~/.clawt/worktrees/main-project/feature-scheme-2",
|
|
67
|
+
"branch": "feature-scheme-2"
|
|
68
|
+
}
|
|
69
|
+
]
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
---
|
package/docs/log.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
### 5.9 日志系统
|
|
2
|
+
|
|
3
|
+
**日志目录:** `~/.clawt/logs/`
|
|
4
|
+
|
|
5
|
+
**日志文件命名:** `clawt-YYYY-MM-DD.log`(按日期滚动)
|
|
6
|
+
|
|
7
|
+
**日志级别:**
|
|
8
|
+
|
|
9
|
+
| 级别 | 说明 | 使用场景 |
|
|
10
|
+
| ------- | ------------------ | -------------------------------------- |
|
|
11
|
+
| `debug` | 调试信息 | Git 命令执行详情、变量值等 |
|
|
12
|
+
| `info` | 一般信息 | 操作开始/完成、创建/移除 worktree 等 |
|
|
13
|
+
| `warn` | 警告信息 | 分支名被转换、非致命异常等 |
|
|
14
|
+
| `error` | 错误信息 | 命令执行失败、校验不通过等 |
|
|
15
|
+
|
|
16
|
+
**实现方案:** 使用 `winston` + `winston-daily-rotate-file` 库。
|
|
17
|
+
|
|
18
|
+
**日志格式:**
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
[2025-02-06 14:30:22] [INFO ] 创建 worktree: ~/.clawt/worktrees/main-project/feature-scheme-1
|
|
22
|
+
[2025-02-06 14:30:22] [DEBUG] 执行命令: git worktree add -b feature-scheme-1 ~/.clawt/worktrees/main-project/feature-scheme-1
|
|
23
|
+
[2025-02-06 14:30:23] [WARN ] 分支名已转换: feature/a.b → feature-a-b
|
|
24
|
+
[2025-02-06 14:30:25] [ERROR] 分支 feature-scheme-1 已存在,无法创建
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**保留策略:**
|
|
28
|
+
|
|
29
|
+
- 日志文件保留 30 天
|
|
30
|
+
- 单个日志文件最大 10MB
|
|
31
|
+
|
|
32
|
+
#### `--debug` 控制台调试输出
|
|
33
|
+
|
|
34
|
+
通过全局选项 `--debug` 可将调试日志实时输出到终端,方便排查问题。
|
|
35
|
+
|
|
36
|
+
**实现机制:**
|
|
37
|
+
|
|
38
|
+
- 在 Commander.js 的 `preAction` 钩子中检测 `--debug` 选项,按需调用 `enableConsoleTransport()` 函数
|
|
39
|
+
- `enableConsoleTransport()` 动态向 winston 实例添加 `Console` transport(level 为 `debug`),该函数幂等,多次调用不会重复添加 transport
|
|
40
|
+
- 相关常量定义在 `src/constants/logger.ts`:
|
|
41
|
+
- `DEBUG_TIMESTAMP_FORMAT`:时间戳格式(`HH:mm:ss.SSS`,精简,不含日期)
|
|
42
|
+
|
|
43
|
+
**控制台日志格式:**
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
HH:mm:ss.SSS LEVEL 消息内容
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
**日志级别颜色映射:**
|
|
50
|
+
|
|
51
|
+
| 级别 | 颜色 |
|
|
52
|
+
| ------- | ------ |
|
|
53
|
+
| `error` | 红色 |
|
|
54
|
+
| `warn` | 黄色 |
|
|
55
|
+
| `info` | 青色 |
|
|
56
|
+
| `debug` | 灰色 |
|
|
57
|
+
|
|
58
|
+
**使用示例:**
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
clawt run -b feature-login --debug
|
|
62
|
+
clawt validate -b feature-scheme --debug
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
> **注意:** `--debug` 选项不影响文件日志(file transport),文件日志始终按原有策略写入。控制台输出仅在传入 `--debug` 时启用。
|
|
66
|
+
|
|
67
|
+
---
|