0

0

composer怎么配置自动化代码风格检查_composer引入php-cs-fixer【教程】

裘德小鎮的故事

裘德小鎮的故事

发布时间:2025-12-30 16:28:02

|

422人浏览过

|

来源于php中文网

原创

执行 composer require --dev friendsofphp/php-cs-fixer 自动添加至 require-dev;创建 .php-cs-fixer.php 配置文件限定扫描 src/ 和 tests/ 目录。

composer怎么配置自动化代码风格检查_composer引入php-cs-fixer【教程】

composer.json 里怎么加 php-cs-fixer 作为 dev 依赖

直接运行命令就能装好,不用手动改 composer.json

composer require --dev friendsofphp/php-cs-fixer
这会自动写入 "friendsofphp/php-cs-fixer": "^3.55"(版本号随时间更新)到 require-dev 区块。注意别漏掉 --dev,否则它会进生产依赖,部署时可能被误删或触发不必要的 autoload。

怎么让 php-cs-fixer 检查时只扫 src/ 和 tests/ 目录

默认它会扫整个项目,包括 vendor/var/logs/,不仅慢还可能报错。必须显式限定路径或用配置排除干扰项:
在项目根目录建 .php-cs-fixer.php,内容如下:

setRiskyAllowed(true)
    ->setRules([
        '@Symfony' => true,
        'array_syntax' => ['syntax' => 'short'],
        'no_unused_imports' => true,
    ])
    ->setFinder(
        PhpCsFixer\Finder::create()
            ->in(['src', 'tests'])
            ->name('*.php')
            ->notName('*.blade.php') // Laravel 模板跳过
            ->ignoreVCSIgnored(true)
    );

关键点:
->in(['src', 'tests']) 是白名单,比 ->exclude() 更可靠
->notName() 防止误处理模板文件
ignoreVCSIgnored(true) 尊重 .gitignore,比如跳过 storage/framework/views/

怎么把代码风格检查变成 git commit 前自动执行

composer scripts + husky 或纯 Git hook 都行,但最轻量的是用 Composer 自带的脚本机制 + Git 的 pre-commit hook:
1. 在 composer.json"scripts" 下加一条:

"cs-check": "php-cs-fixer fix --dry-run --diff"

2. 然后在项目根目录建 .git/hooks/pre-commit(需可执行):

立即学习PHP免费学习笔记(深入)”;

知了zKnown
知了zKnown

知了zKnown:致力于信息降噪 / 阅读提效的个人知识助手。

下载
#!/bin/sh
if ! composer cs-check; then
  echo "❌ PHP 代码风格不合规,请先运行:composer cs-fix"
  exit 1
fi

3. 再加个快捷修复命令方便本地调试:

"cs-fix": "php-cs-fixer fix --verbose"

注意:
--dry-run --diff 只检查不改写,适合 CI 或 pre-commit
--verbose 能看到具体哪些文件被改了,避免“静默修复”导致意外变更
• 不要用 php-cs-fixer --config=.php-cs-fixer.php 显式指定配置——只要配置文件名是默认的,它会自动加载

为什么 php-cs-fixer 有时不报错但实际没生效

常见原因有三个:
composer install 后没生成 vendor/bin/php-cs-fixer 可执行文件(检查 vendor/bin/ 是否存在该文件,没有就删掉 vendor/ 重装)
• 配置文件名写成 .php_csphp-cs-fixer.php(正确的是 .php-cs-fixer.php,开头带点)
• PHP 版本不匹配:php-cs-fixer v3 要求 PHP ≥ 8.0,如果用的是 PHP 7.4,得降级到 v2:composer require --dev friendsofphp/php-cs-fixer:^2.21,且配置写法不同(v2 用 PhpCsFixer\Config::create()

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

154

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

419

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

466

2023.11.27

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

724

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

554

2023.07.06

Golang 网络安全与加密实战
Golang 网络安全与加密实战

本专题系统讲解 Golang 在网络安全与加密技术中的应用,包括对称加密与非对称加密(AES、RSA)、哈希与数字签名、JWT身份认证、SSL/TLS 安全通信、常见网络攻击防范(如SQL注入、XSS、CSRF)及其防护措施。通过实战案例,帮助学习者掌握 如何使用 Go 语言保障网络通信的安全性,保护用户数据与隐私。

0

2026.01.29

热门下载

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

精品课程

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

共137课时 | 10万人学习

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

共6课时 | 11.2万人学习

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

共13课时 | 0.9万人学习

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

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