想在Composer中集成代码格式化?利用Scripts绑定PHP-CS-Fixer

胖辰酱_3416

胖辰酱_3416

2026-06-20

842人浏览

原创

能,但必须确保 php-cs-fixer 可执行——需本地安装(composer require --dev friendsofphp/php-cs-fixer)并用 vendor/bin/php-cs-fixer 显式调用,避免 path 依赖和 ci/cd 不一致。

想在composer中集成代码格式化?利用scripts绑定php-cs-fixer

Composer scripts 能不能直接运行 PHP-CS-Fixer?

能,但必须确保 php-cs-fixer 可执行——它得是全局安装、项目本地安装,或通过 vendor/bin/php-cs-fixer 显式调用。Composer 的 scripts 本身不解析 PATH,只按字面执行命令,所以写成 "cs-fix": "php-cs-fixer fix" 很可能报 Command "php-cs-fixer" not found。

  • 推荐始终用 vendor/bin/php-cs-fixer,哪怕已全局安装——避免 CI/CD 环境不一致
  • 如果项目根目录没有 php-cs-fixer,先运行 composer require --dev friendsofphp/php-cs-fixer
  • 脚本中加 --dry-run 和 --diff 参数便于预览,例如:"cs-check": "vendor/bin/php-cs-fixer fix --dry-run --diff"

怎么让 fix 命令只处理 src/ 和 tests/ 目录?

直接在 script 命令里传路径参数即可,php-cs-fixer 原生支持多路径。别依赖 .php-cs-fixer.php 配置文件里的 Finder 过滤来“限制作用域”——那只是配置规则适用范围,不阻止命令扫描其他目录。

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
  • 正确写法:"cs-fix": "vendor/bin/php-cs-fixer fix src/ tests/"
  • 若要排除某些子目录(如 src/Generated/),加 --exclude:fix src/ tests/ --exclude=Generated
  • 注意路径结尾不带斜杠也能工作,但带斜杠更明确;相对路径以 Composer 执行位置(通常是项目根)为基准

pre-commit hook 用 Composer script 还是直接调用 php-cs-fixer?

用 Composer script 更可靠。Git hook 脚本里如果直接写 php-cs-fixer,CI 或新开发者 clone 后很可能失败;而 composer run cs-fix 自动继承项目依赖和配置,且可统一维护。

  • 推荐在 .git/hooks/pre-commit 中写:
    #!/bin/sh<br>composer run cs-fix --no-interaction || exit 1
  • --no-interaction 防止交互式提示卡住提交流程
  • 若需只格式化暂存区文件,改用 git diff --cached --name-only --diff-filter=ACM | xargs vendor/bin/php-cs-fixer fix,但该逻辑不适合塞进 Composer script,建议单独写 shell 小脚本再由 script 调用

为什么 .php-cs-fixer.php 配置没生效?

常见原因是配置文件名或位置不对。php-cs-fixer 默认只认项目根目录下的 .php-cs-fixer.php 或 php-cs-fixer.php,不会向上递归查找父目录,也不读 php-cs-fixer.dist.php(除非显式用 --config 指定)。

  • 检查文件是否真在项目根目录,且名字是 .php-cs-fixer.php(开头带点)
  • 配置中返回的 Finder 实例必须调用 in() 明确指定目录,否则规则不应用到任何文件
  • 运行时加 -v 参数看调试输出:vendor/bin/php-cs-fixer -v fix src/,它会打印加载了哪个配置、匹配了多少文件
实际集成中最容易被忽略的是:Composer script 的工作目录就是 composer.json 所在位置,但 php-cs-fixer 的配置文件加载、路径参数解析、Finder::in() 的相对路径基准,三者默认都以此为根——一旦混用绝对路径、符号链接或 IDE 内置终端切换了 pwd,行为就会不一致。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

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

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

下载

相关标签:

composer php

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.09.01

9744

6

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

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

2023.10.11

5841

5

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

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

2023.10.11

2055

5

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

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

2023.10.23

3648

4

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

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

2023.10.23

4334

6

html怎么上传
html怎么上传

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

2023.11.03

3391

9

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

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

2023.11.09

4837

8

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

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

2023.11.13

3782

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11782

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习