mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-10-29 05:33:45 +00:00
Qiu Yuzhou
856d6b4272
Domain/ 根目录原有 62 个平铺源文件，无法从目录读出主题划分。 按「目录即主题」重组为 11 个目录（Rules/Custom 为嵌套子目录）：Catalog / Subscription / Rules / Runtime / Activation / Settings / SystemProxy / Plugin / Credentials / LegacyImport / Diagnostics。纯移动：类型名、模块名 与 import 均未改动，Domain/ 根下不再有散落文件。目录口径取自 GLOSSARY.md 的章节划分（配置与订阅、代理规则、代理控制与网络、设置、 凭据与诊断），而非新造分类。 配套改动： - project.yml：wrapper 与 helper 两个 target 按文件引用的 15 条显式路径 随目录改名，并补注释固定这一约定——这 15 条指向不存在的文件时， xcodegen generate 以 "missing source directory" 直接失败（实测，不静默）。 - SkeletonTests 新增 DomainLayoutTests：断言 Domain/ 根下无平铺 .swift、 树下只有 .swift。后者防的是与 App/ 同源的坑——Domain/ 整目录是 app 与 Core 的 source path，任何非源码文件都会被 XcodeGen 收进 Resources 阶段 并封进签名后的 bundle。 - README 工程结构说明同步；docs/design 与 docs/research 属历史文档不改。 验证：xcodegen generate 后 app 164 / Core 163 源文件数与整理前一致；Agent 恰好 9 个、Helper 恰好 6 个 Domain 文件（无缺失无多出）；app 与 Core 各覆盖 全部 62 个。clean build 0 error；task test 1024 用例全通过（整理前 1022， +2 为新增守卫）；task format 未改写任何被移动文件（证明纯移动）；task lint 与整理前同为 21 条内容型 warning；packaging-gate.sh ALL CHECKS PASSED。 布局守卫已做变异验证：临时投放松散 .swift 与非 .swift 文件时两个用例均 失败并点名违规文件，清理后复验为绿。
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 生成大量文档后，人与机器之间的沟通成为协作瓶颈：人的阅读、理解和审阅速度决定了文档能否有效推动开发。使用简体中文可以降低维护者的认知负荷，提高沟通与审阅效率。