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

PathFinder
PathFinder

AI驱动的销售漏斗分析工具

下载

检查某个文件是否符合 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 配置文件,示例:

<?xml version="1.0"?>
<ruleset name="MyProject">
  <description>My project coding standard</description>
  <rule ref="PSR12"/>
  <exclude-pattern>*/tests/*</exclude-pattern>
</ruleset>

之后直接运行 ./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(自动修复部分问题)

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

340

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

293

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

773

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

385

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

141

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

85

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

80

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

540

2026.03.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

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

精品课程

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

共137课时 | 13.5万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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