0

0

如何让Composer在执行 update 后自动运行代码风格检查? (post-update-cmd脚本)

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-01-13 02:05:21

|

927人浏览过

|

来源于php中文网

原创

post-update-cmd 脚本在 composer update 成功后自动执行,用于代码风格检查(如 php-cs-fixer --dry-run),不触发于 install 或 require;需配置在 composer.json 的 scripts 中,推荐使用 vendor/bin/php-cs-fixer 显式路径并加 --dry-run 防误改源码。

如何让composer在执行 update 后自动运行代码风格检查? (post-update-cmd脚本)

post-update-cmd 脚本能做什么

post-update-cmd 是 Composer 提供的脚本钩子,在 composer update 成功执行完依赖更新后自动触发。它不运行在 install 阶段,也不保证每次 require 都执行——只响应 update。如果你希望每次拉取新依赖后立刻检查代码风格(比如用 php-cs-fixerphpcbf),这个钩子是合理入口。

composer.json 中配置 post-update-cmd

直接在 composer.json"scripts" 字段里添加命令即可。注意:Composer 默认会把当前项目根目录设为工作目录,所以路径都基于项目根来写。

  • 确保已全局或本地安装了代码检查工具,例如:composer require --dev friendsofphp/php-cs-fixer
  • 命令必须可被 shell 直接执行;如果使用相对路径或自定义二进制,请用 vendor/bin/php-cs-fixer 这类显式路径
  • 建议加 --quiet 或重定向输出,避免干扰 update 的正常日志流
{
    "scripts": {
        "post-update-cmd": [
            "@php vendor/bin/php-cs-fixer fix --dry-run --verbose",
            "echo \"Code style check completed.\""
        ]
    }
}

为什么 --dry-run 很关键

默认开启 --dry-run 是防止 update 过程中意外修改源码。一旦发现风格问题,CI 或本地开发能立刻感知,但不会自动覆盖文件。若想自动修复,需改成 fix(无 --dry-run),但要注意:

  • 自动修复可能改变语义(尤其涉及空格、换行、数组语法等),和团队约定冲突
  • Git 会把修复后的文件标为已修改,容易误提交
  • 某些规则(如 native_function_invocation)在 PHP 版本切换时行为不稳定

更稳妥的做法是:仅用 --dry-run 报错,再配合 Git hooks 或 CI 流程做拦截。

Elser AI Comics
Elser AI Comics

一个免费且强大的AI漫画生成工具,助力你三步创作自己的一出好戏

下载

常见失败原因和绕过方式

执行失败时,composer update 默认会继续完成,除非你显式设置 "script-error": "error"。但更常遇到的是路径或权限问题:

  • sh: vendor/bin/php-cs-fixer: not found → 检查是否在 require-dev 中声明,且 vendor/bin/ 是否存在该文件(Windows 下可能是 .bat
  • PHP 版本不匹配导致 php-cs-fixer 启动报错 → 在脚本前加版本检测,例如:php -v | grep -q '8\.2' && vendor/bin/php-cs-fixer fix ...
  • 某些 IDE 或 CI 环境禁用了 shell 扩展 → 改用 PHP 脚本封装,通过 "php scripts/check-style.php" 调用

钩子本身不支持传参,也不推荐在其中启动长时间任务(如全量扫描 + 格式化整个 vendor/)。聚焦在 src/tests/ 就够了。

相关专题

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

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

2490

2023.09.01

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

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

1592

2023.10.11

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

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

1485

2023.10.11

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

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

952

2023.10.23

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

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

1414

2023.10.23

html怎么上传
html怎么上传

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

1234

2023.11.03

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

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

1445

2023.11.09

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

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

1305

2023.11.13

php与html混编教程大全
php与html混编教程大全

本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

3

2026.01.13

热门下载

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

精品课程

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

共137课时 | 8.5万人学习

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

共6课时 | 6.9万人学习

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

共13课时 | 0.9万人学习

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

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