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 执行脚本时的上下文与手动执行不一致,尤其是相对路径和命令查找逻辑。

BiLin AI
BiLin 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 影响。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

162

2023.12.25

json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

82

2025.09.10

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1570

2023.10.24

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

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

共137课时 | 13.5万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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