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

Composer scripts-descriptions怎么写 自定义命令描述信息【美化】

浅辰君_1528

浅辰君_1528

发布时间:2026-01-29 09:56:02

|

1030人浏览过

|

来源于php中文网

原创

Composer 通过同级的 scripts-descriptions 字段为 scripts 中的命令添加描述,其 key 必须与 scripts 命令名完全一致;需 Composer 2.2+,且 JSON 格式正确、无拼写错误。

composer scripts-descriptions怎么写 自定义命令描述信息【美化】

composer.json 里 scripts 字段的 description 怎么加

Composer 不支持直接在 scripts 数组里为每个脚本写描述字段——它原生只认命令名和对应执行内容。所谓“自定义命令描述”,其实是靠 scripts-descriptions 这个特殊键实现的,必须和 scripts 同级、独立声明。

正确写法是:

{
  "scripts": {
    "test": "phpunit",
    "build": "php build.php"
  },
  "scripts-descriptions": {
    "test": "Run unit tests with PHPUnit",
    "build": "Compile assets and generate production files"
  }
}

注意:scripts-descriptions 的 key 必须和 scripts 中的命令名完全一致(包括大小写和连字符),否则 composer list 不会显示对应描述。

为什么 composer list 看不到我的描述

常见原因不是写法错,而是没满足两个硬性条件:

Workflow Decomposer
Workflow Decomposer

工作流任务拆解与模型编排技能。使用场景:(1) 收到复杂工作任务需要拆解为可执行步骤,(2) 需要为不同步骤选择最合适的模型,(3) 需要跟踪工作流进度和模型使用情况,(4) 长时间任务卡住需要问题诊断和解决方案。

下载
  • scripts-descriptions 键名拼错了(比如写成 script-descriptions 或 scripts_description)
  • 对应 script 名在 scripts 中不存在(比如写了 "lint" 描述但没定义 "lint" 命令)
  • 用了 Composer 1.x 版本(scripts-descriptions 是 Composer 2.2+ 引入的,1.x 完全忽略该字段)
  • 运行了 composer install 但没重新加载 autoload(极少,但改完 composer.json 后建议跑一次 composer dump-autoload)

description 内容怎么写才实用

别写“执行构建”这种废话,重点说清三件事:做什么、对谁有用、有没有副作用。

  • 用动词开头,比如 "Generate API docs using phpDocumentor",而不是 "API docs generation"
  • 提关键依赖或环境要求,比如 "Requires NODE_ENV=production and .env.local"
  • 标注是否修改文件,比如 "Writes to ./dist/ — safe to run in CI" 或 "Modifies composer.lock — avoid in shared environments"
  • 避免缩写,除非项目内已约定(如 CI 可以,pkg 就容易歧义)

想让描述支持中文或特殊符号要注意什么

JSON 标准本身支持 UTF-8,所以中文没问题,但有两点实际限制:

  • 终端宽度有限,描述超过 ~60 字符会被截断(composer list 输出列宽固定),建议控制在 45 字以内
  • 不要用换行符 \n 或制表符 \t,Composer 解析时会当空格处理,且破坏对齐
  • 如果描述含双引号,必须转义:"\"prod\" mode only",否则 JSON 校验失败
  • Emoji 可以用,但部分 CI 环境或老旧终端可能显示为方块,不推荐用于关键说明

描述再漂亮,也得先通过 composer validate;没通过就别指望 list 能显示出来。

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

蛙蛙写作

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

火山引擎

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

DeepSeek

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

WorkBuddy

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

墨刀AI
墨刀AI Hot

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

豆包大模型

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

讯飞智作

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

小橡皮AI

一款AI工具,主要用于小橡皮一键去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 依赖管理的基本工作流。

603

2026.04.10

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

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

347

2026.04.10

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

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

369

2026.04.10

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

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

320

2026.04.13

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

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

503

2026.04.13

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

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

311

2026.04.14

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

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

370

2026.04.14

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

20

2026.10.28

热门下载

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

精品课程

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

共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