# pre-commit 自动化代码审查配置 # 详见 docs/代码规范/pre-commit使用说明.md default_install_hook_types: [pre-commit, commit-msg] exclude: | (?x)^( \.opencode/node_modules/| Lib/lvgl/| simulator/| MDK-ARM/RTE/ ) repos: # 1) 通用钩子(官方) - repo: https://github.com/pre-commit/pre-commit-hooks rev: v5.0.0 hooks: - id: trailing-whitespace # 排除第三方库(CubeMX 重生成会带回行尾空白,避免每次重生成产生提交抖动); # 自研代码(Drivers/BSP、Src、Inc、App 等)不受影响 exclude: | (?x)^( Drivers/CMSIS/| Drivers/STM32F4xx_HAL_Driver/| Middlewares/ ) - id: end-of-file-fixer - id: check-added-large-files - id: check-merge-conflict - id: check-yaml # 2) C 代码格式:只检查,绝不改写(编码铁律) # Route A:暂不启用,待全库格式化基线后再放开 # - repo: https://github.com/pre-commit/mirrors-clang-format # rev: v19.1.4 # hooks: # - id: clang-format # args: [--dry-run, --Werror] # 3) commit message 格式(宽松规则,兼容中文标题) - repo: https://github.com/jorisroovers/gitlint rev: v0.19.1 hooks: - id: gitlint # 4) 本地自定义钩子(仓库级) - repo: local hooks: - id: cppcheck name: cppcheck entry: cppcheck # 注意:YAML 流序列中逗号是元素分隔符,含逗号/空格的参数必须加引号 args: ['--enable=warning,performance,portability,style', '--error-exitcode=1', '--inline-suppr', '--std=c99', '--quiet', '--suppress=missingIncludeSystem', '--suppress=missingInclude', '--suppress=invalidPrintfArgType_sint', '--suppress=invalidPrintfArgType_uint', '--suppress=unusedFunction', '--suppress=unusedStructMember', '--suppress=noExplicitConstructor', '--suppress=useStlAlgorithm', '--suppress=constParameterPointer', '--suppress=constParameterCallback', '--suppress=redundantAssignment', '--suppress=normalCheckLevelMaxBranches', '-I', 'Inc', '-I', 'App', '-I', 'Drivers/BSP', '-I', 'Drivers/STM32F4xx_HAL_Driver/Inc', '-I', 'Drivers/CMSIS/Include', '-I', 'Middlewares/Third_Party/FreeRTOS/Source/include'] language: system types: [c] # 仅扫描项目自有代码;排除第三方库与 LVGL 依赖文件 # (UI 生成文件 ui_font_cn_12/ui_menu_tab 由生成器按工程约定产出,纳入受检) exclude: | (?x)^( Drivers/CMSIS/| Drivers/STM32F4xx_HAL_Driver/| Drivers/BSP/NET/lftpd/| Drivers/BSP/dhara/| Lib/| Middlewares/| MDK-ARM/| test/ ) - id: no-mojibake name: Forbid U+FFFD mojibake entry: python scripts/check_mojibake.py language: system types: [c] - id: coding-standard name: C coding standard (规范V1.0) entry: python scripts/check_coding_standard.py language: system types: [c] # 范围与 cppcheck 钩子一致;另排除 CubeMX 生成文件(Src/、Inc/,重新生成即覆盖)、 # dhara/FatFS 接口适配层(nand_ftl,函数名由外部 API 固定) exclude: | (?x)^( Drivers/CMSIS/| Drivers/STM32F4xx_HAL_Driver/| Drivers/BSP/NET/lftpd/| Drivers/BSP/GD5F2GQ5UE/nand_ftl\.| Drivers/BSP/dhara/| Lib/| Middlewares/| MDK-ARM/| test/| Src/| Inc/ ) # 5) 文档一致性门禁(D-7) # 存在性:md 互链 / 反引号路径是否指向真实文件(防迁移/删除后残留死链) - id: doc-links name: 文档链接存在性 (D-3/D-7) entry: python scripts/check_doc_links.py language: system files: \.md$ # 外部资料(芯片手册转录)链接形态不受控;第三方目录整体排除 exclude: | (?x)^( \.opencode/node_modules/| Lib/lvgl/| simulator/| MDK-ARM/RTE/| docs/芯片手册/ ) # 数值:README/AGENTS 任务表须与 Src/freertos.c 一致(D-2/D-7) - id: task-table name: FreeRTOS 任务表一致性 (D-2/D-7) entry: python scripts/gen_task_table.py --check language: system files: ^(README\.md|AGENTS\.md|Src/freertos\.c)$ pass_filenames: false # 体积:内存/Flash 数字须与最新 .map 一致(D-7 第三档) # 只在内存文档或代码变动时触发;.map 未生成时脚本自身给出明确提示 - id: mem-numbers name: 内存/Flash 数字一致性 (D-7 体积档) entry: python scripts/check_mem_numbers.py --scan language: system files: ^(docs/内存管理/.*\.md|scripts/check_mem_numbers\.py|App/.*\.c|App/.*\.h|Src/.*\.c|Inc/.*\.h)$ pass_filenames: false # 6) CubeMX 重生成存活审计(2026-09-29 加) # 背景:.ioc 的 KeepUserCode 只保护 USER CODE 标记区;标记之外的手工改动 # 重生成即被覆盖,且多数不报编译错(崩溃采集被打回空 while(1)、加固宏被删)。 # 本钩子验证"重生成易失清单"各项是否仍在预期位置,并对关键区做哈希漂移检测。 # 范围:仅在这些易失文件变动时触发(改动 .ioc 或生成文件本身就值得复核)。 - id: cubemx-survival name: CubeMX 重生成存活审计 entry: python scripts/check_cubemx_survival.py --check language: system files: ^(STM32F407-Demo\.ioc|Src/.*\.(c|h)|Inc/.*\.h|App/util/task_watchdog\.(c|h)|MDK-ARM/.*\.uvprojx|scripts/check_cubemx_survival\.py)$ pass_filenames: false