dcycle/phpstan-drupal

Dcycle PHPStan for Drupal 镜像文档

镜像概述

Dcycle PHPStan for Drupal是一个专为Drupal开发设计的Docker镜像，用于对Drupal项目的PHP代码执行静态分析。该镜像基于PHP 8环境构建，集成了PHPStan（PHP静态分析工具）和PHPStan-Drupal（Drupal专用PHPStan扩展），帮助开发者在开发阶段检测代码质量问题。

核心功能与特性

• 专业静态分析：通过PHPStan和PHPStan-Drupal的组合，针对Drupal特有的代码结构和API提供精准的静态分析能力
• PHP 8支持：运行在PHP 8环境中，兼容现代Drupal项目的PHP版本要求
• 轻量级集成：作为Docker镜像提供，无需在本地环境单独配置PHPStan及相关依赖，简化工具部署流程

使用场景

• Drupal模块开发：对自定义模块的PHP代码进行质量检查，识别潜在的语法错误、类型不匹配、未定义方法等问题
• 主题代码审查：在主题开发中验证PHP逻辑代码的规范性，确保符合Drupal编码标准
• 持续集成流程：集成到CI/CD管道中，在代码提交或构建过程中自动执行静态分析，保障代码质量

使用方法与配置说明

基本使用

该镜像的完整使用文档可参考https://github.com/dcycle/docker-phpstan-drupal%E3%80%82%E5%9F%BA%E6%9C%AC%E4%BD%BF%E7%94%A8%E9%9C%80%E5%B0%86Drupal%E9%A1%B9%E7%9B%AE%E7%9B%AE%E5%BD%95%E6%8C%82%E8%BD%BD%E5%88%B0%E5%AE%B9%E5%99%A8%E4%B8%AD%EF%BC%8C%E5%B9%B6%E6%89%A7%E8%A1%8C%E5%88%86%E6%9E%90%E5%91%BD%E4%BB%A4%E3%80%82

示例：使用docker run执行分析

bash
docker run --rm -v $(pwd):/app dcycle/phpstan-drupal:latest analyze /app/modules/custom

参数说明：

• --rm：容器运行结束后自动删除
• -v $(pwd):/app：将当前工作目录（Drupal项目根目录）挂载到容器内的/app目录
• analyze /app/modules/custom：执行静态分析命令，指定分析路径为容器内的自定义模块目录（可根据需求替换为其他目录，如/app/themes/custom）

高级配置

如需自定义分析规则、调整PHPStan配置或使用其他高级功能，请查阅https://github.com/dcycle/docker-phpstan-drupal%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E8%AF%B4%E6%98%8E%E3%80%82