0

0

如何使用Composer安装PHP CodeSniffer进行代码规范检查?(实例教程)

穿越時空

穿越時空

发布时间:2025-12-19 18:29:02

|

414人浏览过

|

来源于php中文网

原创

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

如何使用composer安装php codesniffer进行代码规范检查?(实例教程)

直接用 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/phpcsvendor/bin/phpcbf
  • 自动写入 composer.jsonrequire-dev 区域
  • 确保团队成员执行 composer install 后获得一致版本

安装完成后,可直接运行:

./vendor/bin/phpcs --version(Linux/macOS)
vendor\bin\phpcs --version(Windows)

三、配置常用编码标准

PHPCS 自带多种规则集(Standard),例如:PSR12(现代 PHP 推荐)、PSR2SquizGeneric 等。

查看当前可用标准:

./vendor/bin/phpcs -i

京点点
京点点

京东AIGC内容生成平台

下载

检查某个文件是否符合 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.xmlphpcs.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(自动修复部分问题)

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2626

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1629

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1511

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1418

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1447

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

43

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.8万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 7.5万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号