PHP QA Docker镜像文档

概述和主要用途

最小化的PHP质量保证(QA)Docker镜像，专注于本地开发和CI环境的静态分析、代码风格检查及其他质量工具。与kool.dev管理的环境兼容，同时也适用于任何其他PHP使用场景。

核心功能和特性

包含的工具

静态分析

• Phan - PHP静态分析工具（命令：phan）
• PHP Mess Detector - PHP代码混乱检测器（命令：phpmd）
• PHP Copy/Paste Detector - PHP代码重复检测器（命令：phpcpd）

代码风格

• PHP Coding Standards Fixer - PHP代码规范修复工具（命令：php-cs-fixer）

安全检查

• Local PHP Security Checker - 本地PHP安全检查器（命令：local-php-security-checker）

测试工具

• PHPUnit 9.5（命令：phpunit）
• PHPUnit 10 - 前沿测试工具（命令：phpunit10）

使用场景和适用范围

适用于PHP项目的本地开发环境和持续集成(CI)流程，可直接运行各类QA工具进行代码质量检查、安全扫描和自动化测试，帮助开发者在开发和集成阶段确保代码质量。

使用方法和配置说明

直接运行工具

可直接从新容器中执行任何可用的QA工具。推荐使用kool CLI：

sh
cd my-laravel-project/
kool docker kooldev/phpqa:7.4 phan
kool docker kooldev/phpqa:7.4 php-cs-fixer

使用普通Docker命令运行：

sh
docker run --rm --init -it -v $(pwd):/app -w /app kooldev/phpqa:7.4

强烈建议查看kool CLI以获取Docker环境的更多优势。

可用标签

镜像为kooldev/phpqa，可用标签对应以下PHP版本：

• 8.3
• 8.2
• 8.1
• 8.0
• 7.4

使用kool.yml

在kool管理的环境中，可在kool.yml文件中添加脚本配置示例：

yaml
# kool.yml
scripts:
  # 定义phpqa容器的别名
  phpqa: kool docker kooldev/phpqa:8.1
  # 使用别名调用工具并带预定义参数（假设应用代码位于`app/`目录）
  phan: kool run phpqa phan --color -p -l app -iy 5
  phpcpd: kool run phpqa phpcpd --fuzzy app
  # ...

贡献指南

欢迎使用并提交PR添加更多有用的QA工具！短期目标包括：

• 以友好方式为用户提供工具特定配置
• 提供主流CI引擎（Github Actions、CircleCI、TravisCI）的配置片段模板
• 添加更多实用工具

使用模板更新镜像

应修改fwd-template.json进行配置，修改template/文件夹中的基础模板。任何更改后，需运行kool run template解析模板并生成所有版本的文件夹/文件。

许可证

MIT许可证。详情请参见许可证文件。