aragon999/phpstan-shopware

phpstan-shopware Docker镜像文档

镜像概述和主要用途

phpstan-shopware是一个预构建的Docker镜像，集成了phpstan静态分析工具和Shopware 6运行环境，专门用于对Shopware 6插件进行代码静态分析。该镜像无需手动配置phpstan与Shopware的依赖关系，可直接检查插件代码质量，发现潜在错误、类型问题及代码规范问题，提升插件开发效率和代码可靠性。

核心功能和特性

• 预配置环境：已集成phpstan和Shopware 6核心依赖，开箱即可使用，无需额外配置
• 版本化支持：提供不同Shopware版本的镜像标签（如v6.2.0、v6.2.2），适配不同插件开发需求
• 多场景兼容：支持本地开发环境、Github Actions工作流及Gitlab CI流水线等多种使用场景
• 轻量高效：基于官方PHP镜像构建，体积小巧，分析速度快

使用场景和适用范围

• Shopware 6插件开发者在本地开发过程中进行代码质量自检
• 集成到Github Actions工作流，实现代码提交/PR时自动执行静态分析
• 配置在Gitlab CI流水线中，作为插件发布前的质量门禁检查环节

详细使用方法和配置说明

本地环境使用

在本地开发环境中，通过以下命令挂载插件目录并运行分析：

bash
docker run --rm -v /path/to/the/plugin:/app aragon999/phpstan-shopware:v6.2.0 analyze --level 5 .

参数说明：

• --rm：容器运行结束后自动删除
• -v /path/to/the/plugin:/app：将本地插件目录挂载到容器内的/app目录
• aragon999/phpstan-shopware:v6.2.0：指定镜像及Shopware版本（替换v6.2.0为所需版本）
• analyze --level 5 .：执行phpstan分析，--level 5指定分析严格级别（1-9，级别越高检查越严格），.表示分析当前目录（即挂载的插件目录）

在Github Actions中使用

通过Github Actions实现代码推送时自动运行分析，配置示例：

yaml
name: Run PHPStan

on:
  push:

jobs:
  phpstan:
    runs-on: ubuntu-latest

    steps:
      - name: Clone
        uses: actions/checkout@v2

      - name: Run PHPStan
        uses: aragon999/phpstan-shopware-docker@master

说明：

• 触发条件：代码推送（可根据需求修改on字段配置）
• 动作使用：aragon999/phpstan-shopware-docker@master默认使用最新稳定版Shopware和最新版PHPStan

在Gitlab CI中使用

在Gitlab CI流水线中配置指定Shopware版本的分析，示例：

yaml
image:
  name: aragon999/phpstan-shopware:v6.2.2
  entrypoint: [""]

lint:plugin:
  script:
    - phpstan analyze .

说明：

• image.name：指定使用Shopware v6.2.2版本的镜像（根据需求替换版本标签）
• entrypoint: [""]：覆盖默认入口点，确保脚本正常执行
• script：执行phpstan分析当前目录（插件代码所在目录）