如何配置Git实现提交代码时自动去除pdb、debugger等调试行并在工作区保留？

你之前的.gitattributes配置存在语法错误，filter参数后需指定自定义过滤器的名称，而非要匹配的调试语句内容，同时还需要额外配置过滤器的执行规则才能生效，具体操作如下：

实现原理 #

Git的filter机制包含两个处理阶段：

• clean阶段：文件被暂存（准备提交）时执行，仅修改存入暂存区的文件内容，不会改动本地工作区的原文件
• smudge阶段：文件从仓库检出到工作区时执行

我们只需配置clean阶段的规则，过滤掉调试语句即可实现需求。

步骤1：修改.gitattributes配置 #

在项目根目录的.gitattributes文件中写入以下内容，指定不同后缀文件对应的过滤器名称：

*.py filter=remove-debug-py
*.js filter=remove-debug-js

步骤2：配置过滤器的clean规则 #

根据你的需求选择直接删除调试行，或者注释调试行，执行对应的Git配置命令即可：

方案1：提交时直接删除调试行 #

• 配置Python调试语句（匹配pdb.set_trace()相关行）过滤规则：

# 全局生效，所有项目都复用该规则
git config --global filter.remove-debug-py.clean "sed '/^\s*import pdb\s*;\s*pdb\.set_trace()/d; /^\s*pdb\.set_trace()/d'"

# 仅当前项目生效，去掉--global参数在项目根目录执行即可
# git config filter.remove-debug-py.clean "sed '/^\s*import pdb\s*;\s*pdb\.set_trace()/d; /^\s*pdb\.set_trace()/d'"

• 配置JS调试语句（匹配debugger行）过滤规则：

git config --global filter.remove-debug-js.clean "sed '/^\s*debugger\s*;*\s*$/d'"

方案2：提交时注释调试行 #

如果不想直接删除，只需要把调试行注释掉，替换为以下命令即可：

• Python规则：

git config --global filter.remove-debug-py.clean "sed 's/^\(\s*import pdb\s*;\s*pdb\.set_trace()\)/# \1/; s/^\(\s*pdb\.set_trace()\)/# \1/'"

• JS规则：

git config --global filter.remove-debug-js.clean "sed 's/^\(\s*debugger\s*;*\s*\)$/\/\/ \1/'"

验证效果 #

配置完成后，你可以在测试文件中加入调试语句，执行git add <文件名>暂存后，运行git diff --cached <文件名>查看暂存区内容，即可看到调试语句已经被过滤/注释，而本地工作区的原文件中的调试语句依然保留。

注意事项 #

• 以上配置依赖sed命令，Windows环境可通过Git Bash、WSL环境执行，原生PowerShell需自行调整命令语法
• 已提交到仓库的历史调试语句不会被自动处理，需要手动删除一次
• 如果你常用的调试语句写法和示例匹配规则不同，可以自行调整sed命令中的正则表达式适配使用习惯

内容的提问来源于stack exchange，提问作者CrisAbxs