0

0

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

冰火之心

冰火之心

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

|

970人浏览过

|

来源于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 看不到我的描述

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

Toolplay
Toolplay

一站式AI应用聚合生成平台

下载
  • scripts-descriptions 键名拼错了(比如写成 script-descriptionsscripts_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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

154

2023.12.25

json数据格式
json数据格式

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

419

2023.08.07

json是什么
json是什么

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

535

2023.08.23

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

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

311

2023.10.13

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

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

77

2025.09.10

clawdbot ai使用教程 保姆级clawdbot部署安装手册
clawdbot ai使用教程 保姆级clawdbot部署安装手册

Clawdbot是一个“有灵魂”的AI助手,可以帮用户清空收件箱、发送电子邮件、管理日历、办理航班值机等等,并且可以接入用户常用的任何聊天APP,所有的操作均可通过WhatsApp、Telegram等平台完成,用户只需通过对话,就能操控设备自动执行各类任务。

15

2026.01.29

clawdbot龙虾机器人官网入口 clawdbot ai官方网站地址
clawdbot龙虾机器人官网入口 clawdbot ai官方网站地址

clawdbot龙虾机器人官网入口:https://clawd.bot/,clawdbot ai是一个“有灵魂”的AI助手,可以帮用户清空收件箱、发送电子邮件、管理日历、办理航班值机等等,并且可以接入用户常用的任何聊天APP,所有的操作均可通过WhatsApp、Telegram等平台完成,用户只需通过对话,就能操控设备自动执行各类任务。

12

2026.01.29

Golang 网络安全与加密实战
Golang 网络安全与加密实战

本专题系统讲解 Golang 在网络安全与加密技术中的应用,包括对称加密与非对称加密(AES、RSA)、哈希与数字签名、JWT身份认证、SSL/TLS 安全通信、常见网络攻击防范(如SQL注入、XSS、CSRF)及其防护措施。通过实战案例,帮助学习者掌握 如何使用 Go 语言保障网络通信的安全性,保护用户数据与隐私。

8

2026.01.29

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

548

2026.01.28

热门下载

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

精品课程

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

共137课时 | 10万人学习

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

共6课时 | 11.2万人学习

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

共13课时 | 0.9万人学习

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

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