nunomaduro/phpinsights

PHP代码质量即时检查工具镜像

概述

本Docker镜像提供了一个轻量级、容器化的PHP代码质量检查解决方案，允许开发者直接通过命令行对PHP代码进行即时质量分析。镜像内置了常用的PHP代码检查工具和规则集，无需在本地环境中配置复杂依赖，确保了跨环境检查结果的一致性。

核心功能

• 即时检查：执行命令后快速返回代码质量分析结果，无延迟
• 零配置启动：内置默认检查规则，无需额外配置即可使用
• 环境隔离：容器化运行，不干扰本地开发环境配置
• 轻量级：优化的镜像体积，快速拉取和启动
• 可移植性：支持在任何安装Docker的环境中运行，包括开发机、服务器和CI/CD系统

适用场景

• 本地开发过程中，提交代码前快速验证代码质量
• 代码审查环节，对修改文件进行针对性质量检查
• CI/CD流水线集成，作为代码合并前的自动化质量门禁
• 教学场景，帮助开发者学习和遵循PHP编码规范

使用方法

基本检查命令

检查当前目录下的PHP代码：

bash
docker run --rm -v $(pwd):/app php-quality-checker

指定检查目录

检查自定义目录下的PHP代码：

bash
docker run --rm -v /path/to/your/php/code:/app php-quality-checker

自定义检查规则

使用--standard参数指定编码规范（如PSR1、PSR2、PSR12）：

bash
docker run --rm -v $(pwd):/app php-quality-checker --standard=PSR12

生成检查报告

输出JSON格式的检查报告到文件：

bash
docker run --rm -v $(pwd):/app php-quality-checker --report=json > quality-report.json

排除指定目录

排除不需要检查的目录（如vendor、tests）：

bash
docker run --rm -v $(pwd):/app php-quality-checker --exclude=vendor,tests

常用参数说明

CI/CD集成示例

GitHub Actions配置

在.github/workflows/quality-check.yml中添加：

yaml
name: PHP Code Quality Check
on: [pull_request]

jobs:
  quality-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run PHP Quality Check
        run: docker run --rm -v $(pwd):/app php-quality-checker --standard=PSR12 --report=json

GitLab CI配置

在.gitlab-ci.yml中添加：

yaml
php_quality_check:
  stage: test
  image: php-quality-checker
  script:
    - docker run --rm -v $(pwd):/app php-quality-checker --standard=PSR12
  artifacts:
    paths:
      - quality-report.txt

注意事项

• 挂载目录时确保本地目录有读取权限，容器需要访问PHP文件
• 支持检查PHP 5.6及以上版本代码，具体版本兼容性请参考镜像标签
• 复杂项目检查可能需要增加内存限制：docker run --rm -m 512M -v $(pwd):/app php-quality-checker