有没有一种方法可以clang-format在报告文件是否符合指定格式的模式下运行？一种试运行模式，它报告是否需要更改，但不进行更改。理想情况下，如果文件需要更改，我希望 clang-format 只返回一个非零退出代码。或者，更理想的是，非零退出代码和标准输出上需要更改的文件列表。
我试图保持问题的通用性，以便更多人可以回答，但我想做的是编写一个 git pre-commit 钩子，它将拒绝任何与预期 .clang-format 不匹配的提交。在索引中的文件列表上运行 clang-format 很容易。但很难知道 clang-format 是否真的改变了任何东西。
我有一个基于-output-replacements-xml（我将作为答案发布）的潜在解决方案，但这是一个 hack，我觉得这应该更简单。欢迎评论/建议、编辑、不同的答案/方法。
我觉得这应该比它更容易的原因之一是因为 -output-replacements-xml 本质上给了我想要的答案，它只是没有以一种易于使用的方式给我。但是，由于不需要替换的输出是非常可预测的，因此解析输出并不太难。
我现在拥有的是
clang-format -style=file -output-replacements-xml | grep -c "<replacement " >/dev/null
这实际上返回了我想要的退出代码的倒数，因为 grep 如果匹配则返回 0，如果不匹配则返回 1。但这很容易处理。
所以我的 git pre-commit 钩子的相关位是
git diff --cached --name-only --diff-filter=ACMRT |
grep "\.[cmh]$" |
xargs -n1 clang-format -style=file -output-replacements-xml |
grep "<replacement " >/dev/null
if [ $? -ne 1 ]; then
echo "Commit did not match clang-format"
exit 1
fi
使用--dry-run和-Werror命令行选项。如果任何输入文件的格式不正确，它们将导致 ClangFormat 将任何格式违规输出到 stdout 并返回非零退出状态。
$ clang-format --dry-run --Werror foo.cpp
foo.cpp:129:23: error: code should be clang-formatted [-Wclang-format-violations]
if (rc <= 0) {
$ echo $?
1
我不完全确定您的用例是什么，但请查看 git-clang-format ( https://llvm.org/svn/llvm-project/cfe/trunk/tools/clang-format/git-clang-format ) . 它基本上为 git 提供了 clang 格式的集成，也许这就是您正在寻找的。
我稍微调整了这篇文章中 phs 的评论以提出：
find embedded/ -regex '.*\.\(ino\|cpp\|hpp\|cc\|cxx\|h\)' -exec cat {} \; | diff -u <(find embedded/ -regex '.*\.\(ino\|cpp\|hpp\|cc\|cxx\|h\)' -exec clang-format-3.9 -style=file {} \;) -
那是..
cat所有cpp-ish文件和管道diff（diff将接受stdin，因为我-在最后指定）<( .. )语法）clang-format在这些相同的文件上运行。不要在此处使用就地格式化。这是发送到的另一半diffdiff没有输出就退出，成功！您还可以通过$?-- 它应该为零来检查退出代码。 我让我的 CI 服务 (travis) 在 bash 脚本中运行这一行，以确保格式正确。我有另一个脚本用于实际运行格式化程序。这让我想起了一个警告：您必须使用可以执行子进程的 shell（posix shell 不能）。
您可以git diff使用clang-format-diff：
$ git diff -U0 --no-color --staged HEAD | clang-format-diff -p1
笔记：
--staged用于clang-format-diff仅在阶段性更改上运行$ git diff -U0 --no-color --staged HEAD -- $PWD/dir1 $PWD/dir2 $PWD/dir3 | clang-format-diff -p1
pre-commit现在你的预提交可以是这个：
#!/bin/bash
dir_list="$PWD" # Add the directories you want here
cmd="git diff -U0 --no-color --staged HEAD -- $dir_list | clang-format-diff -p1"
echo ""
echo "Running clang-format on this commit"
echo ""
# Execute the format command
diff=$(eval "$cmd")
if [[ $? -ne 0 ]]
then
echo "Command failed to execute."
exit 1
fi
# Print the outcome
if [[ -z "$diff" ]]
then
echo "Everything is clean"
exit 0
else
echo "$diff"
echo ""
echo "Commit aborted due to code format inconsistencies."
exit 1
fi
我使用git-clang-formatMike Rhodes 博客中的预提交脚本：
#!/bin/python
import subprocess
output = subprocess.check_output(["git", "clang-format", "--diff"])
if output not in ['no modified files to format\n', 'clang-format did not modify any files\n']:
print "Run git clang-format, then commit.\n"
exit(1)
else:
exit(0)
该脚本有一个小错误，即在没有提交时它不起作用（尝试检查尚不存在的 HEAD）。要绕过这一点，请使用-nor--no-verify选项。
当您绕过检查时，使用-n跳过预提交脚本也很有帮助，因为大型代码库可能需要很长时间。
原帖在这里：http ://www.dx13.co.uk/articles/2015/4/3/Setting-up-git-clang-format.html
在我受到David Ogren 的帖子的启发后，我制作了一个pre-commit能够处理分阶段更改的钩子。这将确保pre-commit钩子将在实际构成提交内容的代码上工作，并且不会被clang-format未暂存的运行所愚弄。
#!/bin/bash
files=()
for file in `git diff --cached --name-only --diff-filter=ACMRT | grep -E "\.(cpp|hpp)$"`; do
if ! cmp -s <(git show :${file}) <(git show :${file}|clang-format); then
files+=("${file}")
fi
done
if [ -n "${files}" ]; then
echo Format error within the following files:
printf "%s\n" "${files[@]}"
exit 1
fi
您可以简单地使用 -n 选项
clang-format -n <file>