clawt 3.6.0 → 3.6.2

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/docs/alias.md DELETED
@@ -1,114 +0,0 @@
1
- ### 5.15 命令别名管理
2
-
3
- **命令:**
4
-
5
- ```bash
6
- # 列出所有命令别名
7
- clawt alias
8
- clawt alias list
9
-
10
- # 设置命令别名
11
- clawt alias set <alias> <command>
12
-
13
- # 移除命令别名
14
- clawt alias remove <alias>
15
- ```
16
-
17
- **子命令:**
18
-
19
- | 子命令 | 说明 |
20
- | ------ | ---- |
21
- | `clawt alias` / `clawt alias list` | 列出所有已配置的命令别名 |
22
- | `clawt alias set <alias> <command>` | 设置命令别名,将 `<alias>` 映射到 `<command>` |
23
- | `clawt alias remove <alias>` | 移除指定的命令别名 |
24
-
25
- **参数:**
26
-
27
- | 参数 | 必填 | 说明 |
28
- | ---- | ---- | ---- |
29
- | `<alias>` | 是(set / remove) | 别名名称 |
30
- | `<command>` | 是(set) | 目标内置命令名 |
31
-
32
- **约束规则:**
33
-
34
- 1. **别名不能覆盖内置命令名**:别名不能与任何已注册的内置命令同名(动态检测,当前包括 `list`、`create`、`remove`、`run`、`resume`、`validate`、`cover`、`merge`、`config`、`sync`、`reset`、`status`、`alias`、`projects`、`completion`、`init`、`home`)。如果用户尝试设置与内置命令同名的别名,输出错误提示并返回
35
- 2. **目标必须是内置命令**:别名的目标(`<command>`)必须是已注册的内置命令名。如果指定了不存在的目标命令,输出错误提示并返回
36
- 3. **参数透传**:通过别名调用时,所有选项和参数会完全透传给目标命令,行为与直接调用目标命令完全一致
37
-
38
- **持久化:**
39
-
40
- 别名配置存储在 `~/.clawt/config.json` 的 `aliases` 字段中(类型 `Record<string, string>`,默认 `{}`)。
41
-
42
- **运行流程:**
43
-
44
- #### `alias list`(默认)
45
-
46
- 1. 读取配置文件中的 `aliases` 字段
47
- 2. 如果没有配置任何别名,输出提示 `(无别名)`
48
- 3. 如果有别名,逐行输出所有别名映射
49
-
50
- **输出格式:**
51
-
52
- ```
53
- 当前别名列表:
54
- ────────────────────────────────────────
55
-
56
- l → list
57
- r → run
58
- v → validate
59
-
60
- ────────────────────────────────────────
61
- ```
62
-
63
- #### `alias set <alias> <command>`
64
-
65
- 1. **校验别名不与内置命令冲突**:检查 `<alias>` 是否为内置命令名,是则输出错误提示并返回
66
- 2. **校验目标命令存在**:检查 `<command>` 是否为已注册的内置命令名,不是则输出错误提示并返回
67
- 3. 将别名写入配置文件的 `aliases` 字段(如果别名已存在,覆盖旧值)
68
- 4. 输出成功提示
69
-
70
- **输出格式:**
71
-
72
- ```
73
- ✓ 已设置别名: l → list
74
- ```
75
-
76
- #### `alias remove <alias>`
77
-
78
- 1. 读取配置文件中的 `aliases` 字段
79
- 2. 检查指定的别名是否存在,不存在则输出错误提示并返回
80
- 3. 从 `aliases` 中删除该别名并写入配置文件
81
- 4. 输出成功提示
82
-
83
- **输出格式:**
84
-
85
- ```
86
- ✓ 已移除别名: l
87
- ```
88
-
89
- **别名使用示例:**
90
-
91
- ```bash
92
- # 设置别名
93
- clawt alias set l list
94
- clawt alias set r run
95
- clawt alias set v validate
96
-
97
- # 使用别名(等同于对应的完整命令)
98
- clawt l # 等同于 clawt list
99
- clawt r task.md # 等同于 clawt run task.md
100
-
101
- # 查看所有别名
102
- clawt alias list
103
-
104
- # 移除别名
105
- clawt alias remove l
106
- ```
107
-
108
- **实现要点:**
109
-
110
- - 消息常量定义在 `src/constants/messages/alias.ts`(`ALIAS_MESSAGES`),包括列表为空提示、设置/移除成功、别名不存在、与内置命令冲突、目标命令不存在等消息
111
- - 别名应用逻辑位于 `src/utils/alias.ts` 的 `applyAliases` 函数:在主入口 `src/index.ts` 中,所有命令注册完成后调用,遍历配置中的 `aliases` 映射,通过 Commander.js 的 `.alias()` 方法为对应命令注册别名。如果目标命令不存在则跳过并输出 warn 级别日志
112
- - 内置命令冲突检测通过 `getRegisteredCommandNames(program)` 动态获取所有已注册命令名,而非硬编码命令列表
113
-
114
- ---
@@ -1,55 +0,0 @@
1
- ### 5.16 `clawt completion` 命令
2
-
3
- 为终端环境(bash/zsh)生成并安装 `clawt` 的命令、选项及参数的自动补全脚本。
4
-
5
- #### 语法
6
- ```bash
7
- clawt completion bash
8
- clawt completion zsh
9
- clawt completion install
10
- ```
11
-
12
- #### 子命令说明
13
-
14
- | 子命令 | 说明 |
15
- | --------- | ----------------------------------------------------------------------------------- |
16
- | `bash` | 输出适用于 bash 的补全脚本(用户可重定向到 `~/.bashrc`) |
17
- | `zsh` | 输出适用于 zsh 的补全脚本(用户可重定向到 `~/.zshrc`) |
18
- | `install` | 自动检测当前 shell 类型,将补全脚本追加到对应的配置文件中 |
19
-
20
- #### `install` 子命令流程
21
-
22
- 1. 通过 `process.env.SHELL` 检测当前 shell 类型
23
- 2. 根据 shell 类型确定目标配置文件:
24
- - zsh → `~/.zshrc`(追加 `source <(clawt completion zsh)`)
25
- - bash → `~/.bashrc`(追加 `eval "$(clawt completion bash)"`)
26
- 3. 检查目标文件中是否已包含 `clawt completion`,已存在则跳过并提示
27
- 4. 追加成功后提示用户重启终端或 source 配置文件
28
- 5. 未知 shell 类型时输出警告,提示手动配置
29
-
30
- #### 动态补全特性
31
-
32
- 补全脚本通过内部子命令 `_complete` 实现动态补全,不对外公开。补全引擎基于 Commander.js 的命令树结构遍历,支持以下场景:
33
-
34
- | 场景 | 补全行为 |
35
- | ---------------------------- | ---------------------------------------------------------- |
36
- | `-b` / `--branch` 参数之后 | 动态列出当前项目所有 worktree 分支名(通过 `getProjectWorktrees`) |
37
- | `-f` / `--file` 参数之后 | 动态列出匹配的文件和子目录(不限制文件类型,支持子目录递归浏览) |
38
- | `config set` / `config get` 之后 | 动态列出所有配置项键名(从 `CONFIG_DEFINITIONS` 获取) |
39
- | 输入以 `-` 开头 | 列出当前命令层级的可用选项(short/long) |
40
- | 其他情况 | 列出当前命令层级的可用子命令及别名;若输入为空,同时列出可用选项 |
41
-
42
- **文件路径补全细节:**
43
- - 支持子目录递归浏览(如 `tasks/` 后继续 Tab 可深入子目录)
44
- - 目录候选项以 `/` 结尾,补全时不自动追加空格
45
- - 不限制文件类型,列出所有非隐藏文件
46
- - 跳过隐藏文件和目录(以 `.` 开头)
47
-
48
- #### 实现说明
49
-
50
- - 补全命令注册函数:`registerCompletionCommand()`(在 `src/commands/completion.ts`)
51
- - 消息常量:`COMPLETION_MESSAGES`(在 `src/constants/messages/completion.ts`)
52
- - 核心函数:`generateCompletions()` 解析当前输入上下文并输出候选项,`completeFilePath()` 处理文件路径补全,`tryCompleteSpecialArg()` 处理特殊参数(分支名、文件路径、配置键)的动态补全,`completeFromCommandTree()` 基于命令树遍历生成子命令和选项候选项
53
- - shell 脚本生成:`getBashScript()`、`getZshScript()` 分别生成对应 shell 的补全脚本
54
-
55
- ---
@@ -1,45 +0,0 @@
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
- }
29
- ```
30
-
31
- **配置项说明:**
32
-
33
- | 配置项 | 类型 | 默认值 | 说明 |
34
- | ------------------ | --------- | --------- | -------------------------------------------------- |
35
- | `autoDeleteBranch` | `boolean` | `false` | 移除 worktree 时是否自动删除对应本地分支(无需每次确认);merge 成功后是否自动清理 worktree 和分支;run 任务被中断(Ctrl+C)后是否自动清理本次创建的 worktree 和分支 |
36
- | `claudeCodeCommand` | `string` | `"claude"` | Claude Code CLI 启动指令,用于 `clawt run` 不传 `--tasks` 时和 `clawt resume` 在 worktree 中打开交互式界面 |
37
- | `autoPullPush` | `boolean` | `false` | merge 成功后是否自动执行 git pull 和 git push |
38
- | `confirmDestructiveOps` | `boolean` | `true` | 执行破坏性操作(reset、validate --clean)前是否提示确认 |
39
- | `maxConcurrency` | `number` | `0` | run 命令默认最大并发数,`0` 表示不限制 |
40
- | `terminalApp` | `string` | `"auto"` | 批量 resume 使用的终端应用:`auto`(自动检测)、`iterm2`、`terminal`(macOS) |
41
- | `resumeInPlace` | `boolean` | `false` | resume 单选时是否在当前终端就地打开,`false` 则通过 `terminalApp` 在新 Tab 中打开 |
42
- | `aliases` | `Record<string, string>` | `{}` | 命令别名映射,键为别名,值为目标内置命令名 |
43
- | `autoUpdate` | `boolean` | `true` | 是否启用自动更新检查(每 24 小时通过 npm registry 检查一次新版本) |
44
-
45
- ---
package/docs/config.md DELETED
@@ -1,93 +0,0 @@
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
- ---
@@ -1,94 +0,0 @@
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 DELETED
@@ -1,101 +0,0 @@
1
- ### 5.1 批量创建 Worktree(Worktree 对应分支)
2
-
3
- **命令:**
4
-
5
- ```bash
6
- clawt create -b <branchName> [-n <count>]
7
- ```
8
-
9
- **参数:**
10
-
11
- | 参数 | 必填 | 说明 |
12
- | ---- | ---- | ----------------------------------------------------- |
13
- | `-b, --branch` | 是 | 分支名 |
14
- | `-n, --number` | 否 | 需要创建的 worktree 数量,默认 `1` |
15
-
16
- **运行流程:**
17
-
18
- 通过 `runPreChecks(PRE_CHECK_CREATE)` 执行统一前置校验,包含以下检查项:
19
-
20
- 1. **主 worktree 校验**(`requireMainWorktree`)(2.1)
21
- 2. **HEAD 存在性校验**(`requireHead`):确保仓库有至少一次 commit
22
- 3. **确保在主工作分支上**(`ensureOnClawtMainWorkBranch`):在创建 worktree 之前,确保当前处于配置的主工作分支(`clawtMainWorkBranch`)上。
23
- - 如果当前分支**是** `clawtMainWorkBranch`,正常继续
24
- - 如果当前在**验证分支**(`clawt-validate-` 前缀)上:
25
- - 验证分支上的修改视为可丢弃的临时状态
26
- - 如果工作区有未提交更改,自动执行 `git reset --hard HEAD && git clean -fd` 清理;若已干净则跳过清理
27
- - 然后自动切换到主工作分支,继续创建流程
28
- - 如果当前在**其他普通分支**上:
29
- - 首先显示警告:`当前分支 <currentBranch> 与配置的主工作分支 <mainBranch> 不一致,如需更新请执行 clawt init`
30
- - 然后通过 `confirmAction('是否继续执行?')` 让用户确认是否继续;用户拒绝则抛出"已取消操作"退出
31
- - 用户确认后,如果工作区有未提交的更改,提供交互式选择(避免将修改意外带到主工作分支上):
32
- ```
33
- ⚠ 当前分支有未提交的更改,请选择处理方式:
34
-
35
- ❯ reset - 丢弃所有更改 (git reset --hard HEAD && git clean -fd)
36
- stash - 暂存更改 (git add . && git stash)
37
- exit - 退出,手动处理
38
- ```
39
- - 选择 reset → 执行 `git reset --hard HEAD && git clean -fd`
40
- - 选择 stash → 执行 `git add . && git stash push -m "clawt:auto-stash"`
41
- - 选择 exit → 抛出错误"用户选择退出,请手动处理工作区更改后重试"
42
- - 处理完成后再次校验工作区是否干净,不干净则报错"工作区仍然不干净,请手动处理"
43
- - 执行 `git checkout <clawtMainWorkBranch>`,然后继续创建流程
44
- 4. **主分支工作区干净校验**(`requireCleanWorkingDir`):确保主工作分支的工作区和暂存区干净,存在未提交更改时报错"主 worktree 有未提交的更改,请先处理"
45
- 5. **创建数量校验**:校验 `-n` 参数必须为正整数,否则报错 `无效的创建数量: "<value>",请输入正整数`
46
- 6. **分支名合法性校验与转换** (2.3)
47
- 7. **分支名存在性校验** (2.4)
48
- - 若 `n = 1`:校验 `branchName`
49
- - 若 `n > 1`:校验 `branchName-1` 到 `branchName-n`
50
- - 所有分支名在创建任何 worktree **之前**完成全部校验
51
- 8. **批量创建 worktree + 验证分支**
52
- - 若 `n = 1`:
53
- ```bash
54
- git worktree add -b <branchName> ~/.clawt/worktrees/<project>/<branchName>
55
- git branch clawt-validate-<branchName>
56
- ```
57
- - 若 `n > 1`:
58
- ```bash
59
- git worktree add -b <branchName>-1 ~/.clawt/worktrees/<project>/<branchName>-1
60
- git branch clawt-validate-<branchName>-1
61
- git worktree add -b <branchName>-2 ~/.clawt/worktrees/<project>/<branchName>-2
62
- git branch clawt-validate-<branchName>-2
63
- ...
64
- git worktree add -b <branchName>-n ~/.clawt/worktrees/<project>/<branchName>-n
65
- git branch clawt-validate-<branchName>-n
66
- ```
67
- 9. **输出创建日志**
68
-
69
- **输出格式:**
70
-
71
- ```
72
- ✓ 已创建 3 个 worktree
73
-
74
- 目录路径1:
75
- ~/.clawt/worktrees/main-project/feature-scheme-1
76
- 分支名: feature-scheme-1
77
- 验证分支: clawt-validate-feature-scheme-1
78
- ────────────────────────────────────────
79
- 目录路径2:
80
- ~/.clawt/worktrees/main-project/feature-scheme-2
81
- 分支名: feature-scheme-2
82
- 验证分支: clawt-validate-feature-scheme-2
83
- ────────────────────────────────────────
84
- 目录路径3:
85
- ~/.clawt/worktrees/main-project/feature-scheme-3
86
- 分支名: feature-scheme-3
87
- 验证分支: clawt-validate-feature-scheme-3
88
- ────────────────────────────────────────
89
- ```
90
-
91
- **实现要点:**
92
-
93
- - 前置校验配置定义在 `src/constants/pre-checks.ts` 的 `PRE_CHECK_CREATE` 常量中
94
- - 分支名清理逻辑在 `src/utils/branch.ts` 的 `sanitizeBranchName` 中
95
- - 分支名生成逻辑在 `src/utils/branch.ts` 的 `generateBranchNames` 中
96
- - worktree 批量创建逻辑在 `src/utils/worktree.ts` 的 `createWorktrees` 中
97
- - 确保在主工作分支的逻辑在 `src/utils/validate-branch.ts` 的 `ensureOnMainWorkBranch` 中
98
- - 脏工作区交互处理逻辑在 `src/utils/validate-branch.ts` 的 `handleDirtyWorkingDir` 中
99
- - 相关消息常量定义在 `src/constants/messages/create.ts` 和 `src/constants/messages/common.ts` 中
100
-
101
- ---
package/docs/home.md DELETED
@@ -1,58 +0,0 @@
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. **前置校验**:调用 `runPreChecks` 执行统一前置校验:
20
- - `requireMainWorktree`:校验当前目录是否在主 worktree 根目录 (2.1)
21
- - `requireHead`:校验 HEAD 是否存在(仓库至少有一次 commit)
22
- - `requireProjectConfig`:校验项目配置文件是否存在且合法
23
- - `requireMainBranchExists`:校验配置中的主工作分支在 git 仓库中是否存在
24
- 2. **获取分支信息**:
25
- - 通过 `getMainWorkBranch()` 获取主工作分支名
26
- - 通过 `getCurrentBranch()` 获取当前所在分支名
27
- 3. **判断是否需要切换**:
28
- - 当前分支 === 主工作分支 → 输出提示信息,无需切换
29
- - 当前分支 !== 主工作分支 → 调用 `ensureOnMainWorkBranch()` 执行切换
30
- 4. **输出结果**
31
-
32
- **输出格式:**
33
-
34
- ```
35
- # 已在主工作分支上
36
- 已在主工作分支 main 上,无需切换
37
-
38
- # 切换成功
39
- ✓ 已从 clawt-validate-feat-login 切换到主工作分支 main
40
- ```
41
-
42
- **消息常量:**
43
-
44
- 定义在 `src/constants/messages/home.ts`:
45
-
46
- | 常量 | 说明 |
47
- | --- | --- |
48
- | `HOME_ALREADY_ON_MAIN(branch)` | 已在主工作分支上,无需切换 |
49
- | `HOME_SWITCH_SUCCESS(from, to)` | 切换成功提示,显示原分支和目标分支 |
50
-
51
- **实现要点:**
52
-
53
- - 命令注册函数 `registerHomeCommand` 位于 `src/commands/home.ts`
54
- - 前置校验通过 `runPreChecks` 统一调用,传入 `requireMainWorktree`、`requireHead`、`requireProjectConfig`、`requireMainBranchExists` 四项校验
55
- - 主逻辑依赖 `ensureOnMainWorkBranch`、`getCurrentBranch`、`getMainWorkBranch`、`guardMainWorkBranchExists` 等工具函数
56
- - `ensureOnMainWorkBranch()` 仅在需要切换时才调用(当前分支不等于主工作分支时)
57
-
58
- ---
package/docs/init.md DELETED
@@ -1,81 +0,0 @@
1
- ### 5.19 初始化项目级配置
2
-
3
- **命令:**
4
-
5
- ```bash
6
- # 设置主工作分支(使用当前分支)
7
- clawt init
8
-
9
- # 设置主工作分支(指定分支名)
10
- clawt init -b <branchName>
11
-
12
- # 查看当前项目的 init 配置
13
- clawt init show
14
- ```
15
-
16
- **参数:**
17
-
18
- | 参数/子命令 | 必填 | 说明 |
19
- | --- | --- | --- |
20
- | `-b` | 否 | 指定主工作分支名。不传则使用当前分支 |
21
- | `show` | 否 | 交互式查看和修改项目配置 |
22
-
23
- **功能说明:**
24
-
25
- 初始化项目级配置,将指定分支记录为该项目的主工作分支(`clawtMainWorkBranch`)。该配置用于 `create` / `run` 时检测当前分支是否为主工作分支,并在偏离时提醒用户。`init show` 子命令提供交互式面板,可查看和修改所有项目配置项(如 `validateRunCommand`)。项目级配置的完整说明见 [project-config.md](./project-config.md)。
26
-
27
- **运行流程(设置模式):**
28
-
29
- 1. **主 worktree 校验** (2.1)
30
- 2. **加载现有配置**:尝试读取 `~/.clawt/projects/<projectName>/config.json`(可能为 `null`)
31
- 3. **确定主工作分支名**:
32
- - 传了 `-b` → 使用指定的分支名
33
- - 未传 `-b` → 先验证 HEAD 存在,再使用当前分支名(`git rev-parse --abbrev-ref HEAD`)
34
- 4. **合并并写入项目级配置**:将 `clawtMainWorkBranch` 合并到现有配置并写入 `~/.clawt/projects/<projectName>/config.json`
35
- - 配置文件不存在 → 创建新配置
36
- - 配置文件已存在 → 合并现有配置,仅更新 `clawtMainWorkBranch` 字段(保留其他配置项不变)
37
- 5. **输出成功提示**:
38
- - 已有配置 → `✓ 已将主工作分支从 <旧分支> 更新为 <新分支>`
39
- - 无已有配置 → `✓ 项目初始化成功,主工作分支设置为: <分支名>`
40
-
41
- **运行流程(show 模式):**
42
-
43
- 1. **主 worktree 校验** (2.1)
44
- 2. **项目配置校验**(`requireProjectConfig`):读取 `~/.clawt/projects/<projectName>/config.json`
45
- - 配置不存在 → 抛出错误 `项目尚未初始化,请先执行 clawt init 设置主工作分支`
46
- - 配置缺少 `clawtMainWorkBranch` 字段 → 抛出错误 `项目配置缺少主工作分支信息,请重新执行 clawt init 设置主工作分支`
47
- - 配置存在且合法 → 进入交互式面板
48
- 3. **交互式配置编辑**:调用 `interactiveConfigEditor`(`src/utils/config-strategy.ts`),基于 `PROJECT_CONFIG_DEFINITIONS` 构建配置项列表(详见 [project-config.md](./project-config.md))
49
- - 列出所有项目配置项,显示名称、当前值和描述
50
- - 用户选择配置项后,根据值类型自动选择输入方式(与全局配置的交互式编辑逻辑一致)
51
- 4. **持久化修改**:将修改后的值合并到当前配置并写入配置文件
52
- 5. **输出成功提示**:`✓ 项目配置 <key> 已设置为 <value>`
53
-
54
- **输出格式:**
55
-
56
- ```
57
- # 首次初始化
58
- ✓ 项目初始化成功,主工作分支设置为: main
59
-
60
- # 更新已有配置
61
- ✓ 已将主工作分支从 develop 更新为 main
62
-
63
- # show 交互式修改成功
64
- ✓ 项目配置 validateRunCommand 已设置为 npm test
65
-
66
- # show 未初始化(抛出错误)
67
- 项目尚未初始化,请先执行 clawt init 设置主工作分支
68
-
69
- # show 配置缺少主工作分支字段(抛出错误)
70
- 项目配置缺少主工作分支信息,请重新执行 clawt init 设置主工作分支
71
- ```
72
-
73
- **重复执行:** 支持重复执行,后一次会合并到现有配置中更新 `clawtMainWorkBranch`,不影响其他配置项。
74
-
75
- **实现要点:**
76
-
77
- - `init show` 子命令从 JSON 展示改为交互式面板,调用 `interactiveConfigEditor`(`src/utils/config-strategy.ts`)实现通用交互式配置编辑
78
- - 配置项定义来自 `PROJECT_CONFIG_DEFINITIONS`(`src/constants/project-config.ts`),详见 [项目级配置文档](./project-config.md)
79
- - 消息常量:`MESSAGES.INIT_SELECT_PROMPT`(选择配置项提示语)、`MESSAGES.INIT_SET_SUCCESS`(修改成功提示),定义在 `src/constants/messages/init.ts`
80
-
81
- ---