直接修改 composer.json 中的 "description" 字段即可生效,无需执行任何 composer 命令;该字段仅为元信息,影响 packagist 展示、composer show 输出和 ide 提示,不参与依赖解析。

直接改 composer.json 里的 "description" 字段就行,不需要任何命令或重新安装依赖。
怎么改 description 字段
这个字段纯属元信息,只影响 Packagist 页面展示、composer show 输出和 IDE 的包提示,不参与依赖解析或安装逻辑。
- 打开项目根目录下的
composer.json - 找到
"description"键(没有就手动加),赋一个字符串值,比如:"description": "A lightweight HTTP client wrapper for Laravel" - 保存文件即可生效 —— 不需要
composer update,也不需要composer dump-autoload
为什么改了 packagist 上没更新
Packagist 不会自动拉取你本地 composer.json 的变更。它只在你 push tag 或触发 webhook 时同步一次元数据。
- 如果你是私有包,改完
composer.json后需手动 re-index(比如用 Packagist 的 “Update” 按钮) - 如果是 GitHub/GitLab 仓库且已绑定 Packagist,下次 push 新 tag(如
v1.2.3)才会刷新 description - 本地运行
composer show vendor/name能立刻看到新描述,但这是读的本地文件,不是 Packagist 缓存
description 写错或留空会怎样
留空或写成空格、点号等无效内容,Packagist 会显示 “No description provided”,IDE(如 PHPStorm)也可能忽略该包的智能提示。
- 避免用句号结尾 —— Packagist 会自动补句号,重复显得啰嗦
- 别写成文档式长句,控制在 120 字以内,重点说清“做什么”而不是“怎么做”
- 不要包含版本号、作者名或链接 —— 这些有专门字段(
version、authors、homepage)
真正容易被忽略的是:description 不参与任何自动化流程,但它会影响别人第一次搜到你包时的决策 —— 两秒内没看懂用途,大概率就划走了。










