megabytelabs/flake8

Flake8 CodeClimate引擎

由Megabyte Labs维护的性能优化CodeClimate引擎。

概述

本项目是Flake8 的https://codeclimate.com/引擎，旨在将Flake8代码检查结果集成到GitLab合并请求的Web UI中。同时，项目还生成独立的轻量级Flake8实例，可快速在CI/CD pipeline中运行。

Flake8是以下工具的包装器：

• https://pypi.org/project/pyflakes/
• https://github.com/PyCQA/pycodestyle
• https://github.com/PyCQA/mccabe

Flake8支持通过插件扩展，可在https://github.com/DmytroLitvinov/awesome-flake8-extensions找到丰富的插件资源。

独立版本

若无需CodeClimate集成，可使用不带codeclimate-前缀的镜像（如megabytelabs/flake8而非megabytelabs/codeclimate-flake8）获取latest、slim及版本化镜像。完整镜像列表可查看https://hub.docker.com/r/megabytelabs/flake8。

注：CodeClimate引擎版本的DockerHub页面除上述链接外，另有https://hub.docker.com/r/megabytelabs/codeclimate-flake8。

轻量级构建

所有CodeClimate引擎项目均包含两种变体：常规构建（基于项目根目录的Dockerfile）和slim构建（通过DockerSlim生成）。若追求稳定性并希望使用slim构建，建议引用镜像时指定确切版本（如megabytelabs/codeclimate-package:5.4.0-slim而非megabytelabs/codeclimate-package:slim）。

版本控制

尽可能将Docker镜像版本与对应软件版本关联。例如，megabytelabs/codeclimate-eslint:5.4.0通常包含5.4.0版本的ESLint（可能存在例外）。

测试

通过多种测试方法确保latest和slim构建正常工作：

• Dockerfile-test.yml文件中的容器结构测试
• 对test/compare/目录下样本项目运行命令，验证latest与slim镜像输出一致性
• 对CodeClimate引擎自定义代码的单元测试（部分场景）

需求

• https://gitlab.com/megabyte-labs/ansible-roles/docker

开发需求

• DockerSlim - 用于生成紧凑、安全的镜像
• jq - 用于JSON交互
• Node.js (>=14.18) - 用于添加预提交钩子和维护任务等开发功能
• 更多通过Taskfile.yml动态安装的需求（基于自定义https://github.com/go-task/task分支**https://github.com/ProfessorManhattan/Bodega**）

若使用项目提供的开发工具，需运行bash start.sh（或npm i，完成后会调用bash start.sh）。start.sh脚本会自动安装构建系统中缺失的依赖（无需sudo）到用户的~/.local/bin目录，并生成文档等。开发就绪后，运行task --menu可打开交互式对话框了解构建命令。

示例

本地测试

通过以下命令在本地测试工具，无需本地安装Flake8，容器退出后自动清理：

shell
docker run -it -v ${PWD}:/work -w /work --rm docker.xuanyuan.run/megabytelabs/flake8:latest --help

Bash别名设置

将以下代码添加到~/.profile（或等效文件），以便随时运行Flake8命令：

shell
flake8() {
  docker run -it -v ${PWD}:/work -w /work --rm docker.xuanyuan.run/megabytelabs/flake8:latest "$@"
}

注：部分CLI工具无参数时运行（如ansible-lint），由于Docker镜像默认命令为显示版本，需通过ansible-lint .方式运行。

GitLab CI集成

CodeClimate GitLab CI示例

若需改进GitLab合并请求Web UI，可参考https://gitlab.com/megabyte-labs/gitlab-ci/-/raw/master/lint/codeclimate.gitlab-ci.yml。需在包含所有要报告的检查器的单个CI阶段运行，因为GitLab CI仅接受一个CodeClimate报告工件。

CodeClimate CLI步骤

1. 在项目根目录创建.codeclimate.yml，至少包含：

