Composer Scripts 可在执行 Composer 命令时自动触发自定义操作,如安装后生成 autoload 文件、更新时运行测试、部署前编译资源等。通过在 composer.json 的 “scripts” 字段定义事件与命令映射,支持命令行指令、外部脚本或 PHP 类静态方法调用,常见事件包括 post-install-cmd、post-update-cmd、pre-autoload-dump 等,可手动运行 composer run-script 触发,提升项目自动化与协作效率。

Composer Scripts 是 Composer 提供的一个功能,允许你在执行 Composer 命令(如 install、update、autoload-dump 等)时自动触发自定义脚本。这些脚本可以是 PHP 函数、命令行指令或外部脚本文件,常用于自动化项目初始化、构建流程、测试运行等任务。
Composer Scripts 能做什么
通过定义 scripts,你可以在关键生命周期节点自动执行操作:
安装依赖后生成 autoload 文件或清理缓存 更新包时运行代码检查或测试 部署前压缩资源或编译前端文件 初始化项目配置或数据库迁移
它提升了开发和部署的一致性,减少人为遗漏。
如何定义和使用 Scripts
scripts 定义在项目的 composer.json 文件中的 “scripts” 字段下。格式为事件名映射到要执行的命令或回调函数。
示例 composer.json:
{ "scripts": { "post-install-cmd": [ "echo '依赖已安装'", "php artisan optimize", "chmod -R 755 storage/" ], "post-update-cmd": "phpunit --coverage-text", "pre-autoload-dump": "@composer dump-autoload --optimize" }}
常见事件包括:
pre-install-cmd / post-install-cmd:运行 install 前后触发 pre-update-cmd / post-update-cmd:update 前后执行 pre-autoload-dump / post-autoload-dump:dump-autoload 前后调用 post-root-package-install:新建项目后执行,适合初始化提示
支持数组形式写多个命令,按顺序执行。也可以引用其他脚本,比如用 @composer 调用 Composer 自身命令。
自定义脚本与类方法调用
除了命令行,还能执行 PHP 类的静态方法,只要该类能被自动加载。
示例:调用自定义类方法
"scripts": { "post-create-project-cmd": "MyInstaller::welcome"}
确保 MyInstaller 类存在且有静态 welcome 方法。Composer 会自动加载并调用它。这类方式适合做项目引导、生成配置文件等逻辑处理。
手动运行 Scripts
你可以用以下命令手动触发某个事件的所有脚本:
composer run-script post-install-cmd
或简写:
composer run post-install-cmd
这在调试脚本或重复执行某些流程时很有用。
基本上就这些。合理使用 Composer Scripts 可以让项目更智能,减少重复操作,提升协作效率。注意别在 scripts 中写耗时过长或容易出错的命令,避免影响正常依赖管理流程。
以上就是composer scripts是什么以及怎么用_Composer Scripts作用与使用方法的详细内容,更多请关注php中文网其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/139833.html
微信扫一扫
支付宝扫一扫