codacy/codacy-prospector

镜像概述

本镜像为专为Django项目设计的Codacy引擎，旨在通过集成多种代码检查工具，帮助开发团队自动化代码质量检查流程，提升Django项目代码的规范性、可读性和可维护性。

核心功能与特性

• 多工具集成：整合flake（Python代码风格检查）、django-lint（Django项目专用代码规范检查）、django-compatlib（Django版本兼容性分析库），覆盖代码质量多维度检查需求
• 自动化分析：支持语法错误检测、代码风格违规提示、潜在bug识别及Django版本兼容性问题预警
• Codacy平台兼容：可与Codacy平台无缝集成，自动同步检查结果，生成可视化质量报告和改进建议
• 轻量高效：基于精简基础镜像构建，部署快速，资源占用低，适合各类环境运行

使用场景与适用范围

使用场景

• CI/CD流程集成：在代码提交、合并或构建阶段自动执行质量检查，防止不合格代码进入主分支
• 本地开发辅助：开发人员在提交代码前进行本地检查，提前发现并修复问题
• 代码审查支持：为团队代码审查提供客观质量数据，聚焦关键改进点

适用范围

• 基于Django框架开发的Web应用、API服务等项目
• 个人开发者、中小型开发团队及企业级研发团队
• 支持Django 1.x至最新版本的项目（具体版本兼容性需参考django-compatlib配置）

使用方法与配置说明

Docker Run 命令示例

bash
docker run -v /path/to/your/django/project:/app \
  -e CODACY_PROJECT_TOKEN=your_project_token \
  codacy-django-engine

说明：

• -v /path/to/your/django/project:/app：挂载本地Django项目目录到容器内/app路径（检查目标目录）
• -e CODACY_PROJECT_TOKEN=your_project_token：设置Codacy平台项目令牌（从Codacy项目设置中获取），用于结果同步

Docker Compose 配置示例

yaml
version: '3'
services:
  codacy-django:
    image: codacy-django-engine
    volumes:
      - ./django-project:/app  # 本地Django项目路径映射
    environment:
      - CODACY_PROJECT_TOKEN=your_project_token  # 必选：Codacy项目令牌
      - CHECK_RULES=/app/.codacy-rules.yml       # 可选：自定义规则文件路径
      - SKIP_FILES=migrations,tests/temp         # 可选：跳过检查的文件/目录（逗号分隔）

环境变量配置

自定义检查规则

在项目根目录创建 .codacy-rules.yml 文件，可自定义检查规则，示例：

yaml
rules:
  flake8:
    enabled: true
    max-line-length: 120  # 自定义行长度限制（默认79）
    ignore: E501,W292     # 忽略特定规则（E501：行过长，W292：无换行符）
  django-lint:
    enabled: true
    check-templates: true  # 启用Django模板检查
  django-compatlib:
    enabled: true
    target-version: "4.2"  # 目标Django版本（用于兼容性检查）