讲师中心 微信公众号
AI工具推荐 视频效率加速

Composer run-script --list 列出所有自定义脚本【技巧】

冬芳君_4020

冬芳君_4020

发布时间:2026-01-28 14:08:02

|

757人浏览过

|

来源于php中文网

原创

根本原因是 composer.json 中未正确定义或为空的 scripts 字段;脚本名须符合命名规范,且 scripts-descriptions(Composer 2.2+)可为 --list 提供描述,但不影响执行。

composer run-script --list 列出所有自定义脚本【技巧】

composer run-script --list 为什么有时不显示自定义脚本

根本原因通常是 composer.json 里没正确定义 scripts 字段,或该字段为空对象。Composer 只会扫描顶层 scripts 键下的键名作为可执行脚本名,不会递归或识别注释、变量占位符。

常见错误现象包括:命令返回空列表、只显示内置脚本(如 pre-install-cmd)、或报错 There are no scripts defined in the root package。

  • 确认 composer.json 中存在 "scripts": { ... },且不是 "scripts": {} 或被注释掉
  • 脚本名不能含空格或特殊字符,仅支持字母、数字、下划线、中划线(如 build:prod 合法,build prod 不合法)
  • 如果用 composer create-project 初始化项目,检查是否覆盖了原始 composer.json,导致脚本丢失

如何让 composer run-script --list 显示带描述的脚本

Composer 本身不原生支持脚本描述,但可通过在 scripts 中使用 @php -r "echo ..." 或调用外部工具(如 echo)实现伪描述 —— 实际上是把说明“打印出来”,而非元数据。

windows-shell-syntax
windows-shell-syntax

在 Windows 上执行终端命令,或对比 Windows 与 Linux 的 Shell 语法时使用。建议先检测当前 Shell 是 PowerShell 还是 cmd.exe,再给出相应命令……

下载

更可靠的做法是用 composer.json 的 scripts-descriptions(需 Composer 2.2+)扩展字段,但注意:该字段**仅用于 composer run-script --list 展示,不影响执行逻辑**。

  • 添加 "scripts-descriptions" 对象,键名必须与 scripts 中完全一致:
    "scripts": {
      "test": "@php vendor/bin/phpunit"
    },
    "scripts-descriptions": {
      "test": "Run unit tests with PHPUnit"
    }
  • 低版本 Composer(--list 仍只显示脚本名
  • 描述文本不参与执行,也不校验是否存在对应脚本,拼写错误也不会报错

运行自定义脚本时找不到命令的典型原因

composer run-script xxx 执行失败,提示 Command not found 或 Script xxx handling the xxx event returned with error code,往往不是脚本没列出来,而是执行环境缺失依赖或路径问题。

  • 脚本中调用的二进制文件(如 phpcs、phpstan)未安装在 vendor/bin/ 下,或未加 ./vendor/bin/ 前缀
  • 使用 php 调用时未指定完整路径(如 php ./script.php),而当前工作目录不是项目根目录
  • Windows 下脚本值含 sh 或 bash 命令(如 sh -c "..."),默认不可执行;应改用 @php -r 或跨平台工具
  • 脚本值以 @ 开头(如 @php)表示调用 Composer 内置命令处理器,此时不走 shell,无法使用管道、重定向等 shell 特性

调试脚本执行过程的实用技巧

光看 --list 不足以验证脚本是否真能跑通,得观察实际执行时的行为和上下文。

  • 加 -v(verbose)参数:例如 composer run-script build -v,会显示完整命令行、工作目录、环境变量前缀
  • 临时插入调试语句:在脚本值开头加 echo "RUNNING: $(pwd)"; (Linux/macOS)或 echo "RUNNING: %cd%(Windows)
  • 用 composer config bin-dir 确认 vendor/bin 路径是否被自定义过,避免硬编码路径失效
  • 注意 run-script 默认在项目根目录执行,但某些 IDE 或 CI 工具可能在子目录触发,导致相对路径出错
实际项目中,最易被忽略的是 scripts-descriptions 的版本兼容性,以及 Windows 下对 shell 语法的天然排斥 —— 很多本地测试通过的脚本,在 CI 的 Linux 环境或队友的 Windows 机器上静默失败。

热门AI工具

更多
火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

相关专题

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

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

344

2023.12.25

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

563

2026.04.10

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

327

2026.04.10

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

349

2026.04.10

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

300

2026.04.13

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

463

2026.04.13

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

271

2026.04.14

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

330

2026.04.14

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

60

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn