itsmycargo/wolfhound

Wolfhound 镜像文档

镜像概述

Wolfhound 是一款专注于代码质量与风格监控的工具镜像，旨在帮助开发团队实时跟踪代码质量指标，确保代码符合团队制定的风格规范和质量标准。通过自动化检测流程，减少人工代码审查成本，提升开发效率和代码可靠性。

核心功能与特性

• 持续监控：实时跟踪代码库变更，自动触发质量检测
• 多维度检测：覆盖代码风格一致性、语法错误、潜在漏洞等质量指标
• 灵活配置：支持自定义检测规则和阈值，适配不同团队的代码规范
• 报告生成：提供详细的检测报告，包含问题定位和改进建议
• 轻量集成：可无缝接入CI/CD流程或本地开发环境

使用场景

• 开发环境：本地开发时实时反馈代码质量问题，辅助开发者即时修正
• 团队协作：确保团队成员提交的代码符合统一风格和质量标准
• CI/CD流程：作为代码合并前的质量门禁，阻止低质量代码进入主分支
• 代码审计：定期对现有代码库进行全面质量评估，识别技术债务

使用方法

基本使用（Docker Run）

bash
docker run -v /path/to/your/code:/app wolfhound

• 说明：将本地代码目录挂载到容器内的/app目录，Wolfhound会自动对该目录下的代码进行质量和风格检测。

自定义配置

如需使用自定义检测规则，可将配置文件挂载到容器内的/config目录：

bash
docker run -v /path/to/your/code:/app -v /path/to/custom/config:/config wolfhound

Docker Compose 配置示例

yaml
version: '3'
services:
  wolfhound:
    image: wolfhound
    volumes:
      - ./your-code:/app          # 挂载代码目录
      - ./wolfhound-config:/config # 挂载自定义配置
    environment:
      - LOG_LEVEL=info            # 日志级别（可选：debug, info, warn, error）
      - REPORT_FORMAT=json        # 报告格式（可选：json, html, text）

环境变量配置

注意事项

• 确保挂载的代码目录具有可读权限，容器需要访问代码文件进行检测
• 首次运行时可能需要下载依赖，建议在网络稳定环境下执行
• 自定义配置文件需符合Wolfhound的规则格式，具体可参考官方配置文档