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

Composer run-script help命令_Composer查看自定义脚本的使用说明

轻辰君_9492

轻辰君_9492

发布时间:2026-06-10 06:47:46

|

731人浏览过

|

来源于php中文网

原创

<p>Composer 不提供内置脚本帮助功能,仅通过 composer.json 中 scripts.description 字段显示简要说明;真正的 --help 支持需在脚本内部手动实现,且必须用 composer run script -- --help 透传参数。</p>

composer run-script help命令_composer查看自定义脚本的使用说明

Composer 没有内置的 composer run-script help 或类似“显示脚本用法”的功能——脚本本身不带 help 元数据,composer run --list 只列名字和描述(如果写了),不解释参数怎么传、支持哪些选项。

composer run --list 显示的 description 是唯一“官方帮助”

Composer 仅从 composer.jsonscripts 字段读取键名和可选的字符串描述。例如:

"scripts": {
  "test": {
    "description": "Run PHPUnit with optional --filter or --group",
    "script": ["@php", "vendor/bin/phpunit"]
  }
}

此时 composer run --list 会显示:

test: Run PHPUnit with optional --filter or --group

但这个 description 完全靠手写,Composer 不校验、不解析、不强制要求。没写就空着,写错也不会报错。

First Principles Decomposer
First Principles Decomposer

把任何问题拆解为根本真理,再从原子层面重建解决方案。

下载
  • description 字段只在 composer run --list 里出现,composer run test --help 会直接失败(因为 test 脚本本身不是命令行工具)
  • 如果你用数组格式定义脚本(如 ["@php", "test.php"]),description 不会自动继承 test.php 的 PHPDoc 或 --help 输出
  • 想让 composer run test --help 真正生效,得在 test.php 里自己实现参数解析和帮助文案

脚本内部怎么实现 --help 支持

真正能响应 --help 的,是脚本自身(比如 PHP 文件或 vendor/bin 下的二进制)。Composer 只负责把参数透传过去。所以关键在脚本逻辑里判断:

  • PHP 脚本中检查 in_array('--help', $argv)getenv('COMPOSER_ARGS')(Composer 4.0+ 提供)
  • 调用 vendor/bin/phpunit --help 时,它自己的帮助页才出来;但注意:必须用 composer run test -- --help(两个 --),否则 --help 被 Composer 拦截
  • Shell 脚本里用 case "$1" in --help) echo "Usage: ..."; exit 0;; esac,但需确保引号包裹完整,避免 $1 被空格截断

为什么不能依赖 composer run-script 自动提供帮助

因为 composer run-script 已被弃用(自 Composer 2.0),且它本质只是查找并执行字符串/数组定义,不做任何参数语义分析。它甚至不知道你写的 "test": "phpunit" 对应的是 PHPUnit,更不会转发 --help 到 phpunit 二进制。

  • composer run test -- --helpvendor/bin/phpunit --help 行为一致,前提是脚本值正确指向可执行文件
  • 如果脚本值是字符串 "test": "phpunit",而 phpunit 不在 $PATH 中,就会报 Command "phpunit" not found,连 help 都看不到
  • 跨平台脚本(尤其含 &&$())在 Windows CMD 下大概率失效,help 文案再全也没用

真正可靠的做法:把帮助说明写进 composer.jsondescription 字段,并在脚本文件开头用注释或 if (isset($argv[1]) && $argv[1] === '--help') 手动输出。别指望 Composer 替你管这个。

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

火山引擎

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

豆包大模型

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

DeepSeek

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

WorkBuddy

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

相关专题

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

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

304

2023.12.25

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

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

463

2026.04.10

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

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

267

2026.04.10

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

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

269

2026.04.10

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

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

240

2026.04.13

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

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

303

2026.04.13

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

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

151

2026.04.14

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

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

210

2026.04.14

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

0

2026.09.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习

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

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