composer scripts脚本怎么编写_composer自动化任务配置【高级】

2次阅读

composer.json 的 “scripts” 中定义命令别名与执行逻辑,支持字符串、数组和 PHP 回调形式;需注意命名规范、事件触发时机、@ 引用机制及自定义脚本类的自动加载配置。

composer scripts脚本怎么编写_composer自动化任务配置【高级】

composer.json 里 scripts 字段怎么写才有效

直接在 composer.json"scripts" 对象里定义键值对,键是命令别名,值是具体要执行的命令或 PHP 回调。Composer 不会校验值是否合法,写错只会运行时报错或静默失败。

  • 字符串值:会被 shell 执行,支持 phpnpm、路径命令等,如 "test": "phpunit"
  • 数组值:按顺序执行多条命令,如 "post-install-cmd": ["@php script/install.php", "chmod +x bin/*"]
  • PHP 回调:用 ["MyClass::myMethod"]["php", "script.php"] 形式,必须可被自动加载或显式 require
  • 脚本名不能含空格,推荐用短横线分隔,如 build:assets,避免 build assets(会被拆成两个命令)

如何触发 post-autoload-dump 后自动清理旧的 classmap 缓存

这个事件在 composer installcomposer update 生成新 autoloader 后触发,适合做依赖变更后的清理或预热。但要注意:它不保证 vendor 已完全就绪(比如某些插件可能还没复制完),也不在 composer dump-autoload 单独运行时触发(除非加 --optimize)。

  • "scripts" 中添加:"post-autoload-dump": "rm -f var/cache/classmap.php"
  • 若用 PHP 脚本,需确保该文件能被当前 autoloader 加载(推荐放 scripts/ 下并加到 "autoload-dev""psr-4"
  • windows 用户慎用 rm,改用 del 或跨平台 PHP 实现:["php", "-r", "unlink('var/cache/classmap.php');"]

scripts 中调用其他 script 别名要用 @ 符号前缀

想复用已有脚本逻辑,比如测试前先构建资产,不能直接写 "test": "npm run build && phpunit",而应优先用 @ 引用,这样 Composer 会统一处理环境、错误传播和事件钩子。

  • 正确写法:"test": ["@build:assets", "phpunit"]
  • @ 只能引用同级 script 名,不支持带参数(如 @dev:server --port=8080 会报错)
  • 嵌套过深(比如 A → B → C → A)会导致循环检测失败,报 Script xxx is looping
  • 如果被引用的 script 返回非零退出码,整个链会中断,除非加 || true 显式忽略(不推荐)

自定义脚本类怎么注册才能被 Composer 识别

写一个 PHP 类处理复杂逻辑(比如读取配置、发 http 请求、生成文件),需要满足两个条件:类可被自动加载,且方法是 public Static。Composer 不会实例化对象,只调静态方法。

  • 示例类:
    class BuildHelper {     public static function compileAssets($event)     {         $vendorDir = $event->getComposer()->getConfig()->get('vendor-dir');         exec("node_modules/.bin/rollup -c rollup.config.js");     } }
  • composer.json 中注册:"scripts": {"build:js": ["BuildHelper::compileAssets"]}
  • 必须把类所在目录加入 "autoload-dev"(如 "src/Scripts/": ["src/Scripts"]),然后运行 composer dump-autoload
  • 方法参数可选接收 ComposerScriptEvent 对象,从中获取 composer 实例、IO、输入参数等;没传参也不会报错

最易被忽略的是 autoload 配置没生效或类命名空间与文件路径不匹配——这时候脚本看似运行了,实际什么都没做,也没有错误提示。

text=ZqhQzanResources