cytopia/phpcs

phpcs Docker镜像

镜像概述和主要用途

本镜像为https://github.com/squizlabs/PHP_CodeSniffer%E7%9A%84Docker%E5%8C%96%E7%89%88%E6%9C%AC%EF%BC%8C%E5%9F%BA%E4%BA%8EAlpine Linux构建，采用多阶段构建方式减小镜像体积。该镜像每晚构建并更新，支持多种稳定版本，适用于在CI/CD流程中进行PHP代码规范检查，确保代码质量和风格一致性。

可用架构：amd64、i386、arm64、arm/v7、arm/v6

核心功能和特性

• 轻量级：基于Alpine Linux，镜像体积小
• 多架构支持：兼容多种硬件架构
• 版本灵活：提供多个PHPCS版本（2.x.x、3.x.x、latest）和PHP版本（5.6至8.1）的组合
• 持续更新：每晚自动构建，确保组件为最新稳定版
• 易于集成：可直接用于本地开发或CI/CD流程

可用Docker镜像版本

滚动发布版本

以下Docker镜像标签为滚动发布版，每晚构建更新：

特定时间点发布版本

以下Docker镜像标签为一次性构建，适用于可重复构建场景，版本固定：

其中 <tag> 指本仓库的Git标签。

Docker挂载点

容器内的工作目录为 /data/，需将本地目录挂载至此路径以进行代码检查。

使用方法和配置说明

基本用法

bash
$ docker run --rm -v $(pwd):/data cytopia/phpcs .

----------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 2 | ERROR | [ ] Missing file doc comment
 5 | ERROR | [x] First condition of a multi-line IF statement must
   |       |     directly follow the opening parenthesis
 6 | ERROR | [x] Line indented incorrectly; expected at least 4
   |       |     spaces, found 1
 6 | ERROR | [x] Closing brace must be on a line by itself
----------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------

自定义代码规范

自定义代码规范需挂载到容器内的 /usr/bin/CodeSniffer.conf：

命令行方式：

bash
$ docker run --rm -v $(pwd):/data -v CodeSniffer.conf:/usr/bin/CodeSniffer.conf cytopia/phpcs .

Docker Compose配置：

yaml
phpcs:
  image: cytopia/phpcs
  volumes:
    - .:/data
    - CodeSniffer.conf:/usr/bin/CodeSniffer.conf

许可证

MIT License

Copyright (c) 2019 https://github.com/cytopia