texthtml/phpcs

PHPCS

镜像概述

这是用于https://github.com/squizlabs/PHP_CodeSniffer%E7%9A%84Docker%E9%95%9C%E5%83%8F%E3%80%82PHP_CodeSniffer%E6%98%AF%E4%B8%80%E6%AC%BEPHP%E4%BB%A3%E7%A0%81%E5%88%86%E6%9E%90%E5%B7%A5%E5%85%B7%EF%BC%8C%E4%B8%BB%E8%A6%81%E5%8A%9F%E8%83%BD%E6%98%AF%E6%A3%80%E6%B5%8BPHP%E4%BB%A3%E7%A0%81%E4%B8%AD%E7%9A%84%E7%BC%96%E7%A0%81%E6%A0%87%E5%87%86%E8%BF%9D%E8%A7%84%EF%BC%8C%E5%B9%B6%E6%8F%90%E4%BE%9B%E8%87%AA%E5%8A%A8%E4%BF%AE%E5%A4%8D%E8%83%BD%E5%8A%9B%EF%BC%8C%E5%B8%AE%E5%8A%A9%E5%BC%80%E5%8F%91%E8%80%85%E7%BB%B4%E6%8A%A4%E4%B8%80%E8%87%B4%E7%9A%84%E4%BB%A3%E7%A0%81%E9%A3%8E%E6%A0%BC%E3%80%82

核心功能和特性

• 代码标准检测：根据指定编码标准（如PSR2、PSR12等）扫描PHP代码，识别格式和风格违规
• 自动修复能力：通过内置的代码美化修复工具（phpcbf）自动修复部分常见的代码标准问题

使用场景和适用范围

适用于各类PHP项目，尤其适合：

• 团队开发中确保代码风格统一
• 代码提交前的本地规范检查
• CI/CD流程中集成代码质量检测环节
• 快速初始化PHP代码规范检查环境，无需本地安装依赖

使用方法和配置说明

检测代码标准违规

执行以下命令检测指定目录下PHP文件的代码标准问题：

bash
docker run -v /path/to/php/files/:/scripts/ texthtml/phpcs phpcs --standard=PSR2 /scripts/

参数说明：

• -v /path/to/php/files/:/scripts/：将本地PHP文件目录挂载到容器内/scripts/目录（需替换/path/to/php/files/为实际本地路径）
• phpcs：PHP_CodeSniffer的检测命令
• --standard=PSR2：指定检测标准（可替换为PSR1、PSR12、Squiz等其他标准）
• /scripts/：容器内待检测的文件目录（对应本地挂载目录）

修复代码标准违规

执行以下命令自动修复指定目录下PHP文件的代码标准问题：

bash
docker run -v /path/to/php/files/:/scripts/ texthtml/phpcs phpcbf --standard=PSR2 /scripts/

参数说明：

• phpcbf：PHP Code Beautifier and Fixer，PHP_CodeSniffer的自动修复命令
• 其他参数与检测命令一致，--standard需与检测时使用的标准保持一致以确保修复效果