CLAUDE.md · diff

git:20261107.27787e0 to git:20261107.83ddc00

3 added, 2 removed. Audit B to B.

# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## 项目概述
**sdkmate**(`sdkm`)是一款面向全栈工程师的跨平台 SDK 版本管理器,用 Rust 编写。通过符号链接切换 + 操作系统环境变量操纵,管理 Java、Node.js、Python、Maven、Go 等开发环境的版本。
## 构建与开发命令
```bash
cargo build # 调试构建
cargo build --release # 发布构建(产出 sdkm 二进制)
cargo test # 运行所有测试(workspace 级别)
cargo test -p <crate> # 运行指定 crate 的测试(cli / sdkcore / util)
cargo fmt # 格式化代码
cargo clippy --all-targets --all-features # 代码检查
```
## 工作区架构
三成员 Cargo workspace + 根二进制包:
```
sdkmate (root) → 产出 sdkm 二进制,入口在 main.rs;tests/cli_golden.rs(CLI 集成金样)
crates/cli → CLI 前端:clap 命令定义 + handler 实现 + terminal_sink(事件适配器)
+ terminal.rs/macros.rs(终端渲染原语与输出宏)
crates/sdkcore → 核心业务(纯数据 API):config、init、install、list、switch、version、
env 操作、符号链接;report.rs(事件契约)
crates/util → 共享工具:SDK 类型、配置辅助、路径、shell backend、诊断数据(diagnostics)
```
**依赖关系**:`cli → sdkcore, util`;`sdkcore → util`;`util` 无内部依赖。所有 crate 继承 workspace 元数据,均为 `publish = false`。
**分层铁律(GUI 铺路,2026-11-06 落地)**:
- **sdkcore 零打印、零 stdin、零终端渲染依赖**——过程消息经 `sdkcore::report`(`CoreEvent` / `EventSink` / `ProgressKind` 7 场景 / `ProgressHandle` Drop 兜底 / `NullSink`)通知前端;命令结果走结构化返回值;最终失败走 `Result::Err`(core 不对同一失败再发 Error 事件)。文案归 core(事件说什么),样式归前端(TerminalSink 怎么渲染)
- **`SdkManager { config, env_operation, sink: Arc<dyn EventSink> }`**:每操作独立构造 Manager+Sink(cli 经 `terminal_sink::manager()`),串行执行,无全局 EventBus;同步 API 内部 block_on——GUI 必须在专用后台线程调用(约定见 `docs/gui-integration.md`)
- **确认交互归调用端**:core 零 stdin;`resolve_install_version`/`resolve_installed_version`/`resolve_uninstall_target`/`check_init_env` 产出决策数据,cli prompt / GUI 弹窗确认后调执行 API;执行段仍自查关键状态(不信任预检查结果)
- **EnvOperation 不感知 UI**:写方法返回 `Vec<EnvAction>` 结构化动作,业务层经 `report_env_actions` 转事件
- **util 不含终端渲染**:颜色/光标/表格/prompt/输出宏归 cli(`cli::terminal` + `cli::macros`);util 只留通用原语(`util::diagnostics` 收 os_version/platform_info/build_bug_report_url)。`cargo tree -p sdkcore -p util` 验证 GUI 依赖链零 crossterm/unicode-width/indicatif
**sdkcore 内部**:`version/` 是版本解析公共模块(install/switch/list 共用),下载 URL 构建留在 `install/download_url`(install 专属)。各模块职责见源码文件,不在此赘述。
## 核心架构模式
### 版本切换机制
- 创建符号链接 `<symlink_dir>/<sdk_name>` → `<store>/<sdk>/<version>` 目录
- 将符号链接的 bin 目录加入 PATH
- 通过平台特定的环境变量操作设置额外变量(如 JAVA_HOME)
- 切换后更新 config.toml 中的 `current_version`
### 配置项 (`config.toml`)
```toml
[network]
proxy = "" # HTTP proxy URL, e.g. "http://127.0.0.1:7890"
ssl_verify = true # SSL certificate verification
connect_timeout = 30 # Connection timeout in seconds
cache_ttl_secs = 3600 # Version API cache TTL (seconds), 0 = always fetch
github_token = "" # GitHub PAT for higher API rate limit
[[sdk]]
name = "java"
download_url = "..." # 自定义 SDK 可省略(= 本地 switch-only,不远程安装);内置 SDK 必填
bin_dir = "bin"
```
`symlink_dir` 为 `Option<String>`:`None` = 跟随 home(运行时 resolve 成 `<home>/links`),`Some` = 用户自定义。exe 移到哪 links 就在哪,绿色便携。
### 平台抽象
- `EnvOperation` trait:`WindowsEnvOperation`(注册表 + WM_SETTINGCHANGE 广播)和 `UnixEnvOperation`(shell profile 修改)
- `cfg(windows)` / `cfg(unix)` 条件编译用于环境操作、符号链接、默认路径
- 类型别名 `OsEnvOperation` 在编译时选择平台实现
### Home 目录发现
- sdkm 的 "home" = 运行中可执行文件的父目录(`current_exe()`),使工具可移植;可用 `SDKM_HOME` 环境变量覆盖(参考 rustup `RUSTUP_HOME`),未设则回退 `current_exe().parent()`
- Store 目录:`<home>/store/`;配置文件:`<home>/config.toml`(TOML + serde + 模板渲染)
### 模板渲染系统
- `TemplateRenderer` 解析 URL 和环境变量配置中的占位符:`{sdk_dir}`、`{sdkm_home}`、`{sdks_install_dir}`、`{os}`、`{arch}`、`{ext}`
- OS/arch 检测使用 `OnceLock` 静态变量;映射 macOS→darwin、x86_64→x64、aarch64→arm64
### 错误处理与输出
- 全项目使用 `anyhow::Result`(启用 backtrace 特性);`anyhow::bail!` 和 `.context()` 处理错误
- 无自定义错误类型,不使用 thiserror(`BugReport` 标记类型除外——用于 CLI 层检测不可由用户解决的错误)
- **输出分层**:sdkcore 零打印,过程消息经 `SdkManager.sink`(`sdkcore::report` 事件契约)发前端;cli 直接输出用 `crate::{info!, success!, warning!, error!, detail!}` 宏(定义在 `cli/src/macros.rs`,渲染在 `cli/src/terminal.rs`,crossterm 彩色,不是 `log` crate)
- CLI 错误:用 `error!` 宏打印;debug 构建额外显示 backtrace;检测 `BugReport` 标记时提示 GitHub issue URL;失败时 `process::exit(1)`
## CLI 命令结构
| 命令 | 别名 | Handler |
|------|------|---------|
| `sdkm init` | — | cli/InitHandler |
| `sdkm install <SDK> <VERSION>` | `i` | cli/InstallHandler |
| `sdkm uninstall <SDK> <VERSION>` | `rm`, `un` | cli/UninstallHandler |
| `sdkm list [SDK] [--remote] [--limit N]` | `ls`, `l` | cli/ListHandler |
| `sdkm switch <SDK> <VERSION>` | `s` | cli/SwitchHandler |
| `sdkm use <SDK> <VERSION> [--shell]` | — | cli/UseHandler |
| `sdkm env [--shell SHELL]` | — | cli/EnvHandler |
| `sdkm hook [SHELL]` | — | cli/HookHandler |
| `sdkm current [SDK]` | `c` | cli/CurrentHandler |
| `sdkm config` | — | cli/ConfigHandler |
| `sdkm self uninstall` | — | cli/self_cmd::SelfUninstallHandler |
| `sdkm self update`(`--check`/`--rollback`) | `u` | cli/self_cmd::SelfUpdateHandler |
所有命令均已实现。每个命令在 `crates/cli/src/impls/` 中有 `CommandHandler` trait 实现,委托给 `crates/sdkcore/src/manager/` 中的 `SdkManager` 方法。
`config` 子命令:`set`/`get`/`list`/`delete`/`edit`/`add-sdk`/`remove-sdk`,按类型校验(`ValueType`:Url/UrlTemplate/Bool/U32/Path/Token/String)+ 原子写入(写入-重命名)+ 快照回滚;内置 SDK(java/node/python/maven)不可 delete/remove-sdk,只能 set 修改。
## 当前开发进度(2026-11-07)
> **维护规则**:本节只保留最新一次改动,每次完成后**整体替换**(不是追加),文件体积不随历史增长。
### GH Releases 引擎 CI 测试修复(feature/core-decouple 分支,两轮)
`9109099` 落地的 GH Releases 引擎(asset_selector + github_releases,内置 SDK 扩到 14 个)的测试写死 Windows 宿主期望,PR CI 的 ubuntu/macos runner 大面积挂——Windows 开发机盲区的测试版:本地全绿、CI 三系统全红。**运行时代码零改动**,仅修测试,分两层:
**单测层(`f73b370`)**:asset_selector 测试模块 15→1(仅留平台无关拒绝路径;命中类断言与编译期宿主耦合,删掉后由集成测试兜底);github_releases 端到端断言改为与 `pick_asset` 当前平台结果对齐。
**集成测试层(本提交)**:WSL 复现出两处 mock 数据的 Windows 盲区——
- `core_install_flow.rs`:标准 B 的 `.tar.gz` 路由误回 zip 字节流(linux 宿主解压报 invalid gzip header),且资产表只覆盖 windows-x64/linux-x64(ubuntu-arm/macos 宿主不命中且无模板 → install 报错)。修复:新增 `minimal_tar_gz()` 真实 tar.gz 载荷 + `TOOL_ASSETS` 资产表覆盖 CI 四宿主(windows-x64 / linux-gnu x64+arm64 / darwin arm64);linux/darwin 路由回真实 tar.gz
- `shell_integration.rs`:`env_script_layered_priority_with_venv` 把 bin 路径 `replace('/', "\\")` 造"Windows 风格路径"塞进 PATH 做稳定态模拟(Windows 上 replace 无操作恰好原生路径全绿;linux 上成反斜杠伪路径必挂),其余 7 个测试全是它 panic 毒锁 `LOCK` 的级联。修复:统一用平台原生路径
+ - `current.rs`(macOS 首次真跑 CI 暴露):期望 origin 路径用未解析的 temp 路径,而 macOS `getcwd()` 解析符号链接(`/var` → `/private/var`),core 从 `current_dir` 向上爬必返回物理路径 → 断言失配;其余 4 个失败为毒锁级联。修复:期望路径取 `env::current_dir()` 本身对齐(**不可用 `fs::canonicalize`——Windows 上返回 `\\?\C:\` 前缀的 verbatim 路径反而失配**)
- 验证:WSL linux x64 + Windows 双平台 workspace 全量绿、fmt 过。**教训**:测试 mock 数据与断言不能假定宿主平台(假载荷、路径分隔符替换都是 Windows 盲区变体);多测试共享串行锁时,一个真失败会以毒锁级联放大,看 CI 失败清单先找非锁行号的那一个。
+ 验证:WSL linux x64 + Windows 双平台 workspace 全量绿、fmt 过。**教训**:测试 mock 数据与断言不能假定宿主平台(假载荷、路径分隔符替换、未解析 temp 路径都是 Windows 盲区变体);多测试共享串行锁时,一个真失败会以毒锁级联放大,看 CI 失败清单先找非锁行号的那一个。
- **CI 矩阵精简(同批)**:4 runner × push/PR 双触发(同 commit 跑 8 job)→ 三大 OS 各一 latest(ubuntu/macos/windows,3 job),只留 push 触发(非 master);ARM64/musl/macOS Intel 编译验证由 release.yml 发版七产物矩阵兜底。macos-14 label 在本仓库持续分配失败(`'macos-14-arm64-us-default' is not supported`,0 step 即取消,runner 池问题非代码问题),换 macos-latest 规避。
+ **CI 矩阵精简(同批)**:4 runner × push/PR 双触发(同 commit 跑 8 job)→ 三大 OS 各一(3 job),只留 push 触发(非 master);ARM64/musl/macOS Intel 编译验证由 release.yml 发版七产物矩阵兜底。**固定具体版本不用 latest**(`ubuntu-24.04`/`macos-15`/`windows-2025`):GitHub 滚动 latest 时 glibc/Xcode/MSVC 跳变会让 CI 无预警变红(MACOSX_DEPLOYMENT_TARGET 教训),镜像退役前有公告届时手动升级;macos-14 label 在本仓库持续分配失败(`'macos-14-arm64-us-default' is not supported`,0 step 即取消,runner 池问题),换 macos-15 规避。
**已知窄边界(记录在案,非阻塞)**:musl 宿主 + 无 libc 后缀默认资产不降权(Alpine musl 版 sdkm 可能选中 gnu 资产);universal 与原生 arch 平分取先出现(mac 理论上可能选 universal,能跑);资产不命中回落 download_url 模板兜底。
## 已知问题与注意事项
- **使用处禁止跨模块全路径,一律顶部 use 短名**(如 `util::builtin::find_seed(...)` 写体内 → 改 `use util::builtin::find_seed;`)。rustfmt 只管 use 语句、管不了使用处写法,无自动化工具;clippy `absolute_paths` 的 `max-segments=3`(为放过 `tokio::fs` 等第三方 3 段惯用写法,实测降 2 噪音比 4:1)恰好抓不到项目内 3 段路径——**review diff 时人工扫 `util::`/`crate::` 开头的体内全路径**(宏内 `$crate::` 除外,那是正确写法)。CLI help 的内置 SDK 名单固定写 "java, node, python, go, maven, ... (see docs)" 省略号形式,不随名单扩容联动修改
- Maven 有下载模板但无 `version_url`,仅支持精确版本安装(模糊版本不可用)
- Rust 完全缺失内置源配置条目
- **Windows 需管理员运行**:环境变量与 PATH 写入 `HKEY_LOCAL_MACHINE`,符号链接创建需 `SeCreateSymbolicLinkPrivilege`(管理员或开发者模式),`init`/`switch` 需管理员权限
- Unix 环境变量操作使用 `unsafe { env::set_var() }`,在 Rust 2024 edition 中属于 UB(功能生效,彻底修复需 shim 模式重构或用户手动 source)
- Python 版本解析 `per_page=100` 仅获取最近 100 个 release(仅备源 GitHub API 有限制,主源 uv metadata 无此问题)
- Rust 工具链通过 `rust-toolchain.toml` 固定为 1.92.0(edition 2024)
- **zip 仅启用 `deflate` 特性**(体积优化):若日后解压非 deflate 压缩或密码 zip 会失败,按需在 `Cargo.toml` 加回对应 feature(`bzip2`/`lzma`/`zstd`/`deflate64`/`aes-crypto`)
- **reqwest 0.13.4 + rustls**:`default-features = false, features = ["json","gzip","default-tls"]`。`default-tls = rustls`(aws-lc-rs + rustls-platform-verifier 走系统 CA bundle),不依赖系统 OpenSSL——Linux 编译只需 `cmake`,运行时需 `ca-certificates`。禁 `http2`/`charset`/`query`/`form`
- **BugReport 标记只用于真正不可由用户修复的错误**:`install_sdk` 入口用 `?` 传播,真正的 bug(解压/校验失败、内置配置缺失)在 `install_sdk_async` 内部用 `try_bug!`/`bail_bug!` 精确标记,CLI 层 `needs_bug_report` 靠 `downcast_ref` 检测。用户取消是普通 `bail!`。switch 的 `try_step!` 不标 BugReport——步骤失败(symlink 创建 os error 1314、env 写入 os error 5)多属权限/环境问题,用户可自行解决(管理员运行),返回普通错误。**init 第 4 步 symlink_dir 不可写属用户环境问题,用 `bail!` 不用 `try_bug!`**
- **cfg(unix) 代码在 Windows 上不编译,类型错误会漏到 Linux 才暴露**:`env/unix.rs` 整个模块 `#[cfg(unix)]`。改 `unix.rs` 后**必须**验证类型——Windows 上临时把 `env/mod.rs` 的 `#[cfg(unix)] mod unix;` 改成 `mod unix;`(注释掉对应 `pub use` 避免冲突),跑 `cargo check -p sdkcore` 强制编译暴露错误,验证完改回。`cargo check --target x86_64-unknown-linux-gnu` 不行(aws-lc-rs build.rs 找不到 `x86_64-linux-gnu-gcc`);或直接 WSL `cargo build`。**filter 闭包参数是 `&Self::Item`(item 的引用)**——`split()` 的 item 是 `&str`,闭包参数是 `&&str`,必须用 `|&p|` 解构才能跟 `&str` 比较;`&String` 用 `.as_str()` 转 `&str`。**涉及跨平台代码提交前必须保证双平台编译通过**(v0.5.1 教训:region.rs unix 分支漏 `-> bool`,tag 构建全挂,删 tag 重发补救);单文件级验证法 = 临时剥 `#[cfg(unix)]` 属性跑 `cargo check`,完事必须恢复属性并重编译确认(sed 批量剥极易漏恢复)
- **SDKM_HOME 环境变量可覆盖 home**:`util/path.rs::get_sdkm_home` 优先读 `SDKM_HOME`,未设回退 `current_exe().parent()`,行为兼容。主要解锁 in-process 集成测试——`SdkManager::new()` 等路径全经 `get_sdkm_home`(绑 `current_exe`,原本不可注入),注入后测试可全部指向临时目录。`tests/uninstall.rs` 等用:设 `SDKM_HOME=temp` + 手工构造 `SdkManager{config, env_operation: Box<MockEnv>}`(字段 pub,`MockEnv` impl `EnvOperation` 记录调用)+ 模块级 `Mutex` 串行(`set_var` 全局竞态)+ `TestEnv` Drop 恢复 env/清理目录
- **改完代码先 review 再交付**(编译通过 ≠ 代码干净):每次改完、build/test/通知用户/提交前,对本次 diff 逐文件自审——(1) 逻辑/边界 bug(空集、None、并发、`panic=abort` 下后台线程无 unwrap);(2) 因改动变孤儿的 import/变量/函数一并清;(3) 风格违规(标准库别用 `std::fs::` 全路径,优先 `use` 短名,歧义才加包名);(4) 冗余/可简化处。复核通过再 build/test/交付
- **env/unix.rs 的 RebuildLine 与 PerDirCommand 是两条独立代码路径**:改 PATH 持久化行为时(插入位置、去重、删除),bash/zsh 走 RebuildLine 分支、fish 走 PerDirCommand 分支,**修一处必须检查另一处是否同型遗漏**——bash Bug 2(PATH 行错位到 hook 后)修了 RebuildLine、漏了 PerDirCommand,fish 用户 WSL 实测才暴露(v0.4.3 补修)
- **bug 回归测试用临时文件验证后删除,不提交**:用户规矩——测试代码跑通证明修复生效即可,diff 里只留修复本身
- **WSL + Windows 双装 sdkm 的跨平台污染**(排查"项目级切换重启失效"教训):WSL 默认 `appendWindowsPath=true` 继承 Windows PATH,但 **WSL bash 不补 `.exe` 后缀**([WSL#2003](https://github.com/microsoft/WSL/issues/2003))——bare `sdkm`/`node` 只命中文件名恰好叫 `sdkm`/`node`(无后缀)的条目,Windows 目录里的 `sdkm.exe`/`node.exe` **不匹配**。所以 Windows PATH 里的 `/mnt/d/.../sdkm` 是纯干扰,不能让 bare 命令生效。用户若在 WSL 敲 `sdkm.exe`(带后缀)则跑的是 **Windows sdkm**,操作 Windows home(`D:\...\sdkm`)、写 PowerShell profile/注册表,**完全不碰 Linux `.bashrc`**。排查要点:让用户 `command -v sdkm` + `file $(command -v sdkm)` 确认命中 Linux ELF 还是 Windows PE。`init` 的 PATH 持久化靠 `add_sdk_path`→`add_path_entry` 写 profile 行,但 `source_profile` 只把新 PATH 设进 **sdkm 子进程**(`env::set_var`),**不回传交互 shell**——所以 init/switch 后必须新开 shell 或 `source ~/.bashrc` 才生效。已修三 bug:dedup 不再回退进程 `$PATH`(Bug 1)、新建 PATH 行插到 hook 行之前(Bug 2,避免 source 时 hook 找不到 sdkm)、fish PerDirCommand 分支同型错位 relocate 自愈(v0.4.3)。详见进度段本次改动。
## 发布流程
工作流 `.github/workflows/release.yml` 在每次 push 到 master 时跑 tag job,但**只有版本号 bump 才会真正发版**——版本号对应 tag 已存在则跳过 build/release。不是每次提交都发版。
### 发版三步
1. 改根 `Cargo.toml` 的 `[workspace.package] version` 一行
2. 本地 `cargo build` 刷新 `Cargo.lock`(CI 用 `--locked`,必须同步否则构建失败)
3. 单独 commit bump(`chore: release vX.Y.Z`)+ push 到 master → 工作流自动打 tag、七产物构建、创建 release
### 要点
- **changelog 自动生成**:来自「上个 tag..HEAD」的 conventional commits,按 `feat`/`fix`/`refactor`/`docs`/`ci` 等前缀分类(`.github/scripts/gen_changelog.sh`)。保持约定式 commit message
- **根 `CHANGELOG.md` 由 CI 维护**:发版后 upload-release job 把版本正文 prepend 到根 `CHANGELOG.md` 并 commit 回 master。**本地不要手改**,会被下次发版覆盖;GITHUB_TOKEN push 不触发 workflow 递归
- **版本号只能递增、不可复用**:已发版本 tag 已存在,再 push 同版本会被跳过。重发同版本需先删 tag+release 再 push;或直接 bump 到下一版本(推荐)
- **不发 crates.io**:所有 crate `publish = false`,发布物为 GitHub Release 上七产物二进制(Linux x86 gnu/musl + ARM64 gnu/musl、macOS ARM/Intel、Windows)
- **七产物矩阵**:`ubuntu-22.04`×{gnu,musl} + `ubuntu-22.04-arm`×{gnu,musl} + `macos-14`/aarch64 + `macos-14` 交叉编译 x86_64-apple-darwin + `windows-latest`。Linux gnu 用 22.04(glibc 2.35)避开 24.04 的 `GLIBC_2.39` 墙;ARM64 走原生 arm runner(`ubuntu-22.04-arm`,避开 QEMU 交叉与 aws-lc-rs 找交叉 gcc 的坑);musl 全静态通吃老系统/Alpine/树莓派;macOS 必须设 `MACOSX_DEPLOYMENT_TARGET=11.0`(否则 runner SDK 升高会编出老 macOS 跑不了的二进制);Windows 保持 latest
- **纯 CI/文档修复复用原版本号删 tag 重发,patch/minor bump 只留给代码变化**
- **本地 origin 指向 gitee,GitHub remote 叫 `github`**:查 GitHub 状态用 API 或 `git fetch github --tags`
## 提交规范
- 格式:`type: description`(如 `feat: add switch command`、`fix: resolve xxx issue`)
- 类型:feat、fix、docs、refactor、test、chore
- 分支命名:`feature/xxx`、`fix/xxx`、`docs/xxx`