/** * 判据目录里**唯一**允许读文本文件的两个入口 —— 名字自己解释该选哪个。 * * # 为什么要有这个模块(pi 2026-09-14 §4:同一处坑我踩了两次) * * 规范里写着"判代码读剥离版、判理由读原文",我 P5 写过一次、当天又踩了一次 * (`'rejected'` 那段**注释**里正好写着 `allowed-once`,被当成"这里会放行"误报)。 * **第二次犯规说明问题不在记性,在形态**:靠人记得执行的规范一定会有下一次。 * 所以把"用哪个读取器"从**记忆**变成**代码里的一个词**,并且可以被判据检查。 * * - `code(path)`:**剥掉注释**。判"代码里有没有这个调用/这个值"时必须用它 —— * 否则解释性注释("这里写 'rejected' 而不是 'denied',因为只认 allowed-once") * 会被当代码读,产生假红/假绿。 * - `prose(path)`:**原文**。判"理由写清了没/文档里有没有这句话"时用它。 * * 选错的典型症状:断言里的标识符恰好在同文件的注释里出现过(这类误报几乎都集中在 * "解释性注释与它解释的标识符同名"的地方)。 */ import { readFileSync } from 'node:fs'; /** * 剥掉注释:只用于"代码里有什么"。 * * ★ **行号必须保持不变** —— 这一条是硬要求,不是风格问题。 * 原来块注释是用 `''` 直接抹掉的,而块注释**自带换行**,抹掉它就把后面所有行的行号 * 整体前移。后果实测(我自己的 `harmony-arkts` 判据报违规时): * 报出"最后一个 import 在第 64 行、第 47 行已是语句",而**真实文件里是第 80 / 63 行** —— * 全仓的判据都在用 `文件:行号` 定位(`grep -n`、编辑器跳转),**报出来的行号必须能直接用**, * 否则读者第一步就得先猜"这是剥过的还是没剥的"。 * 修法:块注释里的每个换行都**换成等价数量的空行**(而不是整块删掉)。 */ export function stripComments(src) { return src .replace(/\/\*[\s\S]*?\*\//g, (m) => '\n'.repeat((m.match(/\n/g) || []).length)) .replace(/(^|[^:])\/\/[^\n]*/g, '$1'); // 行注释(避开 https:// 这类;它不含换行,行号天然不变) } /** 读文件并**剥掉注释** —— 判"代码里有什么"用这个 */ export function code(path) { return stripComments(readFileSync(path, 'utf8')); } /** 读文件**原文** —— 判"注释/文档里写了什么"用这个 */ export function prose(path) { return readFileSync(path, 'utf8'); } /** 读**二进制**(安装包、图片等)—— 需要 Buffer 时用它,别在判据里裸用 readFileSync */ export function bytes(path) { return readFileSync(path); }