description 字段必须填写非空字符串,否则 Packagist 显示“No description”且无法被搜索;同时需补全 name、type、license、autoload 四个关键字段以确保项目可发现与正确加载。
composer.json 中的 "description" 字段不是可选装饰项——它直接影响 Packagist 页面展示、IDE 提示、依赖分析工具识别,甚至某些 CI/CD 流程校验。没填或填空字符串,会导致包在 Packagist 上显示 “No description” 且无法被按关键词搜索到。
description 字段必须是字符串,不能为空或 null
Composer 不会报错,但 Packagist 会忽略该包的描述信息,且 composer show vendor/package 输出中 description 为空行。
- ✅ 正确写法:
"description": "A lightweight HTTP client for PHP" - ❌ 错误写法:
"description": ""或"description": null(JSON 语法不合法)或省略该字段 - ⚠️ 注意:描述应简洁(建议 ≤ 120 字符),避免营销话术,聚焦功能本质,比如 “Implements PSR-18 async HTTP client” 比 “The best, fastest, most awesome HTTP lib ever!” 更有效
除了 description,这 4 个字段也建议一并补全
仅填 description 不足以让项目被良好识别;Packagist 和静态分析工具(如 PHPStan 扩展扫描)依赖完整元数据。