skilldlabs/docker-phpcs-drupal

docker-phpcs-drupal

镜像概述

docker-phpcs-drupal是一个集成了PHP Code Sniffer (phpcs) 和 PHP Code Beautifier and Fixer (phpcbf) 的Docker镜像，专门用于Drupal项目的代码规范检查与修复。该镜像旨在帮助开发者便捷地确保代码符合Drupal编码标准，提升代码质量和一致性。

核心功能与特性

• 默认支持phpcs：容器默认执行phpcs命令，检查指定目录下的代码是否符合Drupal编码标准
• 支持phpcbf修复：可通过覆盖默认命令调用phpcbf，自动修复代码格式问题
• 便捷挂载目录：通过挂载本地目录到容器，直接检查项目代码，无需在本地安装相关工具

使用场景

• Drupal模块或主题开发过程中的代码规范检查
• 持续集成/持续部署(CI/CD)流程中集成代码规范验证步骤
• 团队协作中确保代码风格统一，符合Drupal社区编码标准

使用方法与配置说明

基本使用步骤

1. 进入待检查目录
   切换到需要进行代码规范检查的Drupal模块或文件所在目录：

   bash
   cd /path/to/your/drupal/module
   

2. 默认运行phpcs检查
   执行以下命令，容器将默认运行phpcs检查当前目录下的代码：

   bash
   docker run --rm -v $(pwd):/work skilldlabs/docker-phpcs-drupal
   

   • --rm：容器退出后自动删除，避免残留容器文件
   • -v $(pwd):/work：将当前目录挂载到容器内的/work目录，作为检查目标

3. 运行phpcbf自动修复
   如需自动修复代码格式问题，可覆盖默认命令，显式调用phpcbf：

   bash
   docker run --rm -v $(pwd):/work skilldlabs/docker-phpcs-drupal phpcbf --standard=Drupal ./
   

   • phpcbf：PHP代码格式化修复工具
   • --standard=Drupal：指定使用Drupal编码标准
   • ./：表示检查并修复当前目录下的所有文件

自定义配置

可通过在命令中添加参数自定义检查范围或标准，例如指定特定文件或子目录：

bash
# 检查特定文件
docker run --rm -v $(pwd):/work skilldlabs/docker-phpcs-drupal phpcs --standard=Drupal ./src/MyFile.php

# 检查子目录
docker run --rm -v $(pwd):/work skilldlabs/docker-phpcs-drupal phpcs --standard=Drupal ./modules/custom/