adamculp/php-code-quality

php-code-quality

镜像概述和主要用途

本Docker镜像旨在集成多种PHP代码质量工具，提供便捷的使用方式。通过该镜像，用户可进行PHP静态分析、代码行数统计、代码异味检测、复制粘贴检测、PHP版本兼容性检查等，助力现代化项目的代码质量评估与改进。

镜像已在Docker Hub和GitHub Container Repository发布，方便直接获取使用。

核心功能和特性

镜像包含以下PHP代码质量工具：

• phpstan/phpstan（静态分析）
• squizlabs/php_codesniffer（代码规范检查）
• phpcompatibility/php-compatibility（PHP版本兼容性检查）
• phploc/phploc（代码行数统计）
• phpmd/phpmd（代码异味检测）
• pdepend/pdepend（代码依赖分析）
• sebastian/phpcpd（复制粘贴检测）
• phpmetrics/phpmetrics（代码 metrics 分析）
• phpunit/phpunit（单元测试）
• friendsofphp/php-cs-fixer（代码格式化）

使用场景和适用范围

适用于需要对PHP项目进行代码质量评估的开发团队和个人开发者，尤其适合：

• 项目代码规范检查与格式化
• 静态错误检测与潜在问题排查
• 代码复杂度与质量指标分析
• PHP版本迁移前的兼容性评估
• 自动化测试与持续集成流程

使用方法和配置说明

基本使用

注意：直接运行镜像无任何操作，需在命令后添加具体工具命令（见下方示例）。

Docker Hub 拉取使用

bash
cd </path/to/desired/directory>
docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp \
adamculp/php-code-quality:latest <followup-command-with-arguments>

GitHub Container Repository 拉取使用

bash
cd </path/to/your/project>
docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp \
ghcr.io/adamculp/php-code-quality:latest <followup-command-with-arguments>

Windows 用户注意事项

$PWD（当前工作目录）在Windows中无法正常使用，需替换为完整路径，例如 "//c/Users/adamculp/project"。

可用命令

镜像提供以下可执行命令：

• sh（或其他shell命令）+ 参数
• php + 参数
• composer + 参数
• vendor/bin/<工具命令> + 参数（如 vendor/bin/phpstan）

工具使用示例

重要：若直接使用以下命令，请先在项目中创建 php_code_quality 文件夹，用于存放工具运行结果。可根据需求修改路径。

内存问题处理：若工具提示内存不足，可通过 -d 标志调整PHP内存限制（镜像默认已设置为512M，以下为极端情况示例）：

bash
php -d memory_limit=1G

PHPStan（静态分析）

详细使用文档：PHPStan Documentation

bash
docker run -it --rm --name php-code-quality -v "$PWD":/usr/src/myapp -w /usr/src/myapp \
adamculp/php-code-quality:latest sh -c 'php /usr/local/lib/php-code-quality/vendor/bin/phpstan \
 analyse -l 0 --error-format=table > ./php_code_quality/phpstan_results.txt .'

PHP Codesniffer (phpcs)（代码规范检查）

详细使用文档：https://github.com/squizlabs/PHP_CodeSniffer/wiki

以下命令使用PSR-12标准（默认使用PEAR标准）：

bash
docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --standard=PSR12 \
 --extensions=php --ignore=vendor --report-file=./php_code_quality/codesniffer_results.txt .

PHPCompatibility（PHP版本兼容性检查）

结合PHP Codesniffer使用，详细文档：https://github.com/PHPCompatibility/PHPCompatibility%E3%80%81https://github.com/squizlabs/PHP_CodeSniffer/wiki

需先加载PHPCompatibility规则：

bash
docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest sh -c \
'php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --config-set installed_paths  /usr/local/lib/php-code-quality/vendor/phpcompatibility/php-compatibility && \
php /usr/local/lib/php-code-quality/vendor/bin/phpcs -sv --standard='PHPCompatibility' --extensions=php --ignore=vendor \
--report-file=./php_code_quality/phpcompatibility_results.txt .'

PHPLoc（代码行数统计）

详细使用文档：https://github.com/sebastianbergmann/phploc

bash
docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phploc  \
--exclude vendor . > ./php_code_quality/phploc.txt

PHPMD（代码异味检测）

注意：当前工具可能存在错误，详见 https://github.com/phpmd/phpmd/issues/919%E3%80%82

详细使用文档：https://github.com/phpmd/phpmd

bash
docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpmd . xml codesize --exclude 'vendor' \
--reportfile './php_code_quality/phpmd_results.xml'

Pdepend（代码依赖分析）

注意：当前工具可能存在错误，详见 https://github.com/phpmd/phpmd/issues/919%EF%BC%9B%E5%8F%AF%E8%83%BD%E9%9C%80%E8%A6%81Tidelift%E8%AE%A2%E9%98%85%E3%80%82

详细使用文档：PDepend Docs

bash
docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/pdepend --ignore='vendor' \
--summary-xml='./php_code_quality/pdepend_output.xml' \
--jdepend-chart='./php_code_quality/pdepend_chart.svg' \
--overview-pyramid='./php_code_quality/pdepend_pyramid.svg' .

PHPCPD（复制粘贴检测）

详细使用文档：https://github.com/sebastianbergmann/phpcpd

bash
docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpcpd . \
--exclude 'vendor' > ./php_code_quality/phpcpd_results.txt

PHPMetrics（代码指标分析）

详细使用文档：PHPMetrics

bash
docker run -it --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp adamculp/php-code-quality:latest \
php /usr/local/lib/php-code-quality/vendor/bin/phpmetrics --excluded-dirs 'vendor' \
--report-html=./php_code_quality/metrics_results .

本地构建镜像

若需自定义PHP版本或工具版本，可克隆仓库并本地构建镜像：

克隆仓库

bash
git clone https://github.com/adamculp/php-code-quality.git
cd php-code-quality

修改Dockerfile（可选）

根据需求调整Dockerfile中的PHP版本或工具版本。

构建镜像

bash
docker build -t adamculp/php-code-quality .

或直接拉取仓库构建（无需克隆）：

bash
docker build -t adamculp/php-code-quality https://github.com/adamculp/php-code-quality.git

提示

若觉得本镜像有帮助，欢迎在 https://hub.docker.com/repository/docker/adamculp/php-code-quality%E3%80%81https://github.com/adamculp/php-code-quality/pkgs/container/php-code-quality 或 https://github.com/adamculp/php-code-quality 点赞支持。