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

如何在使用Composer时利用scripts-descriptions为自定义指令添加文档说明

星芳吖_2598

星芳吖_2598

发布时间:2026-07-09 11:07:47

|

613人浏览过

|

来源于php中文网

原创

scripts-descriptions 是 Composer 的配置项,用于为 composer.json 中 scripts 下的自定义脚本提供人类可读描述,仅影响 composer list 和 composer run --list 输出,需与 scripts 同级且脚本名严格匹配。

如何在使用composer时利用scripts-descriptions为自定义指令添加文档说明

scripts-descriptions 是什么,它在哪起作用

scripts-descriptions 是 Composer 的一个特殊配置项,用于给 composer.json 中定义的自定义脚本(即 scripts 下的命令)添加人类可读的说明。它本身不改变任何行为,只影响 composer list 和 composer run --list 的输出——没有它,自定义脚本只会显示为无描述的命令名。

如何正确声明 scripts-descriptions 配置

必须将 scripts-descriptions 作为顶层字段写在 composer.json 里,与 scripts 同级;键名需完全匹配 scripts 中的脚本名,值为字符串描述。大小写、空格、连字符都必须严格一致。

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-descriptions": { "post-install-cmd": "Runs after install" } —— 如果 scripts 里实际是 "post-install-cmd",这没问题;但如果脚本名是 "post-install" 或 "postInstall",就完全不生效
  • 正确示例:
    {
      "scripts": {
        "dev-start": "php -S localhost:8000 -t public",
        "test-ci": "vendor/bin/phpunit --no-coverage"
      },
      "scripts-descriptions": {
        "dev-start": "Start local dev server on port 8000",
        "test-ci": "Run PHPUnit without coverage (fast CI mode)"
      }
    }
  • 描述文本支持空格和标点,但不要换行或 JSON 注释(JSON 不允许)

scripts-descriptions 不生效的常见原因

最常遇到的问题不是语法错,而是位置或匹配问题。Composer 只在加载 composer.json 时读取该字段,且不做容错校验:名字对不上就静默忽略。

  • scripts-descriptions 写在 scripts 对象内部(比如当成子字段)→ 完全无效
  • 脚本名用了别名(如通过 composer run test 调用),但 scripts-descriptions 里写的是别名而非真实脚本名 → 不显示
  • 项目依赖了其他包,而你在根 composer.json 里写了 scripts-descriptions,却期望它出现在 vendor 包的脚本列表中 → 不可能,它只作用于当前项目的 scripts
  • 运行 composer list 但没看到你的描述?先确认是否执行的是当前项目目录下的命令(不是全局或子目录)

它和 script aliases 的关系

Composer 5.0+ 支持 scripts 中用数组定义 alias(例如 "test": ["@test-ci", "@test-static"]),但 scripts-descriptions 只能描述“真实脚本名”,不能为 alias 单独加描述。alias 自身不会出现在 composer list 输出中,也不会触发对应描述。

  • 如果你定义了 "test": ["@test-ci"],那么只有 test-ci 这个键能被 scripts-descriptions 描述
  • composer run test 仍会执行,但 composer list 里只显示 test-ci 及其描述,test 不会出现
  • 想让 alias 也有说明?只能靠 README 或团队约定,scripts-descriptions 不支持
真正起效的前提很简单:脚本名精确匹配 + 字段在正确层级 + 当前目录是项目根。多检查一遍 composer.json 的缩进和逗号,比查文档更快。

热门AI工具

更多
WorkBuddy

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

火山引擎

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

豆包大模型

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

切问学术

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

DeepSeek

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

立刻MV
立刻MV Hot

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

相关专题

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

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

324

2023.12.25

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

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

503

2026.04.10

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

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

287

2026.04.10

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

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

309

2026.04.10

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

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

260

2026.04.13

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

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

343

2026.04.13

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

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

171

2026.04.14

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

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

230

2026.04.14

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

80

2026.09.23

热门下载

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

精品课程

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

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习

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

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