gepetto/linters

C++ & Python代码检查与格式化工具镜像

镜像概述

本Docker镜像集成了多种代码检查与格式化工具，专为C++和Python项目设计，旨在提供统一的代码风格检查与自动化格式化解决方案。支持本地开发环境快速使用，同时可无缝集成到Gitlab CI流程中，确保代码风格一致性。

核心功能与特性

• 多语言支持：同时支持C++和Python代码检查与格式化
• 工具集成：包含yapf、flake8、isort、clang-format等主流代码工具
• 自动化检查：提供代码风格合规性检查及自动格式化能力
• 配置支持：内置setup.cfg和.clang-format配置文件，确保检查规则统一
• 跨环境使用：支持本地开发环境直接运行及Gitlab CI自动化流程集成

使用场景与适用范围

• 本地开发环境中的代码风格即时检查与格式化
• Gitlab CI/CD流程中的代码风格自动化检查环节
• 团队协作开发时的代码规范统一与强制执行
• C++和Python混合项目的代码质量管控

详细使用方法

本地使用

使用预构建Docker镜像

⚠️ 这将更新您当前的工作目录 ⚠️

通过以下命令运行镜像，将当前工作目录挂载到容器中，自动执行代码检查与格式化：

bash
docker run --rm -v $PWD:/root/src -it gepetto/linters

手动方式

1. 首先从本仓库获取配置文件，将setup.cfg和.clang-format文件放置在项目的父目录中
2. 进入项目目录，执行以下命令进行检查与格式化：

bash
# Python代码格式化
yapf -ri .

# Python代码风格检查
flake8 .

# C++代码格式化
clang-format-6.0 -i $(find . -path ./cmake -prune -o -iregex '.*\.\(h\|c\|hh\|cc\|hpp\|cpp\|hxx\|cxx\)

### Gitlab CI集成

在Gitlab CI配置文件中添加以下job，实现代码风格自动化检查：

```yaml
format:
  image: gepetto/linters
  before_script:
    # 将镜像内置的配置文件链接到构建目录
    - test -f /builds/setup.cfg || ln -s /root/setup.cfg /builds
    - test -f /builds/.clang-format || ln -s /root/.clang-format /builds
  script:
    # Python导入顺序检查
    - isort -c
    # Python代码风格检查
    - flake8 .
    # C++代码格式化检查
    - check-clang-format.sh -print)

Gitlab CI集成

在Gitlab CI配置文件中添加以下job，实现代码风格自动化检查：

CODE_TOKEN_4`yaml format: image: gepetto/linters before_script: # 将镜像内置的配置文件链接到构建目录 - test -f /builds/setup.cfg || ln -s /root/setup.cfg /builds - test -f /builds/.clang-format || ln -s /root/.clang-format /builds script: # Python导入顺序检查 - isort -c # Python代码风格检查 - flake8 . # C++代码格式化检查 - check-clang-format.sh