0

0

如何编写一个composer脚本来自动执行代码格式化(如PHP-CS-Fixer)?

下次还敢

下次还敢

发布时间:2025-11-14 19:15:06

|

919人浏览过

|

来源于php中文网

原创

通过 Composer 集成 PHP-CS-Fixer 可自动格式化代码,首先安装工具为开发依赖,接着在项目根目录配置 .php-cs-fixer.dist.php 定义规则,然后在 composer.json 中添加 scripts,如 "format" 手动执行格式化,"post-install-cmd" 和 "post-update-cmd" 在安装或更新依赖后自动触发格式化,推荐使用 vendor/bin/php-cs-fixer 确保路径一致,还可设置 "check-format" 脚本用于 CI 环境中检测格式问题而不修改文件,从而统一团队代码风格并融入日常开发流程。

如何编写一个composer脚本来自动执行代码格式化(如php-cs-fixer)?

要在 Composer 中自动执行代码格式化(如使用 PHP-CS-Fixer),你可以通过定义脚本钩子,在执行 Composer 命令时自动触发格式化工具。以下是具体实现步骤。

安装 PHP-CS-Fixer

推荐将 PHP-CS-Fixer 作为项目依赖或开发依赖安装,确保团队成员环境一致:

composer require --dev friendsofphp/php-cs-fixer

这会把工具安装到 vendor/bin 目录下,可通过 ./vendor/bin/php-cs-fixer 调用。

配置 PHP-CS-Fixer 规则

在项目根目录创建 .php-cs-fixer.dist.php 文件,定义代码规范

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

// .php-cs-fixer.dist.php
$finder = PhpCsFixer\Finder::create()
    ->in(__DIR__ . '/src')
    ->in(__DIR__ . '/tests');

return PhpCsFixer\Config::create()
    ->setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'no_unused_imports' => true,
    ])
    ->setFinder($finder);

这个配置会针对 srctests 目录应用 PSR-12 等规则。

在 composer.json 中定义脚本

编辑 composer.json,添加自定义脚本和钩子:

TemPolor
TemPolor

AI音乐生成器,一键创作免版税音乐

下载
"scripts": {
    "format": "php-cs-fixer fix",
    "post-update-cmd": "php-cs-fixer fix",
    "post-install-cmd": "php-cs-fixer fix"
}

说明:

  • format:手动运行格式化:composer format
  • post-install-cmdpost-update-cmd:每次执行 composer installcomposer update 后自动格式化代码

如果全局未安装 php-cs-fixer,建议改用 vendor 路径:

"scripts": {
    "format": "vendor/bin/php-cs-fixer fix",
    "post-install-cmd": "vendor/bin/php-cs-fixer fix"
}

可选:仅检查不修复

若只想在 CI 环境中检查格式问题,可添加一个只检测的命令:

"scripts": {
    "check-format": "vendor/bin/php-cs-fixer fix --dry-run --diff"
}

这个命令不会修改文件,但会输出哪些文件不符合规范,适合集成到 Git Hooks 或 CI/CD 流程中。

基本上就这些。通过 Composer 脚本集成 PHP-CS-Fixer,能有效保证团队代码风格统一,且无需额外配置即可在常规开发流程中自动执行。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

156

2023.12.25

json数据格式
json数据格式

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

424

2023.08.07

json是什么
json是什么

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

537

2023.08.23

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

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

313

2023.10.13

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

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

77

2025.09.10

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

844

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

437

2024.06.27

require的用法
require的用法

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

467

2023.11.27

go语言 注释编码
go语言 注释编码

本专题整合了go语言注释、注释规范等等内容,阅读专题下面的文章了解更多详细内容。

30

2026.01.31

热门下载

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

精品课程

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

共137课时 | 10.7万人学习

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号