Composer脚本怎么定义_Composer scripts运行自定义命令【脚本】

5次阅读

脚本定义必须放在 composer.json 顶层 scripts 对象中,支持字符串、字符串数组(各元素需双引号)或 php 回调(如 “myclass::mymethod”),命名即调用名;触发分自动(如 post-install-cmd)和手动(composer run-script xxx)两类;参数通过环境变量或 — 透传(shell 脚本能接收,php 回调需用 $event->getarguments() 但实际收不到 — 参数);常见错误包括路径未引号、拼写错误、工作目录变更未恢复、autoload 未加载类及非零退出码中断流程。

Composer脚本怎么定义_Composer scripts运行自定义命令【脚本】

composer.json 里 scripts 字段怎么写

脚本定义必须放在 composer.jsonscripts 对象里,不是随便加个键就行。它只认顶层的 scripts,嵌套在 extra 或其他地方无效。

常见错误是把命令写成字符串数组但没用引号包裹可执行路径,比如写成 ["php", "artisan", "optimize"] —— 这在 JSON 里会直接报错,因为 JSON 不支持数组字面量作为 script 值(Composer 只接受字符串或字符串数组,但数组元素必须是合法 JSON 字符串)。

  • 正确写法:用单个字符串(空格分隔)或字符串数组,每个元素都用双引号包住,如 "php artisan config:clear"["php", "artisan", "config:clear"]
  • 支持 PHP 回调:写成 "MyClass::myMethod",前提是类已自动加载且方法是静态的
  • 别漏掉 key 名——它就是你后面要跑的命令名,比如定义 "post-install-cmd" 就会在 composer install 后自动触发

什么时候会自动触发 scripts

Composer 有两类触发时机:一类是「事件钩子」(Event scripts),比如 pre-install-cmdpost-update-cmd;另一类是「手动调用」,用 composer run-script xxx

容易混淆的是:名字带 -cmd 的钩子(如 post-autoload-dump)只在对应 Composer 内部动作完成后运行,不是每次命令都触发。而像 pre-autoload-dump 这种,改了 autoload 配置或执行 dump-autoload 才会跑。

  • post-root-package-install 只在首次 create-project 时触发一次,不是每次 install
  • post-create-project-cmd 是旧版写法,新版推荐用 post-root-package-install
  • 自定义脚本名(如 "test")不会自动触发,必须显式执行 composer run-script test

脚本里怎么访问参数和环境

Composer 脚本本身不传参,但你可以通过环境变量或命令行参数间接控制行为。比如 composer run-script build -- --env=prod 中的 --env=prod 会被透传给脚本进程(仅限 shell 命令类脚本,PHP 回调收不到)。

PHP 回调函数接收一个 ComposerScriptEvent 对象,能拿到当前命令、IO 实例、composer 实例等。但注意:这个对象不包含用户传的额外参数,想传配置得靠环境变量或者读配置文件。

  • Shell 脚本中可用 $@ 接收透传参数,但需确保命令本身支持(比如 php deploy.php $@
  • PHP 回调里用 $event->getArguments() 拿不到 --xxx 参数,那是 Composer CLI 解析后丢弃的
  • 跨平台兼容性差:windowsbash 风格脚本基本跑不了,优先选 PHP 或 cross-env 包装

为什么脚本不执行或报错“script not found”

最常见原因是拼写错误或作用域问题:composer.json 放错位置(不在项目根目录)、脚本名含非法字符(如空格、斜杠)、或者用了未声明的二进制命令(比如直接写 npm run build 却没装 Node.js)。

另一个隐蔽坑是工作目录:Composer 默认在项目根目录执行脚本,但如果你的脚本 cd 到子目录又没切回来,后续命令可能找不到 vendor/autoload.php 或 composer.json。

  • 检查是否启用了 COMPOSER_ALLOW_SUPERUSER —— 某些脚本涉及 sudo 或权限操作时会被拦截
  • PHP 回调类未被 autoload 加载?确认 autoload 配置里包含该类路径,或先跑 composer dump-autoload
  • 脚本返回非零退出码会被 Composer 当作失败,中断后续流程(比如 post-install-cmd 失败会导致安装终止)

事情说清了就结束

text=ZqhQzanResources