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

下次还敢
发布: 2025-11-14 19:15:06
原创
891人浏览过
通过 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,添加自定义脚本和钩子:

一览AI编剧
一览AI编剧

创意生成+情节生成+脚本生成,AI编剧3步走,AI自动帮你搞定剧情!

一览AI编剧 87
查看详情 一览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,能有效保证团队代码风格统一,且无需额外配置即可在常规开发流程中自动执行。

以上就是如何编写一个composer脚本来自动执行代码格式化(如PHP-CS-Fixer)?的详细内容,更多请关注php中文网其它相关文章!

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

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