iserv/phpstan

用于IServ环境的PHPStan集成镜像

镜像概述

本Docker镜像专为IServ环境设计，集成了PHPStan静态代码分析工具，旨在为IServ系统中的PHP应用开发提供便捷的代码质量检测方案。PHPStan作为强大的PHP静态分析工具，可在不执行代码的情况下检测潜在错误、类型不匹配、未定义方法等问题，本镜像通过针对IServ环境的适配优化，确保在该特定环境下的兼容性和易用性。

核心功能与特性

PHPStan核心功能

• 静态代码分析：通过语法解析和类型推断，检测PHP代码中的语法错误、逻辑缺陷及潜在bug
• 代码质量检测：支持多种分析级别（1-9级），从基础错误检测到严格类型检查
• 可扩展规则：支持自定义规则和第三方规则集，满足特定项目的代码规范要求
• 详细报告输出：生成清晰的错误报告，包含错误位置、类型及修复建议

IServ环境适配特性

• 环境兼容性：针对IServ系统的运行环境（如PHP版本、依赖库）进行预配置，确保即装即用
• 轻量级设计：基于官方PHP镜像构建，最小化镜像体积，减少IServ资源占用
• 灵活配置支持：通过环境变量和挂载配置文件实现自定义分析规则，适配IServ项目结构

使用场景

开发阶段代码检测

• IServ平台下PHP应用开发过程中，本地开发环境集成，实时检测代码质量
• 团队协作场景中，确保提交代码符合项目规范，减少代码评审成本

CI/CD流程集成

• 集成到IServ环境的CI/CD流水线，在代码提交或部署前自动执行静态分析，阻断不合格代码流入生产
• 与IServ的版本控制系统（如Git）联动，触发提交后自动检测

项目维护与重构

• 对IServ现有PHP项目进行代码重构时，通过静态分析确保重构过程中的代码安全性
• 定期执行全量代码分析，监控项目整体代码质量变化趋势

使用方法与配置说明

基本使用命令

通过docker run命令快速启动分析，需挂载待分析的PHP代码目录到容器内的/app路径：

bash
docker run --rm -v /path/to/iserv-php-project:/app iserv-phpstan:latest analyze /app

说明：--rm参数确保容器退出后自动清理；-v挂载本地项目目录到容器内/app；analyze /app指定对/app目录执行分析

自定义分析配置

指定分析级别

通过PHPSTAN_LEVEL环境变量设置分析级别（默认5级，1级最宽松，9级最严格）：

bash
docker run --rm -e PHPSTAN_LEVEL=7 -v /path/to/project:/app iserv-phpstan:latest analyze /app

挂载自定义配置文件

使用项目内的phpstan.neon（或phpstan.neon.dist）配置文件，需将配置文件挂载到容器内/etc/phpstan.neon：

bash
docker run --rm \
  -v /path/to/project:/app \
  -v /path/to/project/phpstan.neon:/etc/phpstan.neon \
  iserv-phpstan:latest analyze /app --configuration /etc/phpstan.neon

排除指定目录

通过IGNORE_PATHS环境变量定义需排除的目录（逗号分隔多个路径）：

bash
docker run --rm \
  -e IGNORE_PATHS=/app/vendor,/app/tests \
  -v /path/to/iserv-php-project:/app \
  iserv-phpstan:latest analyze /app

Docker Compose集成配置

在IServ项目中创建docker-compose.yml文件，简化多参数场景下的使用：

yaml
version: '3.8'
services:
  phpstan:
    image: iserv-phpstan:latest
    volumes:
      - ./:/app  # 挂载当前项目目录到容器/app
      - ./phpstan.neon:/etc/phpstan.neon  # 挂载项目自定义配置
    environment:
      - PHPSTAN_LEVEL=6  # 设置分析级别为6
      - ANALYZE_PATH=/app/src  # 指定仅分析src目录
    command: analyze ${ANALYZE_PATH} --configuration /etc/phpstan.neon

启动分析：

bash
docker-compose run --rm phpstan

常用环境变量说明

高级配置：自定义PHPStan规则

如需扩展分析规则（如集成phpstan/phpstan-symfony等第三方规则），可通过构建自定义Dockerfile基于本镜像扩展：

dockerfile
FROM iserv-phpstan:latest

# 安装Symfony框架规则集
RUN composer require --dev phpstan/phpstan-symfony

# 添加自定义规则配置
COPY custom-rules.neon /etc/custom-rules.neon

构建并使用自定义镜像：

bash
docker build -t iserv-phpstan-custom:latest .
docker run --rm -v /path/to/project:/app iserv-phpstan-custom:latest analyze /app --configuration /etc/custom-rules.neon