Pipeline Components: PHP Codesniffer

镜像状态

• 镜像大小：
• Docker 拉取量：

镜像概述

该镜像用于运行 PHP Codesniffer，工具安装在 /app/ 目录下，方便使用前进行自定义配置。默认已安装以下包：

• squizlabs/php_codesniffer
• phpcompatibility/php-compatibility
• dealerdirect/phpcodesniffer-composer-installer

核心功能

• 提供 PHP 代码规范检查能力，支持多种代码标准
• 内置 PSR 系列代码规范检查（通过 squizlabs/php_codesniffer）
• 支持 PHP 版本兼容性检查（通过 phpcompatibility/php-compatibility）
• 集成 Composer 安装器，简化代码规范标准的管理（通过 dealerdirect/phpcodesniffer-composer-installer）

使用场景

• CI/CD 流程中的代码 linting 阶段，确保代码符合团队规范
• 检查代码是否符合 PSR2 等行业通用代码规范
• 验证代码对特定 PHP 版本的兼容性（如 PHP 7.3）

使用方法

GitLab CI 配置示例

示例 1：检查 PSR2 规范

yaml
phpcs PSR2:
  stage: linting
  image: registry.gitlab.com/pipeline-components/php-codesniffer:latest
  script:
    - phpcs -s -p --colors --extensions=php --standard=PSR2 .

示例 2：检查 PHP 7.3 兼容性

yaml
php-compatibility 7.3:
  stage: test
  image: registry.gitlab.com/pipeline-components/php-codesniffer:latest
  variables:
    PHPVERSION: "7.3"
  script:
    - >-
      phpcs -s -p --colors
      --standard=PHPCompatibility
      --extensions=php
      --runtime-set testVersion ${PHPVERSION} .

环境变量

• PHPVERSION：指定要检查的目标 PHP 版本，用于兼容性检查（如示例 2 中的 "7.3"）

版本控制

本项目采用 语义化版本控制 进行版本编号。

支持

如有问题：

• 可查看 *** 频道
• 或 提交 issue

贡献

这是一个活跃的开源项目，欢迎使用或贡献代码。贡献指南详见 贡献指南文档。

作者与贡献者

本仓库最初由 Robbert Müller 搭建。构建流程主要基于 Community Hass.io Add-ons（作者：Franck Nijhof）。完整作者和贡献者列表见 贡献者页面。

许可协议

本项目采用 MIT 许可协议（作者：Robbert Müller）。