pre-commit钩子应通过git diff --cached --name-only --diff-filter=ACM | grep '\.html$'精准捕获本次提交的HTML变更文件,仅对这些文件调用本地html-validate校验,避免全量扫描;需锁定版本、禁用--fix、显式配置编码,确保跨环境一致且不阻塞开发流程。

pre-commit钩子怎么捕获HTML变更并触发检查
直接在.git/hooks/pre-commit里写死html-validate或tidy命令是行不通的——它会扫全量文件,而你只关心本次暂存区里修改的HTML。必须用git diff --cached精准提取变更路径。
- 用
git diff --cached --name-only --diff-filter=ACM | grep '\.html$'拿到本次提交中新增、修改、重命名的HTML文件,避免检查未改动的旧文件 - 如果结果为空(
[ -z "$HTML_FILES" ]),直接exit 0跳过,不阻塞非HTML提交 - Windows用户注意:
grep在Git Bash可用,但PowerShell原生命令是Select-String,建议统一用Git Bash环境执行钩子
html-validate和tidy选哪个做基础校验
html-validate更适合作为现代前端项目的默认选择,tidy更适合遗留系统或需要兼容IE6/7的场景。两者核心差异不在“能不能用”,而在“报错是否可操作”。
-
html-validate基于Web标准(HTML5+ARIA),规则可配置、错误带具体行号和修复建议,支持ESLint式插件扩展;但对自定义标签(如<my-component></my-component>)需手动加custom-elements配置 -
tidy强在容错和修复能力,能自动补全缺失的 、转义 - 若项目已用
eslint-plugin-jsx-a11y,建议只用html-validate,避免重复检查
&等,但错误信息模糊(如“line 42 column 17 - Warning: missing ”),且不支持现代语义化规则(如aria-* 属性校验)如何避免pre-commit卡住开发流程
HTML校验本身很快,但卡顿通常来自三类陷阱:工具启动开销、全局安装路径问题、以及无条件全量扫描。
生成周报:读取本机 Git 仓库最近一周的提交记录,按项目分类提炼总结,生成标准周报格式,通过微信推送并返回给用户。触发词:周报、weekly report、git总结、提交记录总结、工作周报。
- 别用
npx html-validate——每次都会重新下载依赖;改用本地安装的二进制:./node_modules/.bin/html-validate - 确保
package.json中html-validate版本锁定(如"html-validate": "7.12.0"),不同版本规则可能变化,导致同一份HTML在同事机器上通过/失败不一致 - 禁用
--fix自动修复:pre-commit阶段只报告,不修改文件;修复动作留给开发者主动运行npm run validate:fix,避免钩子悄悄改代码引发diff混乱
commit-msg钩子要不要同步校验HTML相关提交信息
要,但只针对明确涉及HTML变更的提交。盲目强制所有提交遵守Conventional Commits反而增加负担。
立即学习“前端免费学习笔记(深入)”;
- 先判断本次提交是否含HTML文件:
git diff --cached --name-only | grep '\.html$' > /dev/null - 如果命中,再读取
$1(commit-msg传入的临时文件路径),用grep -q 'html\|template\|markup' $1检查消息是否提及关键词 - 不匹配时只warn不fail:
echo "⚠️ 提交含HTML文件,建议在commit message中说明模板/结构变更",保持友好而非阻断
实际落地时最容易被忽略的是HTML文件编码识别——html-validate默认按UTF-8解析,但老项目里可能混着GBK或ISO-8859-1的HTML。不显式声明encoding配置项,会导致中文乱码报错,而错误提示里根本不会提编码问题。


















