wandering1
301c3e5183
新增门禁本体 - scripts/check_ids.py：实现 docs/编号规范.md §8 八项校验；默认 warn-only， 唯一硬拦项是「可判定比例跌破基线」（防回退的本体） - scripts/id_registry.json：66 个前缀族，逐项来自 §4 总表 + 全库实测游标， 偏差一律写进 cursor_note，不凭记忆编造 - scripts/id_aliases.json：旧号 → 新号 / 作废标记（照搬 section_aliases.json 范式） - 顺带收编 check_test_traceability.py：正则补齐大写后缀与无模块码形态， 比对范围扩到 test/host 与 7 篇「单元测试说明.md」，另加 --board-only 回退旧口径 批 1 改名（用户授权解禁「不改写存量号」） - 代码规范条款 S1~S19 → CODE-RULE-nn：78 处 / 2 文件 - UI 像素回归状态 S0~S7 → MENU-STATE-nn：61 处 / 3 文件（冻结在 07） - 两族属主登记处 = 脚本自身的规则表 / STATES 表，文档只作引用方 - 新增 scripts/rename_ids.py（§7.3 规划脚本）：映射表驱动、显式 scope、默认干跑、 自动写 scoped 别名，跳过 [示例]/[计划] 行与变更记录表，按原字节读写保 BOM 行尾 - 已应用映射表存档 scripts/rename_maps/batch1.json 作审计轨迹 有牙实测（证明门禁不是空转） - 注入 Z-99 / 裸形 / 悬空 / 越游标 / 未紧邻 / 跨文档重复定义 六例， 分别被校验 1/2/3/5/6/4 点名，--strict 退出码 1；临时档删除后工作树干净 验证与同步 - 可判定比例基线 82.3% → 82.7%（已 --update-baseline 入档）；错误级 1312 → 1291 - ci_local.py 全绿（L0 + L0.5 共 1104 断言）；ui-golden Passed； check_doc_links.py --all 无法判定 0 - 未改任何 C/H 源文件，故本次不需 @build - 文档：AGENTS.md 与 pre-commit使用说明.md 计数 36→37 并新增 §2.25 详解； 编号规范 §4.1 补两行、§8.1 落地记录、§8.2 规范与仓库偏差、§8.3 迁移批次记录
7.2 KiB
7.2 KiB
scripts/ — 开发脚本（提交门禁 + 报告生成）
本目录是 pre-commit 门禁脚本与报告生成脚本的存放处。 与
tools/（面向开发者的功能工具）区别：本目录服务于质量门禁与工程度量。
文件一览
提交门禁（接入 .pre-commit-config.yaml）
| 脚本 | 钩子名 | 作用 |
|---|---|---|
check_coding_standard.py |
C coding standard |
C 代码规范机械检查（命名前缀/常量右置/头文件保护宏等） |
check_mojibake.py |
Forbid U+FFFD mojibake |
扫描 U+FFFD 乱码（EF BF BD 字节） |
check_doc_links.py |
doc-links |
文档链接存在性 + 命名规范（D-3/D-7）+ §N.M 章节引用（口径见 docs/文档规范.md §3.5）。钩子已带 --sections-strict（自引用失效也拦）；--section-todo 列出机器判不了目标的 §（带改写建议）。每次跑打印「可判定比例」行，防覆盖率回落 |
section_aliases.json |
（被 check_doc_links.py 读） |
文档昵称别名表：「内存方案」→ docs/内存管理/RAM使用分析与优化方案.md。只登记无歧义昵称；登记一次即把该昵称的引用纳入硬门禁 |
check_ids.py |
id-check |
编号门禁：docs/编号规范.md §8 的八项校验（未登记前缀 / 形态 / 悬空 / 重复定义 / 越游标 / 未紧邻文档名 / 孤儿 / 可判定比例）。warn-only，--strict 才拦提交；比例跌破基线任何模式都失败。详表 → docs/代码规范/pre-commit使用说明.md §2.25 |
id_registry.json |
（被 check_ids.py 读） |
前缀族注册表：属主登记处 / 形态正则 / 冻结 / 游标，逐项来自 docs/编号规范.md §4；decidable_ratio_baseline = 校验 8 的基线（只许涨）。与 section_aliases.json 同一套"别名表 + 可判定比例"范式 |
id_aliases.json |
（被 check_ids.py 读） |
编号别名/作废表：旧字面量 → 现行字面量或 status: void（如 N-32 销项后仍被引用、Trap 19 从未存在、模块码 PHY→NET） |
check_test_traceability.py |
（被 id-check 顺带调用） |
TC 用例双向追溯：文档 ↔ 代码两侧的 TC 编号集合比对；2026-10-20 起范围扩到 test/host/ 与 7 篇「单元测试说明.md」（--board-only 回退旧板级口径）。此前该脚本未挂任何钩子 |
gen_task_table.py |
task-table |
FreeRTOS 任务表以 Src/freertos.c 为唯一事实源生成/校验（D-2/D-7） |
check_mem_numbers.py |
mem-numbers |
内存/Flash 数字以 .map 为唯一事实源校验（D-7 体积档） |
check_test_suite.py |
test-suite-switch |
测试套件开关=产品构建（防测试固件静默提交） |
报告生成（非门禁）
| 脚本 | 作用 |
|---|---|
ram_report.py |
从 .map 生成静态 RAM/Flash 占用报告（→ docs/内存管理/data/） |
stack_report.py |
从 Keil 静态调用图 + 串口 [STACK] 水位生成每任务最坏链报告 |
引用同步（改名 / 挪目录）
| 脚本 | 作用 |
|---|---|
rename_ids.py |
编号（字面量）批量改名：映射表 JSON 驱动，files 显式 scope（同一裸形字面量可能属多族，实测 S3 三义 → 全局替换必造新撞号）；默认干跑，--apply 落盘并自动写 id_aliases.json 的 scoped 旧号→新号条目；[示例]/[计划] 行与变更记录表不改写；按原字节读写（保 BOM 与行尾）。用法与批次记录 → docs/编号规范.md §8.3 |
rename_ref.py |
改名/挪目录 + 全库引用自动改写：默认 dry-run 预览，--apply 才落盘（git mv → 改写引用 → 自动跑 check_doc_links --all 复核）。覆盖反引号引用、Markdown 链接、图片 ../ 层级换算、#include、uvprojx/CMakeLists.txt 源列表。固定动作与边界 → docs/文档规范.md §3.6 |
check_doc_links.py除链接存在性外，还校验§N.M章节引用是否指向目标文档真实存在的编号标题（口径见docs/文档规范.md§3.5）。
CI 与本地等价（2026-10-01 T-6）
| 脚本 / 文件 | 作用 |
|---|---|
ci_local.py |
本地跑与 CI 等价的门禁（L0 pre-commit + L0b 提交信息 + L0.5 主机侧单测）：自动选用装了 pre-commit 的解释器；无 .map 时自适应跳过 mem-numbers；退出码 0/1/2 与 CI 对齐。CI 定义见 ../.gitea/workflows/ci.yml，覆盖边界见 docs/测试说明/测试开发标准流程.md §9 |
ci_gitlint_range.ps1 |
CI 侧提交信息门禁：逐条校验本次 push/PR 引入的提交（--all-files 跑不到 commit-msg stage，故必须单独守） |
ci_find_python.ps1 |
CI 侧 Python 探测（候选顺序须与 ci_local.py 同序同步，否则 CI 与本地判定会分叉） |
ci_runner_bootstrap.ps1 |
本机 runner 运维脚本（体检 -Status / 干跑 -DryRun / 部署 -SetEnv -StartNow）：装"等 Gitea 就绪 + 崩溃自拉起"的看门狗 + 开机计划任务 + 机器级 DTU_* |
⚠️ 后三个脚本是本机 runner 专属运维（远程 CI 只跑在本机一台机器上），用法、原理与 踩坑全部集中在
docs/CI/README.md，本表只登记不展开。
使用方式
# 全库跑门禁（用仓库 .venv 的 python，其 pre-commit 随 requirements.txt 安装；
# 其他装有 pre-commit 的解释器可用 DTU_PRECOMMIT_PYTHON 指定）
& '.venv\Scripts\python.exe' -m pre_commit run --all-files
# 本地跑与 CI 等价的门禁（L0 + L0.5）
& '.venv\Scripts\python.exe' scripts/ci_local.py
& '.venv\Scripts\python.exe' scripts/ci_local.py --l0-only # 只跑 L0
& '.venv\Scripts\python.exe' scripts/ci_local.py --l05-only # 只跑 L0.5
# 单个脚本
& '.venv\Scripts\python.exe' scripts/check_doc_links.py --all
& '.venv\Scripts\python.exe' scripts/rename_ref.py docs/旧/名.md docs/新/名.md # 预览
& '.venv\Scripts\python.exe' scripts/rename_ref.py docs/旧/名.md docs/新/名.md --apply # 落盘
& '.venv\Scripts\python.exe' scripts/gen_task_table.py --check # 或 --write / --diff
& '.venv\Scripts\python.exe' scripts/check_mem_numbers.py --check
& '.venv\Scripts\python.exe' scripts/check_test_suite.py # 门禁判定
& '.venv\Scripts\python.exe' scripts/check_test_suite.py --allow-test-build # 放行测试构建
& '.venv\Scripts\python.exe' scripts/ram_report.py
& '.venv\Scripts\python.exe' scripts/stack_report.py -s .dsh\skills\serial-assistant\scripts\state\serial.log
⚠️ 脚本编写约定
- 保真回写：改文件前先探测原换行符（LF/CRLF）与 BOM，按原样回写（本仓库各文件换行混杂）
- 受管区锚点：改文档中的数值/表格时用
<!-- XXX:BEGIN/END -->锚点，只替换锚点内内容 - 脚本输出文件绝不能落在自身扫描范围内（否则会"自我污染"，见
docs-tree-reorgskill） - 生成器与校验器共用同一套正则/口径，避免两处数字打架
相关文档
docs/代码规范/pre-commit使用说明.md— 门禁完整说明与排除项docs/代码规范/cppcheck使用说明.mddocs/文档规范.md— 文档门禁三档docs/内存管理/RAM使用分析与优化方案.md— RAM/栈报告口径