0

0

如何使用Composer的scripts-descriptions为自定义命令添加描述?

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-01-07 06:43:30

|

268人浏览过

|

来源于php中文网

原创

Composer 不支持 scripts-descriptions 配置项,该字段非官方定义;正确方式是在 scripts 命令值同一行开头用 # 添加描述注释(仅 Composer ≥2.2 支持),或通过 extra 字段配合外部脚本实现稳定展示。

如何使用composer的scripts-descriptions为自定义命令添加描述?

Composer 的 scripts-descriptions 并不是官方支持的配置项,直接写在 composer.json 里不会生效 —— 这是很多人踩坑的第一步。

为什么 scripts-descriptions 不起作用?

Composer 官方文档中从未定义过 scripts-descriptions 这个字段。它既不是根级配置项,也不被 composer installcomposer run 解析。你看到的某些博客或旧项目里出现这个写法,大概率是误传、拼写错误,或是混淆了第三方插件(如 hirak/prestissimo 或自研脚本管理工具)的私有约定。

  • Composer 原生只识别 "scripts" 下的命令名和对应动作
  • 描述信息必须通过其他方式补充:比如注释、README、或借助 composer list 的扩展机制
  • 运行 composer run --listcomposer list 时,它只会显示脚本名,不读取任何 “description” 字段

如何让自定义命令在 composer list 中显示描述?

唯一可靠的方式是使用 Composer 的 scripts + description 注释语法(仅限 Composer ≥ 2.2),但注意:这需要把描述写在脚本值的**同一行开头,用 # 注释**,且必须是 JSON 字符串字面量中的合法注释(实际是利用了 Composer 内部对 JSON 行注释的宽松解析)。

实操要点:

  • 仅支持单行 # 注释,且必须紧贴脚本命令值之前(不能换行)
  • 必须用双引号包裹整个字符串,# 后至少一个空格
  • 该特性依赖 Composer 自身解析逻辑,并非 JSON 标准,低版本(
{
    "scripts": {
        "build": "# 构建前端资源并复制到 public/ # npm run build && cp -r dist/* public/",
        "test:unit": "# 运行 PHPUnit 单元测试 # vendor/bin/phpunit --testsuite=unit"
    }
}

执行 composer list 后你会看到:

法语写作助手
法语写作助手

法语助手旗下的AI智能写作平台,支持语法、拼写自动纠错,一键改写、润色你的法语作文。

下载
...
build            构建前端资源并复制到 public/
test:unit        运行 PHPUnit 单元测试
...

更稳定、推荐的替代方案:用 composer.jsonextra 区域手动维护描述

如果你需要生成文档、做 CI 提示、或集成到 IDE 插件里,硬编码注释不可靠。更可控的做法是把描述单独放在 extra.scripts-descriptions(名字任意)下,然后用脚本读取:

{
    "scripts": {
        "build": "npm run build && cp -r dist/* public/",
        "test:unit": "vendor/bin/phpunit --testsuite=unit"
    },
    "extra": {
        "scripts-descriptions": {
            "build": "构建前端资源并复制到 public/",
            "test:unit": "运行 PHPUnit 单元测试"
        }
    }
}

之后你可以写一个简单 PHP 脚本(例如 bin/composer-help.php)来输出带描述的列表:

 $desc) {
    printf("%-15s %s\n", $name, $desc);
}

再加一条 Composer 脚本:"help:scripts": "php bin/composer-help.php",就能随时查。

真正容易被忽略的是:Composer 的描述支持本质是“尽力而为”的非标准行为,别把它当契约。生产环境若需稳定展示,优先走 extra + 外部脚本,或者直接维护一份 SCRIPTS.md —— 毕竟人写的文档,比机器猜的注释靠谱得多。

相关专题

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

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

148

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

406

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

531

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

308

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

253

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

206

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1458

2023.10.24

C++ 高性能计算与并行编程
C++ 高性能计算与并行编程

本专题专注于 C++ 在高性能计算(HPC)与并行编程中的应用,涵盖多线程、并发数据处理、OpenMP、MPI、GPU加速等技术。通过实际案例,帮助开发者掌握 如何利用 C++ 进行大规模数据计算和并行处理,提高程序的执行效率,适应高性能计算与数据密集型应用场景。

1

2026.01.08

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.4万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号