如何使用Composer安装PHP CodeSniffer进行代码规范检查？（实例教程）

推荐使用 Composer 在项目本地安装 PHP_CodeSniffer（PHPCS），执行 composer require –dev squizlabs/php_codesniffer，安装后通过 ./vendor/bin/phpcs 检查代码并支持 PSR12 等标准及自定义配置。

直接用 Composer 安装 PHP CodeSniffer（PHP_CodeSniffer，简称 PHPCS）是最主流、最灵活的方式。它支持全局安装（方便多项目复用）或项目本地安装（保证版本隔离），推荐优先使用本地安装。

一、确认已安装 Composer

在终端运行以下命令检查是否可用：

composer –version

若提示“command not found”，需先 下载并安装 Composer（Windows 用户建议用 Composer-Setup.exe；macOS/Linux 可用 curl 命令安装）。

立即学习“PHP 免费学习笔记（深入）”；

二、项目内本地安装（推荐）

进入你的 PHP 项目根目录（含 composer.json），执行：

composer require –dev squizlabs/php_codesniffer

该命令会：

• 将 PHPCS 安装到 vendor/bin/phpcs 和 vendor/bin/phpcbf
• 自动写入 composer.json 的 require-dev 区域
• 确保团队成员执行 composer install 后获得一致版本

安装完成后，可直接运行：

./vendor/bin/phpcs –version（Linux/macOS）
vendorbinphpcs –version（Windows）

三、配置常用 编码 标准

PHPCS 自带多种规则集（Standard），例如：PSR12（现代 PHP 推荐）、PSR2、Squiz、Generic 等。

查看当前可用标准：

./vendor/bin/phpcs -i

检查某个文件是否符合 PSR12：

./vendor/bin/phpcs –standard=PSR12 src/MyClass.php

检查整个 src/ 目录，并显示详细错误信息：

./vendor/bin/phpcs –standard=PSR12 –report=full –report-width=120 src/

四、可选：添加自定义规则或第三方标准

例如安装 Laravel 官方风格指南：

composer require –dev laravel/pint（轻量级替代方案）
或
composer require –dev doctrine/coding-standard

安装后，可通过 --standard=Doctrine 调用。

如需自定义规则，可新建 phpcs.xml 或 phpcs.xml.dist 配置文件，示例：

  My project coding standard
  
  */tests/*

之后直接运行 ./vendor/bin/phpcs 即自动加载该配置。

五、小技巧：绑定为 Composer 脚本（更便捷）

在 composer.json 的 "scripts" 区块中添加：

"scripts": {
  “cs:check”: “phpcs –standard=PSR12 –report=full src/”,
  “cs:fix”: “phpcbf –standard=PSR12 src/”
}

然后执行：

composer cs:check（检查）
composer cs:fix（自动修复部分问题）

以上就是如何使用 Composer 安装 PHP CodeSniffer 进行代码规范检查？（实例教程）的详细内容，更多请关注