gilleshenrard/c-linters

C语言 linting 与分析 Docker 镜像

这是一个多阶段构建的Docker镜像，提供自包含、可复现的环境，用于静态分析、代码格式化、复杂度测量、许可证合规检查和文档生成，主要面向嵌入式C/C++项目。

源码地址： https://github.com/gilleshenrard/docker-c-linters

包含工具

维护者说明： 工具版本在本README中硬编码，每次Dockerfile更新版本时请记得更新此表格。

拉取镜像

该镜像托管在Docker Hub，可通过以下命令拉取：

bash
docker pull docker.xuanyuan.run/gilleshenrard/c-linters:latest

使用方法

运行一次性工具

bash
# 静态分析
docker run --rm -v "$(pwd)":/src <镜像名称>:<镜像版本> cppcheck --enable=all /src

# 格式检查
docker run --rm -v "$(pwd)":/src <镜像名称>:<镜像版本> clang-format --dry-run --Werror /src/main.c

# 复杂度报告
docker run --rm -v "$(pwd)":/src <镜像名称>:<镜像版本> lizard /src

# 许可证合规检查
docker run --rm -v "$(pwd)":/src <镜像名称>:<镜像版本> reuse lint

交互式 shell

bash
docker run --rm -it -v "$(pwd)":/src <镜像名称>:<镜像版本> bash

GitHub Actions 集成

yaml
jobs:
  lint:
    runs-on: ubuntu-latest
    container:
      image: docker.xuanyuan.run/gilleshenrard/c-linters:latest

    steps:
      - uses: actions/checkout@v4

      - name: 静态分析（CppCheck）
        run: cppcheck --enable=all --error-exitcode=1 src/

      - name: 格式检查（Clang-Format）
        run: |
          find src/ -name '*.c' -o -name '*.h' | \
          xargs clang-format --dry-run --Werror

      - name: Linting（Clang-Tidy）
        run: run-clang-tidy -p build/

      - name: 复杂度检查（Lizard）
        run: lizard src/ --CCN 10 --length 50 --arguments 5

      - name: 许可证合规检查（REUSE）
        run: reuse lint

      - name: 文档生成（Doxygen）
        run: doxygen Doxyfile

构建镜像

bash
docker build -t <镜像名称>:<镜像版本> .

覆盖工具版本

所有版本在Dockerfile顶部以ARG声明，可在构建时覆盖：

bash
docker build \
  --build-arg CPPCHECKVERSION="2.21.0" \
  --build-arg CLANGVERSION="22.2.0" \
  --build-arg CLANGVERSIONMAJOR="22" \
  --build-arg LIZARDVERSION="1.23.1" \
  --build-arg REUSEVERSION="6.3.0" \
  -t <镜像名称>:<镜像版本> .

注意： CLANGVERSIONMAJOR必须与CLANGVERSION的主版本号一致（例如22对应22.1.0）。它们分开是因为LLVM归档路径使用完整版本字符串，而内部头文件目录仅使用主版本号。

镜像架构

该镜像使用两阶段构建以保持最终镜像精简：

+-----------------------------------------------+
| 阶段1：构建（debian:trixie-slim）             |
|                                               |
|  - 从源码编译CppCheck                          |
|  - 从LLVM发布版提取Clang二进制文件              |
|  - 在Python虚拟环境中安装Lizard + REUSE         |
+------------------------|----------------------+
                         | COPY /opt
+------------------------|----------------------+
| 阶段2：运行（debian:trixie-slim）             |
|                                               |
|  - 安装python3、doxygen、git、                 |
|    file、ca-certificates                       |
|  - 将工具路径添加到PATH                        |
+-----------------------------------------------+

最终镜像中不包含构建工具链（cmake、ninja、wget、gcc等）。

运行时工具位置

以上所有路径均已添加到PATH，因此所有工具可直接通过名称调用。

许可证

本Dockerfile基于https://opensource.org/licenses/MIT分发。
© 2026 Gilles Henrard <***>