leshiy1295/gcc_linters

leshiy1295/gcc_linters 镜像说明

镜像概述

本镜像基于官方GCC镜像构建，预装了cppcheck、cpplint和clang-tidy三款主流C/C++静态分析工具，旨在为开发者提供便捷的代码质量检查环境，无需手动安装依赖即可快速开展代码审查工作。

核心功能

1. cppcheck：静态代码分析工具，可检测代码中的潜在bug、内存泄漏、未定义行为等问题。
2. cpplint：代码风格检查工具，遵循Google C++编程规范，帮助规范代码格式。
3. clang-tidy：基于Clang的代码检查工具，支持现代C++特性检查，并提供代码修复建议。

使用场景

• 本地开发阶段：快速验证代码质量，提前发现潜在问题。
• CI/CD流程：集成到持续集成 pipeline 中，作为代码合并的质量门禁。
• 教学与培训：帮助学习者养成良好的代码编写习惯。

配置说明

可通过挂载本地代码目录到容器内，直接运行工具进行检查。以下是常用操作示例：

Docker Run 示例

bash
# 挂载当前目录到容器的/workspace，运行cppcheck检查src目录
docker run -v $(pwd):/workspace docker.xuanyuan.run/leshiy1295/gcc_linters cppcheck /workspace/src

# 运行cpplint检查指定文件
docker run -v $(pwd):/workspace docker.xuanyuan.run/leshiy1295/gcc_linters cpplint /workspace/main.cpp

# 运行clang-tidy检查代码
docker run -v $(pwd):/workspace docker.xuanyuan.run/leshiy1295/gcc_linters clang-tidy /workspace/src/*.cpp -- -I/workspace/include

Docker Compose 示例

yaml
version: '3'
services:
  code-check:
    image: docker.xuanyuan.run/leshiy1295/gcc_linters
    volumes:
      - ./code:/workspace
    command: cppcheck /workspace/src

注意事项

• 确保本地代码目录具有读写权限，以便容器正常访问文件。
• 根据工具文档调整参数，满足不同场景的检查需求。
• 工具版本与GCC版本保持兼容，可通过镜像标签选择特定版本（若提供）。