plataformatec/engine-credo

plataformatec/engine-credo 镜像说明

镜像概述

plataformatec/engine-credo是一个Docker容器，它将开源代码质量检查工具http://github.com/rrrene/credo%E5%B0%81%E8%A3%85%E4%B8%BA%E7%8B%AC%E7%AB%8B%E5%8F%AF%E6%89%A7%E8%A1%8C%E6%96%87%E4%BB%B6%EF%BC%8C%E5%B9%B6%E9%81%B5%E5%BE%AAhttps://github.com/codeclimate/spec%E8%BE%93%E5%87%BAJSON%E6%A0%BC%E5%BC%8F%E7%9A%84%E5%88%86%E6%9E%90%E7%BB%93%E6%9E%9C%EF%BC%8C%E6%96%B9%E4%BE%BF%E9%9B%86%E6%88%90%E5%88%B0%E4%BB%A3%E7%A0%81%E8%B4%A8%E9%87%8F%E6%A3%80%E6%B5%8B%E6%B5%81%E7%A8%8B%E4%B8%AD%E3%80%82

核心功能

1. 提供Credo工具的独立运行环境，无需本地安装依赖
2. 输出符合Code Climate规范的JSON结果，支持与相关平台集成
3. 支持对Elixir项目进行代码风格、复杂度及最佳实践的检查

使用场景

• 集成到Code Climate平台，实现Elixir项目的自动化代码质量检测
• 本地快速运行Credo检查，验证代码规范符合性
• CI/CD流程中加入代码质量检测步骤，确保代码符合团队标准

配置说明

• 需要将Elixir项目目录挂载到容器内的/code路径（Credo默认检查目录）
• 可通过命令参数调整Credo的检查规则（如--strict启用严格模式、--only指定检查项等）

部署示例

Docker Run命令

bash
docker run -v $(pwd):/code plataformatec/engine-credo

该命令将当前目录挂载到容器的/code路径，运行Credo对目录内的Elixir代码进行检查并输出JSON结果。

Docker Compose示例

yaml
version: '3'
services:
  credo-analysis:
    image: plataformatec/engine-credo
    volumes:
      - ./your-elixir-project:/code
    command: ["--strict"] # 可选：启用严格检查模式