mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-10-30 06:03:48 +00:00
Qiu Yuzhou
fb428f12bc
App/ 根目录原有 73 个散落源文件，已无法从目录读出任何分组信息。 按「目录即分层」重组为 Composition / Application / Presentation / UI / PlatformEffects / Resources 六个目录，UI 层再按子视图分目录（Workspace、 Home、Servers（含 Plugin）、Subscriptions、Rules、Settings、Diagnostics、 StatusMenu）。纯移动：类型名、模块名与 import 均未改动，App/ 根层不再有 散落文件。 配套改动： - project.yml：Core 测试镜像的 excludes 由裸文件名改为 `**/` 递归形式。 XcodeGen 的 exclude 不跨 `/`，裸名只匹配 App 根层；MainApp.swift 下移后 旧写法会静默失效，把 @main 组合根编进测试镜像。info.path 与 entitlements.path 指向 App/Resources/；并排除 `**/*.md`——App/ 下任何 非源码文件都会被 XcodeGen 收进 Resources 阶段并封进签名后的 bundle。 - SkeletonTests 的架构守卫由「默认扫描全部 App/ + 7 个豁免文件 + 1 个豁免 前缀 + 4 个豁免目录」改为正面圈定 App/UI/，豁免登记全部删除；新增运行时 适配器放进 Application/ 即自动落在扫描范围外，无需再登记。 - README 工程结构说明同步；根 .gitignore 的生成物路径随 Resources/ 归位。 验证：clean build 0 error；task test 1022 用例全通过（含两个架构守卫）； task format 无改动（证明纯移动）；task lint 与移动前同为 21 条内容型 warning；packaging-gate.sh ALL CHECKS PASSED，确认 plist/entitlements 归位 后签名与 entitlements 语义不变。 注意：迁移时须先删旧的生成物再 xcodegen generate，否则遗留的 App/Info.plist 会被当作普通资源扫进 Resources 阶段。
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 生成大量文档后，人与机器之间的沟通成为协作瓶颈：人的阅读、理解和审阅速度决定了文档能否有效推动开发。使用简体中文可以降低维护者的认知负荷，提高沟通与审阅效率。