如何用Git Filter实现与仓库不同的本地代码风格？

1. 准备双份clang-format配置文件 #

• 上游风格配置：复制项目官方的.clang-format文件并重命名为.clang-format-upstream，用于推送时将代码转成上游认可的格式。
• 个人偏好配置：创建.clang-format-local文件，写入你需要的规则——比如设置ColumnLimit: 80、AllowShortIfStatementsOnASingleLine: Never等。

2. 配置Git过滤器 #

Git的smudge和clean过滤器分别负责拉取代码时转成本地格式、推送代码时转回上游格式。

注册过滤器 #

直接编辑项目的.git/config文件，添加以下内容：

[filter "clang-format"]
    smudge = clang-format --style=file:.clang-format-local
    clean = clang-format --style=file:.clang-format-upstream

或者通过终端命令添加：

git config filter.clang-format.smudge "clang-format --style=file:.clang-format-local"
git config filter.clang-format.clean "clang-format --style=file:.clang-format-upstream"

指定应用过滤器的文件 #

在项目根目录创建或修改.gitattributes文件，添加需要格式化的文件类型（根据项目实际调整后缀）：

*.c filter=clang-format
*.cpp filter=clang-format
*.h filter=clang-format
*.hpp filter=clang-format

3. 验证配置效果 #

• 拉取上游代码后，Git会自动用你的本地配置格式化所有匹配的文件，你看到的就是符合80字符行宽、if语句单独换行的格式。
• 提交并推送代码时，Git会自动调用上游配置重新格式化，推送到仓库的代码完全符合官方编码风格，不会干扰其他开发者。

注意事项 #

• 确保两份配置仅在格式化规则上有差异，不要修改任何代码逻辑相关的设置。
• 如果出现格式冲突，优先检查本地配置是否与上游规则存在不可兼容的设置，调整后再重新提交。
• 首次配置完成后，可执行git checkout HEAD -- .触发过滤器，确保所有现有文件都按本地格式更新。

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