能否列出pre-commit运行时传入钩子的文件列表且不执行实际钩子?
查看pre-commit匹配文件列表的实操方法
要确认--from-ref、--to-ref参数实际传入钩子的文件名、同时不运行真实钩子逻辑,可直接复用以下方案:
使用identity钩子获取准确文件列表
这是pre-commit生态通用的调试能力,无需修改项目内的业务钩子配置,沿用原有ref参数执行命令即可:
pre-commit run identity --from-ref $(git merge-base master HEAD) --to-ref HEAD
identity是无副作用的元钩子,作用就是原样回显所有接收到的传入文件名,输出结果和你跑flake8时实际收到的文件入参完全一致,全程不会执行代码检查、修改本地文件的操作。
之前加--verbose看不到文件名的核心原因,是flake8自身不会打印接收到的入参文件,和pre-commit的文件筛选逻辑无关,用identity钩子可以直接绕开这个问题拿到准确结果。
如果执行命令时提示找不到identity钩子,说明当前项目的配置里没有引入这个公共钩子,只需要在.pre-commit-config.yaml里临时追加官方提供的identity钩子配置即可,调试完成后可以随时删除对应配置段。
临时自定义钩子调试(可选)
如果需要调试自定义的文件匹配规则,也可以临时把目标钩子的entry参数替换为echo,执行同参数的pre-commit run命令拿到对应文件列表,调试完成后改回原有钩子命令即可。
实用小技巧
如果需要对比不同ref参数下的文件匹配差异,可以把identity钩子的输出重定向到临时文件,直接用diff对比结果,例如:
# 对比HEAD~3基准和merge-base基准的文件匹配差异 pre-commit run identity --from-ref HEAD~3 --to-ref HEAD > /tmp/files_old.txt pre-commit run identity --from-ref $(git merge-base master HEAD) --to-ref HEAD > /tmp/files_merge.txt diff /tmp/files_old.txt /tmp/files_merge.txt
内容的提问来源于stack exchange,提问作者RubenLaguna
相关产品推荐
相关产品推荐

