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

Composer中scripts-descriptions字段在命令行帮助中的展示效果(命令美化)

云静姑娘_5312

云静姑娘_5312

发布时间:2026-07-19 09:23:39

|

940人浏览过

|

来源于php中文网

原创

scripts-descriptions 字段非 Composer 原生支持,解析器直接忽略;唯一有效方式是在 scripts 条目中同级配置 description 字符串,仅 composer run --list 显示。

composer中scripts-descriptions字段在命令行帮助中的展示效果(命令美化)

composer list 不显示 scripts-descriptions 字段

直接写 "scripts-descriptions" 到 composer.json 里,对 composer list 或 composer run --list 完全无效。这个字段不是 Composer 原生支持的配置项,解析器会彻底忽略它——既不报错,也不渲染,更不会出现在任何命令输出中。

常见错误现象:改完 composer.json 后运行 composer list,发现描述没出现,还以为是格式或版本问题。其实根本原因是 Composer 根本不读这个键。

  • Composer 1.x 和 2.x(包括最新 2.9.6)均未在官方 schema 中定义 scripts-descriptions
  • 即使拼写完全正确、key 与 scripts 中命令名一致,也纯属“静态注释”,仅靠人眼阅读
  • 某些 IDE 或第三方 CLI 工具(如旧版 hirak/prestissimo)可能读取该字段并展示,但这属于插件行为,非 Composer 本身能力

真正能在命令行显示描述的唯一方式:description 字段 + composer run --list

从 Composer 2.5 开始,scripts 下每个脚本条目可配 description 字符串,且仅在 composer run --list 中生效——注意,composer list 仍不显示。

Discussion Composer
Discussion Composer

围绕关键发现、作用机制、临床相关性及研究局限性展开讨论。适用于撰写或优化任何生物医学论文的“讨论(Discussion)”部分——包括结果解读、与既往文献关联、阐释意外发现、界定研究局限性,以及撰写结论。当用户输入以下任一指令时也会自动触发该功能: - “write my discussion” - “help me discuss my findings” - “how do I compare to prior studies” - “write the limitations par

下载

示例写法必须是对象形式:

{
  "scripts": {
    "test": {
      "script": "@php vendor/bin/phpunit",
      "description": "Run unit tests with coverage"
    },
    "cs-fix": {
      "script": "@php vendor/bin/php-cs-fixer fix",
      "description": "Auto-fix coding standards violations"
    }
  }
}
  • description 必须与 script 同级,且值只能是字符串(不支持数组、多行或 Markdown)
  • 仅 composer run --list 输出时会显示该描述;composer list 只列出内置命令(如 install、update),不包含自定义脚本
  • 低版本 Composer(description 字段,建议用 composer --version 确认

想让 composer list 也显示说明?只能靠命名规范或封装脚本

composer list 的输出逻辑固定,只展示命令名(即 scripts 的 key),无法注入额外文本。想让它“看起来有说明”,只有两种务实做法:

  • 用冒号分层命名:"test:unit"、"build:prod"、"dev:clear-cache" —— composer list 原样输出,语义清晰,无需额外字段
  • 加一条 "help:scripts" 脚本,指向一个 PHP 文件,手动解析 composer.json 并格式化输出带描述的列表(可读 extra.scripts-descriptions 或硬编码)
  • 避免在脚本值里塞 # 注释:虽然某些 Composer 版本(≥2.2)能宽松解析行首 # 并显示在 composer list,但行为不稳定、不可靠,且 JSON 标准本身不支持注释,容易被编辑器或 CI 工具误删

scripts-descriptions 字段的实际价值仅限于人工可读性

如果你坚持用 scripts-descriptions,它唯一可靠的作用是:让团队成员 cat composer.json 或在 IDE 里滚动查看时,快速理解每个脚本用途。它不参与执行、不触发校验、不被任何 Composer 命令消费。

  • 字段位置必须与 scripts 同级,且 key 必须完全一致(大小写、连字符、下划线都不能错)
  • CI/CD 流程中若依赖该字段做检查(如用 composer-unused --with-scripts-descriptions),需确认工具版本 ≥2.5 且明确支持该约定
  • 最易被忽略的一点:它和 extra 下任意自定义键一样,只是 JSON 的“装饰”,删掉不影响任何功能,但一旦拼错(比如写成 script-descriptions),就彻底失去文档价值

热门AI工具

更多
Seko
Seko Hot

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

DeepSeek

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

豆包大模型

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

WorkBuddy

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

超级简历WonderCV

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

讯飞智作

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

相关专题

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

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

344

2023.12.25

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

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

543

2026.04.10

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

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

307

2026.04.10

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

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

329

2026.04.10

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

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

280

2026.04.13

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

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

403

2026.04.13

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

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

231

2026.04.14

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

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

270

2026.04.14

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

0

2026.10.08

热门下载

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

精品课程

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

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习

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

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