witekio/clang-format-checker

clang-format-checker

用于通过clang-format验证代码格式的Docker镜像。

快速开始

以下命令会将当前工作目录挂载到容器的src工作目录，并递归检查src、include目录以及file.cpp的源代码文件格式：

docker run --rm -v $(pwd):/src witekio/clang-format-checker -r src includes file.cpp

输出

docker run命令的返回码含义：

• 若发现任何格式错误，返回非零值，并在标准输出中打印错误信息。
• 若未发现问题，返回0

# 递归检查当前文件夹下的所有文件
$ docker run -v $(pwd):/src --rm witekio/clang-format-checker -r .                                 2 ↵
--- ./testCode/File.cpp	(原始文件)
+++ ./testCode/File.cpp	(格式化后)
@@ -3,18 +3,13 @@
 
 #include "MyHeader.h"
MyClass::MyClass()
-    : arg(new    Other( std::string(  "string"),      4))
+  : arg(new Other(std::string("string"), 4))

指定代码风格

可通过源代码文件夹中的.clang-format文件定义clang-format使用的代码风格。更多信息请参见clang-format风格选项。

支持的参数

可使用--exclude排除文件夹和文件：

# 递归检查.h/.cpp文件，排除'vendors'文件夹和'*_test.cpp'
docker run -v $(pwd):/src --rm witekio/clang-format-checker -r  --exclude src/third_party --exclude '*_test.cpp' src include foo.cpp

run-clang-format.py 帮助信息：

usage: run-clang-format.py [-h] [--clang-format-executable EXECUTABLE]
                           [--extensions EXTENSIONS] [-r] [-q] [-j N]
                           [--color {auto,always,never}] [-e PATTERN]
                           file [file ...]

围绕clang-format的包装脚本，适用于检查多个文件以及用于持续集成。这是clang-format命令行的替代API，可并行处理多个文件和目录，生成差异输出并返回合理的退出码。

位置参数：
  file                  要检查的文件或目录

可选参数：
  -h, --help            显示此帮助消息并退出
  --clang-format-executable EXECUTABLE
                        clang-format可执行文件路径
  --extensions EXTENSIONS
                        逗号分隔的文件扩展名列表（默认：c,h,C,H,cpp,hpp,cc,hh,c++,h++,cxx,hxx）
  -r, --recursive       递归遍历目录
  -q, --quiet           安静模式，减少输出
  -j N                  并行运行N个clang-format任务（默认：CPU数量+1）
  --color {auto,always,never}
                        显示带颜色的差异（默认：auto）
  -e PATTERN, --exclude PATTERN
                        从递归搜索中排除匹配给定类glob模式的路径

更多信息可查看https://github.com/Sarcasm/run-clang-format%E3%80%82

许可证

本项目采用MIT许可证 - 详见LICENSE.md文件。

源代码

源代码仓库位于https://github.com/Witekio/clang-format-checker-docker