yml
---
engines:
  flake8:
    enabled: true
exclude_paths:
  - 'node_modules/**'

2. 拉取并标记CodeClimate镜像：

shell
docker pull docker.xuanyuan.run/megabytelabs/codeclimate-flake8:latest
docker tag megabytelabs/codeclimate-flake8:latest codeclimate/codeclimate-flake8:latest

3. 安装并运行CodeClimate CLI（--dev参数用于非官方CodeClimate命名空间引擎）：

shell
brew install codeclimate/formulae/codeclimate
codeclimate analyze --dev

生成HTML报告：

shell
codeclimate analyze --dev -f html > codeclimate-report.html

独立集成

在GitLab CI中不使用CodeClimate集成时，创建.gitlab-ci.yml：

yaml
---
stages:
  - lint

include:
  - remote: https://gitlab.com/megabyte-labs/gitlab-ci/-/raw/master/lint/flake8.gitlab-ci.yml

建议：生产环境中，将上述remote链接的源代码复制到其他位置并更新链接，避免依赖外部文件变更。

配置Flake8

项目优先在.config/flake8.toml查找配置，若无则使用标准位置。

扩展Flake8

当前引擎仅加载Flake8基础功能，不含额外插件。若需添加插件并了解实现方法，欢迎提交PR。

构建Docker容器

修改Dockerfile后，通过以下命令上传自定义容器到Docker Hub：

shell
export DOCKERHUB_USERNAME=你的DockerHub用户名
export DOCKERHUB_PASSWORD=你的DockerHub密码
docker login -u "$DOCKERHUB_USERNAME" -p "$DOCKERHUB_PASSWORD" docker.io
docker build --pull -t "$DOCKERHUB_USERNAME/flake8:latest" .
docker push "$DOCKERHUB_USERNAME/flake8:latest"

构建轻量级容器

通过https://gitlab.com/megabyte-labs/ansible-roles/dockerslim可减小镜像体积并提升安全性。运行`npm i（或bash start.sh）后，执行task docker:build可构建latest和slim`版本。

手动构建并发布slim镜像到Docker Hub：

shell
export DOCKERHUB_USERNAME=你的DockerHub用户名
export DOCKERHUB_PASSWORD=你的DockerHub密码
docker login -u "$DOCKERHUB_USERNAME" -p "$DOCKERHUB_PASSWORD" docker.io
docker build -t "$DOCKERHUB_USERNAME/flake8:latest" .
docker-slim build --tag $DOCKERHUB_USERNAME/flake8:slim $DOCKERHUB_USERNAME/flake8:latest
docker push "$DOCKERHUB_USERNAME/flake8:slim"

可修改package.json中blueprint.dockerSlimCommand调整构建命令。

构建工具

项目包含辅助开发的额外文件，通过Node.js环境运行npm i（或bash start.sh）后，可使用task --list查看可用开发功能，或task --menu打开交互式菜单。

注：使用自定义版本的https://github.com/go-task/task，若已安装需替换或使用不同命令名。

哲学

持续集成（CI）工具可显著提升开发效率，如扫描代码错误、自动部署软件。本项目是CI拼图的一部分，几乎所有https://gitlab.com/megabyte-labs/dockerfile/ci-pipeline均专注单一功能。

通过内部构建容器，确保代码透明度，同时最小化镜像体积以加快CI环境下载和运行速度。项目中的配置文件旨在规范开发流程，提升团队协作效率。

贡献

欢迎贡献、报告问题和提出功能请求！可查看https://github.com/megabyte-labs/codeclimate-flake8/issues。贡献前请参考https://github.com/megabyte-labs/codeclimate-flake8/blob/master/docs/CONTRIBUTING.md。

许可证

版权所有 © 2020-2021 Megabyte LLC。本项目采用https://gitlab.com/megabyte-labs/docker/codeclimate/flake8/-/blob/master/LICENSE许可。