STM32F4-Base/scripts/README.md

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。只登记无歧义昵称；登记一次即把该昵称的引用纳入硬门禁
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_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-reorg skill）
• 生成器与校验器共用同一套正则/口径，避免两处数字打架

相关文档

• docs/代码规范/pre-commit使用说明.md — 门禁完整说明与排除项
• docs/代码规范/cppcheck使用说明.md
• docs/文档规范.md — 文档门禁三档
• docs/内存管理/RAM使用分析与优化方案.md — RAM/栈报告口径