composer run-script 用于执行 composer.json 中 scripts 定义的脚本,如清除缓存、运行测试等,支持传参和简写命令,提升开发效率。

在使用 Composer 管理 php 项目时,composer run-script 是一个非常实用的命令,它允许你手动执行定义在 composer.json 文件中的自定义脚本。这个功能特别适合运行构建任务、自动化测试、清理缓存等操作。
什么是 composer run-script
composer run-script 命令用于运行 composer.json 中 scripts 字段下预定义的脚本。这些脚本可以是 PHP 脚本、Shell 命令或任何可执行的命令行操作。
例如,在 composer.json 中你可以这样定义一个脚本:
{ "scripts": { "post-install-cmd": "echo '安装完成!'", "clear-cache": "php clear-cache.php", "test": "phpunit" } }
定义之后,就可以通过 composer run-script 来调用它们。
基本用法:执行自定义脚本
要运行某个脚本,只需在终端中输入:
composer run-script clear-cache
也可以简写为:
composer run clear-cache
上面两条命令效果相同,都会执行 php clear-cache.php 这个命令。
- 脚本名称必须与
composer.json中scripts对象里的键名一致 - 如果脚本不存在,Composer 会提示错误
- 支持传参:如
composer run-script test -- --Filter=TestCase,注意双横线用于传递参数给实际命令
查看所有可用脚本
想知道当前项目中定义了哪些脚本?运行:
composer run-script
不带任何参数时,该命令会列出所有可运行的自定义脚本,方便你查看和选择。
常见应用场景
利用 run-script 可以简化日常开发任务:
- 清除缓存:定义一个 clear-cache 脚本,一键清理应用缓存文件
- 运行测试:将 phpunit 封装为 test 脚本,统一调用方式
- 部署前检查:编写 pre-deploy 脚本,自动执行代码规范检测
- 生成代码:结合 symfony Maker 或 laravel Artisan 命令快速生成类文件
比如:
"scripts": { "dev-setup": [ "composer install", "php artisan key:generate", "php artisan migrate" ] }
然后运行:composer run dev-setup,即可完成本地环境初始化。
基本上就这些。掌握 composer run-script 能让你更高效地管理项目自动化流程,减少重复命令输入,提升协作一致性。
以上就是composer run-script命令怎么用_教你使用composer run-script执行脚本的详细内容,更多请关注php中文网其它相关文章!