mirror of
https://github.com/shadowsocks/ShadowsocksX-NG.git
synced 2026-10-29 21:53:43 +00:00
Qiu Yuzhou
7ab774fcfd
旧版实现已由 shadowsocks/ShadowsocksX-NG 的 legacy-v1 分支跟踪，本仓库不再 保留同一份代码副本。删除 Legacy/ 下 603 个跟踪文件，被 gitignore 的 .DS_Store 一并清理。 删除前核对：Legacy/ShadowsocksX-NG/PACUtils.swift 的 blob hash 与 upstream/legacy-v1 的同名文件完全相同，且工作区在 Legacy/ 下无未提交改动。 配套改动： - 根 README、AGENTS.md、ShadowsocksX-NG2/README.md：目录结构只留 ShadowsocksX-NG2/；旧版说明改为指向 shadowsocks/ShadowsocksX-NG 的 legacy-v1 分支（含其 README）；pre-commit 说明去掉 Legacy/。 - codegraph.json 删除 "exclude": ["Legacy/"]；.gitignore 与 .zcodeignore 删除 Legacy 构建产物与依赖条目；.swiftlint.yml 删除 ../Legacy 排除项； .githooks/pre-commit 头部注释去掉冻结目录表述。 - docs/research 的 4 份历史研究报告（issue 7/11/12/17）中 129 处 ../../Legacy/... 相对链接改写为 legacy-v1 的 GitHub blob 链接，正文未改； 把新 URL 反替换回原相对路径后与 HEAD 版本逐字节相同，证明只动了链接。 验证：全仓库不再有指向 Legacy/ 的路径引用；剩余 Legacy 字样均为概念性用法 （Legacy 导入功能、ADR 与术语表、历史报告正文中的冻结陈述）。本次未改任何 NG2 源码或构建配置，暂存区无 NG2 .swift 文件，pre-commit 直接放行。
31 lines
1.9 KiB
Markdown
31 lines
1.9 KiB
Markdown
# ShadowsocksX-NG
|
||
|
||
> 🚧 重新实现进行中 —— 本仓库正在使用现代技术栈重写 ShadowsocksX-NG macOS 客户端。
|
||
|
||
新工程不再通过 git 子模块在仓库内构建依赖，而是直接复制上游项目发布好的可执行文件，以简化构建流程。
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
.
|
||
└── ShadowsocksX-NG2/ # 新工程：现代化重写版本（开发中）
|
||
```
|
||
|
||
旧版工程源码已从本仓库移除，归档在 [shadowsocks/ShadowsocksX-NG](https://github.com/shadowsocks/ShadowsocksX-NG) 的 [`legacy-v1`](https://github.com/shadowsocks/ShadowsocksX-NG/tree/legacy-v1) 分支，仅供参考，不保证可构建；其功能说明与使用文档见 [legacy-v1 的 README](https://github.com/shadowsocks/ShadowsocksX-NG/blob/legacy-v1/README.md)。
|
||
|
||
## 开发钩子
|
||
|
||
新 clone 后，在仓库根目录启用 Git hooks：
|
||
|
||
```bash
|
||
git config core.hooksPath .githooks
|
||
```
|
||
|
||
启用后，`pre-commit` 只检查暂存区中 `ShadowsocksX-NG2/` 下的 `.swift` 文件：`swift format` 的结果写回暂存区、不修改工作区；SwiftLint 的 error 级违规拒绝提交，warning 仅提示。其他文件跳过；没有 NG2 Swift 文件时直接放行。含有 NG2 Swift 文件但缺少工具时，提交检查失败。两关都把「工具没能执行」与「查出问题」分开报告：看到「执行失败」应查工具与配置环境，而不是去改代码。工具安装与版本见 [`ShadowsocksX-NG2/README.md`](ShadowsocksX-NG2/README.md)。
|
||
|
||
## 领域文档语言
|
||
|
||
本项目的 [术语表](GLOSSARY.md) 和新建 [架构决策记录（ADR）](docs/adr/) 使用简体中文，代码标识符与必要的英文术语保留原文；已有 ADR 保留原文，不作语言迁移。
|
||
|
||
AI 生成大量文档后，人与机器之间的沟通成为协作瓶颈：人的阅读、理解和审阅速度决定了文档能否有效推动开发。使用简体中文可以降低维护者的认知负荷，提高沟通与审阅效率。
|