mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-11-01 07:33:46 +00:00
Qiu Yuzhou
20a62117f2
Tests/ 根层原有 138 个平铺测试文件，无法从目录读出测试覆盖的功能领域。 按功能领域重组为 17 个目录（Catalog/Workflow 与 Rules/Custom 两处嵌套，分别 对应 App/Application/CatalogWorkflow 与 Domain/Rules/Custom）：Architecture / Support / Agent / Activation / Catalog / Subscription / Rules / ProxyRuntime / ProxyControl / Runtime / Settings / SystemProxy / Plugin / Diagnostics / Credentials / Workspace / Servers；Smoke/ 保持独立 target 不动。138 个移动中 132 个是 100% 相似度的纯重命名，其余 6 个在重命名之上带路径反推改写（见下）。 本次不是纯搬移：测试代码比生产代码多一层位置耦合，有 7 处用固定层数的 deletingLastPathComponent() 从 #filePath 反推仓库路径（都假定文件就在 Tests/ 根层）。这 7 处改走新增的 Tests/Support/TestSourceTree.swift——从调用点沿父 目录上溯找到含 project.yml 的目录，因此不再依赖父目录层数，以后移动测试文件 也不会静默指错。 配套改动： - 新增 Tests 布局守卫 TestsLayoutTests，断言 Tests/ 根层无平铺 .swift。比 Domain 那条弱一档——根层的 Info.plist（info.path 生成物）与 Fixtures/RuleSnapshots 下的 JSON（folder resource）都必须保留，不能用 「树下只有 .swift」覆盖。 - project.yml：Smoke target 按文件引用的 Tests/AppArtifact.swift 改指 Tests/Support/；两处注释里写死的 Tests/SkeletonTests.swift 随移动更新。 excludes 的裸名 "Smoke" / "Fixtures" 仍匹配 Tests/ 直属子目录，无需改动。 - README 的 Tests 条目展开为目录说明，并修掉 Domain 条目里写死的 Tests/SkeletonTests.swift。 - 顺带删去 DomainLayoutTests 文档注释里「整理前 62 个文件」这类易漂移的数字。 验证：xcodegen generate 后单测 target 为 139 个源文件（全部非 Smoke 文件，0 个 Smoke 文件混入）且仍以 Fixtures/RuleSnapshots 为资源，Smoke target 为 8 个 Smoke 文件加 AppArtifact；依赖路径反推的 6 个测试类全绿（路径指错即失败）； task format 未改写任何被移动文件；task lint 与整理前同为 21 条内容型 warning； build 0 error；task test 1025 用例全通过（整理前 1024，+1 为新守卫）； TestsLayoutTests 经变异验证（根层投放探针即失败）；packaging-gate ALL CHECKS PASSED。
ShadowsocksX-NG
🚧 重新实现进行中 —— 本仓库正在使用现代技术栈重写 ShadowsocksX-NG macOS 客户端。
新工程不再通过 git 子模块在仓库内构建依赖，而是直接复制上游项目发布好的可执行文件，以简化构建流程。
目录结构
.
├── ShadowsocksX-NG2/ # 新工程：现代化重写版本（开发中）
└── Legacy/ # 旧版工程完整源码，仅供参考，不保证可构建
旧版工程的功能说明与使用文档见 Legacy/README.md。
开发钩子
新 clone 后，在仓库根目录启用 Git hooks：
git config core.hooksPath .githooks
启用后，pre-commit 只检查暂存区中 ShadowsocksX-NG2/ 下的 .swift 文件：swift format 的结果写回暂存区、不修改工作区；SwiftLint 的 error 级违规拒绝提交，warning 仅提示。Legacy/ 和其他文件跳过；没有 NG2 Swift 文件时直接放行。含有 NG2 Swift 文件但缺少工具时，提交检查失败。两关都把「工具没能执行」与「查出问题」分开报告：看到「执行失败」应查工具与配置环境，而不是去改代码。工具安装与版本见 ShadowsocksX-NG2/README.md。
领域文档语言
本项目的 术语表 和新建 架构决策记录（ADR） 使用简体中文，代码标识符与必要的英文术语保留原文；已有 ADR 保留原文，不作语言迁移。
AI 生成大量文档后，人与机器之间的沟通成为协作瓶颈：人的阅读、理解和审阅速度决定了文档能否有效推动开发。使用简体中文可以降低维护者的认知负荷，提高沟通与审阅效率。