eko3alpha/docker-phpqa

docker-phpqa镜像说明

镜像概述

docker-phpqa是一个集成多种PHP代码质量检测工具的Docker镜像，基于https://edgedesigncz.github.io/phpqa/%E6%9E%84%E5%BB%BA%EF%BC%8C%E5%8F%AF%E5%BF%AB%E9%80%9F%E5%AF%B9PHP%E9%A1%B9%E7%9B%AE%E8%BF%9B%E8%A1%8C%E8%B4%A8%E9%87%8F%E5%88%86%E6%9E%90%EF%BC%8C%E6%97%A0%E9%9C%80%E6%9C%AC%E5%9C%B0%E5%AE%89%E8%A3%85%E4%BE%9D%E8%B5%96%E3%80%82

核心功能

• 集成phploc、phpcs、phpmd、phpstan等主流PHP质量检测工具
• 支持生成HTML报告或CLI输出
• 可自定义忽略目录/文件、指定分析工具
• 支持并行执行提升效率，支持自定义配置文件

使用场景

• PHP项目日常代码质量检查
• 编码规范符合性验证
• 项目构建流程中的质量门禁
• 代码重构前的问题排查

配置说明

基础部署示例

bash
docker run --rm -u $UID -v $PWD:/app eko3alpha/docker-phpqa --report --ignoredDirs vendor,build,migrations,test

参数说明：

• --rm：清理临时镜像
• -u $UID：保持文件权限与当前用户一致
• -v $PWD:/app：挂载当前工作目录到容器
• --report：生成HTML报告
• --ignoredDirs：指定需忽略的目录

别名设置

简化命令操作，可设置别名：

• OSX：编辑~/.bash_profile
• Ubuntu：编辑~/.bash_aliases

添加以下内容：

bash
alias phpqa='docker run --rm -u "$UID" -v "$PWD:/app" eko3alpha/docker-phpqa'

刷新配置：

bash
source ~/.bash_profile # OSX
source ~/.bash_aliases # Ubuntu

使用别名：

bash
phpqa --report

常用分析命令

自定义PHPMD规则

1. 生成自定义规则文件（如phpmd.rules.xml）
2. 在项目根目录创建.phpqa.yml：

yaml
phpmd:
    standard: phpmd.rules.xml

3. 运行命令：

bash
phpqa --report --tools phpmd --verbose

更多详情请参考https://github.com/EdgedesignCZ/phpqa