0

0

composer.json中的scripts脚本怎么写_composer自定义命令与自动化执行【详解】

冰火之心

冰火之心

发布时间:2026-01-24 14:38:02

|

963人浏览过

|

来源于php中文网

原创

直接在 Composer 的 scripts 字段定义命令即可注册自定义命令,支持字符串或数组语法,需注意执行路径、环境变量传递及退出码;支持全局钩子与手动触发,参数传递需借助 $@ 或封装 PHP 脚本处理,常见问题包括路径错误、command not found 和 autoload 失败。

composer.json中的scripts脚本怎么写_composer自定义命令与自动化执行【详解】

直接写 scripts 字段就能注册自定义命令,不需要插件或额外依赖——但必须注意命令执行路径、环境变量和退出码是否被正确传递。

scripts 字段的语法和基本写法

Composer 的 scripts 是一个 JSON 对象,键是命令名(如 dev:clear),值是 shell 命令字符串或数组。它支持两种执行模式:全局钩子(如 post-install-cmd)和手动触发命令(如 composer dev:clear)。

  • 单条命令直接写字符串:"dev:clear": "php artisan cache:clear && php artisan view:clear"
  • 多条命令推荐用数组形式(更清晰,且避免 shell 解析差异):
    ["php artisan cache:clear", "php artisan view:clear"]
  • 命令中可使用 $COMPOSER_BIN_DIR$COMPOSER_HOME 等内置环境变量,但不要依赖 $PWD —— 实际工作目录可能是项目根目录,也可能是调用者所在路径

如何让自定义命令支持参数传递

Composer 本身不解析脚本参数,composer run-script xxx -- arg1 arg2 中的 -- 后内容会以 $@ 形式透传给 shell,但仅限于 shell 脚本或可执行文件;PHP 命令需自行处理 $argv

  • 纯 shell 场景(如调用 bash 脚本):"deploy:to": "bash deploy.sh $@",然后运行 composer run-script deploy:to -- staging
  • PHP 命令需显式接收:"test:group": "php vendor/bin/phpunit --group $1",但注意 $1 在 Windows cmd 下不可用,建议统一用 bash -c 'php ... $1' 或改用封装脚本
  • 更可靠的做法是写一个独立的 PHP 脚本(如 scripts/run-test.php),在 scripts 中调用它:"test:group": "php scripts/run-test.php",再由 PHP 解析 $argv

常见错误:命令不执行、报错或路径不对

多数问题源于 Composer 执行脚本时的上下文与手动执行不一致,尤其是相对路径和命令查找逻辑。

一键职达
一键职达

AI全自动批量代投简历软件,自动浏览招聘网站从海量职位中用AI匹配职位并完成投递的全自动操作,真正实现'一键职达'的便捷体验。

下载
  • command not found:默认不加载 $PATH 中的本地 bin(如 vendor/bin/xxx),应显式写全路径或用 php vendor/bin/xxx
  • “找不到类”或“autoload 失败”:确保脚本在 autoload-dev 中已声明,或先执行 composer dump-autoload
  • 权限问题(Linux/macOS):脚本文件需有执行权限(chmod +x),否则 sh: ./xxx.sh: Permission denied
  • Windows 下换行符或反斜杠问题:避免硬编码 \,优先用 / 或 PHP 的 DIRECTORY_SEPARATOR

钩子脚本(如 post-update-cmd)的执行时机和限制

钩子不是“事件监听器”,而是固定阶段的同步阻塞调用,失败会导致整个 Composer 操作中断。

  • 典型钩子:pre-install-cmdpost-update-cmdpost-autoload-dump
  • 钩子中不能交互(readline()STDIN 读取会卡住),也不能依赖未安装完成的包(post-install-cmd 时 autoload 尚未生成)
  • 若需异步或复杂逻辑,建议把主逻辑抽到独立脚本,钩子只做轻量触发:
    "post-autoload-dump": ["@php scripts/generate-config.php"]
  • 钩子默认继承当前命令的选项(如 --no-dev),但无法区分是 install 还是 update 触发的同一个钩子

真正容易被忽略的是:scripts 中的命令默认在项目根目录执行,但如果你在子目录里运行 composer run-script,它仍会跳回根目录——这个行为没法关闭,也不受 COMPOSER_HOME 影响。

相关专题

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

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

2832

2023.09.01

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

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

1696

2023.10.11

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

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

1556

2023.10.11

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

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

1058

2023.10.23

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

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

1505

2023.10.23

html怎么上传
html怎么上传

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

1256

2023.11.03

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

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

1609

2023.11.09

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

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

1307

2023.11.13

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

0

2026.01.23

热门下载

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

精品课程

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

共137课时 | 9.2万人学习

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

共6课时 | 10.4万人学习

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

共13课时 | 0.9万人学习

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

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