domw/phpcs

包含Magento 2代码质量规则集的phpcs Docker镜像

https://hub.docker.com/r/domw/phpcs

镜像概述和主要用途

该Docker镜像基于phpcs（PHP Code Sniffer）构建，集成了Magento 2官方代码质量规则集，用于对Magento 2项目代码进行自动化风格检查和质量分析，帮助开发团队确保代码符合Magento 2编码标准，提升代码质量和一致性。

核心功能和特性

• 预集成Magento 2代码质量规则集，无需额外配置
• 支持多种报告格式（full、summary、gitblame等）
• 可自定义检查参数（如忽略警告、指定文件扩展名等）
• 轻量级设计，易于集成到本地开发和CI/CD流程
• 提供多版本标签（如latest、7.1-cli）满足不同环境需求

使用场景和适用范围

• Magento 2模块开发过程中的代码风格验证
• 自定义主题（特别是phtml文件）的代码质量检查
• CI/CD流水线中的自动化代码质量门禁
• 团队协作中的代码规范一致性维护
• 代码审查前的本地自检

构建镜像

bash
# 登录Docker Hub
docker login

# 构建并推送latest标签镜像
docker build -t domw/phpcs:latest ./
docker push domw/phpcs:latest

# 构建并推送7.1-cli标签镜像
docker build -t domw/phpcs:7.1-cli ./
docker push domw/phpcs:7.1-cli

测试镜像

bash
# 运行基础测试
docker-compose run --rm phpcs

# 查看已安装的规则集
docker-compose run --rm phpcs -i

使用方法

拉取镜像

bash
docker pull domw/phpcs

基本用法示例

bash
# 查看phpcs版本
docker run --rm -v $PWD:/code domw/phpcs phpcs --version

# 查看已安装的规则集
docker run --rm -v $PWD:/code domw/phpcs phpcs -i

# 检查指定代码路径
docker run --rm -v $PWD:/code domw/phpcs phpcs /path/to/code

使用Magento 2规则集检查

bash
# 使用Magento 2标准检查代码
docker run --rm -v $PWD:/code domw/phpcs phpcs --standard=Magento2 /path/to/code

# 生成多种格式报告
docker run --rm -v $PWD:/code domw/phpcs phpcs --standard=Magento2 --report=full,summary,gitblame /path/to/code

# 忽略警告并使用彩色输出
docker run --rm -v $PWD:/code domw/phpcs phpcs --colors --warning-severity=0 --standard=Magento2 --report=full,summary,gitblame /path/to/code

# 指定文件扩展名检查
docker run --rm -v $PWD:/code domw/phpcs phpcs --colors --warning-severity=0 --standard=Magento2 --report=full,summary --extensions=php,phtml /path/to/code

Gitlab CI集成

在Gitlab CI流水线中添加代码风格检查阶段：

yaml
stages:
  - code-style

phpcs-magento2:
  image: domw/phpcs
  stage: code-style
  tags:
    - docker
  script:
    - phpcs --version
    - phpcs -i
    - phpcs --colors --standard=Magento2 --warning-severity=0 --report=full,summary,gitblame /builds/vendor/module/path/to/code/
    - phpcs --colors --standard=Magento2 --warning-severity=0 --report=full,summary,gitblame /builds/vendor/module/app/design/frontend/Theme/