im0o
f7db96fb0e
核心是确认「改配置而不弄乱文件」这件事成立：新增一路入站之后，其余 52 行逐字节不变。 搬进来的改写引擎用默认输出参数时会重排整个文件——行尾注释的对齐空格消失、流式数组被加上内边距—— 连根本没改动的段落也一起波及。不修的话「改一处只动一处」这个承诺直接落空，所以关掉了它的自动排版， 并在写回之后补了一步逐行还原。
25 lines
1.9 KiB
Markdown
25 lines
1.9 KiB
Markdown
# config-editor 的来源
|
||
|
||
复制自 **metacubexd**（GitHub `MetaCubeX/metacubexd`，MIT 许可），路径 `packages/config-editor/src/`，取自版本 **1.271.0**。
|
||
|
||
采用它的理由和已知缺陷记在决策记录 0002。决策记录**不在本仓库里**，它们放在仓库外面的工作区目录 `docs/adr/`（与 `patchbay/` 平级）。
|
||
|
||
## 本地改动
|
||
|
||
对照上游逐条记录，方便将来同步上游修复时区分「我们改的」和「上游变的」。
|
||
|
||
| 文件 | 改动 | 原因 |
|
||
|---|---|---|
|
||
| `index.test.ts` | 测试框架的导入从 `vitest` 换成 `bun:test` | 本项目用 Bun 自带的测试运行器，不引入 vitest。两者的 `describe` / `it` / `expect` 接口一致，用例本身一行没动 |
|
||
| `index.ts` | `stringifyTouched` 结尾的 `String(doc)` 换成 `doc.toString({ flowCollectionPadding: false, lineWidth: 0 })` | 上游用默认输出参数，会把 `[a, b]` 改写成 `[ a, b ]`，并且在超过 80 列时折行——目标机器的订阅地址就够长。这两样都会让没被改动的段落出现在 diff 里 |
|
||
|
||
## 配套的本项目代码
|
||
|
||
`shared/yaml-cosmetics.ts` 里的 `restoreInlineCommentAlignment` 不属于上游，是本项目补的一步。`yaml` 库把行尾注释的文字存在节点上，但不存注释前的对齐空格，所以重新输出时 `interval: 86400 # 说明` 会变成 `interval: 86400 # 说明`。那个函数在写回之后逐行比对，把只差对齐空格的行还原成原文。
|
||
|
||
加上这两处之后的实测结果记在决策记录 0002 的「实测」一节。要自己重跑一遍：`bun run scripts/roundtrip.ts <配置文件> <输出目录>`，再拿输出跟源文件比对。
|
||
|
||
## 同步上游
|
||
|
||
上游修了 bug 想同步时：拉取 metacubexd 对应版本的 `packages/config-editor/src/index.ts`，与本目录的同名文件比对，把上表里的本地改动重新应用一遍。
|