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

Composer如何设包描述_Composer description字段配置【入门】

冬晨小哥_5135

冬晨小哥_5135

发布时间:2026-04-27 22:44:23

|

325人浏览过

|

来源于php中文网

原创

description字段必须为非空字符串且位于composer.json根层级,否则Packagist拒收;需动词开头、含技术锚点、无形容词,长度≤120字符;修改后需手动更新或触发webhook同步。

composer如何设包描述_composer description字段配置【入门】

description 字段必须是字符串,写在 composer.json 根层级,空值或格式错误会导致 Packagist 拒收、composer require 找不到包。

description 字段必须写对位置和类型

它不是配置项,也不是可选注释——Packagist v2 起强制校验非空字符串。写错位置(比如塞进 extra 或 autoload)、写成数组({"en": "..."})、写成 null 或空格,都会被忽略,且不报错。

  • ✅ 正确位置:composer.json 最外层大括号内,与 name、type 并列
  • ✅ 正确写法:"description": "Sends HTTP requests with retry and timeout"
  • ❌ 错误写法:"description": null、"description": ["sends http"]、"extra": {"description": "..."}
  • ⚠️ 末尾逗号:如果 description 后面还有字段(如 keywords),它行尾必须有英文逗号;如果是最后一个字段,则不能有逗号

写什么才不算废话——动词开头 + 技术锚点 + 无框架依赖说明

Packagist 搜索页只显示前约 120 字,截断后还得能独立传达价值。用户搜的是“做什么”,不是“多厉害”。

Workflow Decomposer
Workflow Decomposer

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

下载
  • 以动词起手:Generates、Validates、Provides、Converts,别用 A、An、This package
  • 带一个真实技术锚点:PSR-14、Laravel 11、PHP 8.3+、OAuth2,但版本号建议移入 require.php,这里优先留协议/标准/生态关键词
  • 说明约束更关键:比如 no dependencies、zero-config(指行为上无需配置,不是营销话术)、works offline
  • 避免形容词:lightweight、modern、awesome 全部删掉——Packagist 不索引,人也不信

改了 description 为什么没更新?同步和缓存是两回事

composer.json 本地改完 ≠ Packagist 页面立刻刷新。它不监听 Git push,也不自动拉取,得靠触发机制。

  • 手动更新:登录 Packagist 对应包页,点 Update 按钮(页面右上角)
  • 自动更新:确保 GitHub/GitLab 仓库已正确绑定 webhook,且推送包含 composer.json 变更的 commit
  • 验证是否生效:运行 composer show vendor/name(本地已安装)或访问 Packagist 页面看首屏文案
  • 常见卡点:改了但忘记 push;push 了但 webhook 失败(检查仓库 Settings → Webhooks);composer validate 通过不代表 Packagist 接受——它有额外校验逻辑

description 和 keywords、README 是分工关系,不是重复关系

三者各干各的活,混着写只会稀释信息密度。

  • description:一句话功能定位,给机器扫描+人快速扫读,≤120 字,纯文本,无链接无换行
  • keywords:数组,填 3–5 个真实搜索词,如 ["psr-14", "event-dispatcher", "symfony"],别填 php、library
  • README.md:唯一被 Packagist 渲染的文档文件,放安装命令、示例代码、配置说明——description 里绝不能出现这些
  • ⚠️ 注意:composer.json 里的 readme 字段(如 "readme": "README.md")完全无效,Packagist 只认根目录真实存在的 README.md 文件

最容易被忽略的一点:description 空着不会让 composer install 报错,但会让整个包在 Packagist 上“隐形”。你本地能 require,别人搜不到、IDE 补全不提示、CI 构建时也容易因元数据缺失失败——它不是技术障碍,是发现障碍。

热门AI工具

更多
Laper
Laper Hot

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

DeepSeek

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

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

讯飞智作

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

WorkBuddy

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3469

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2408

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1340

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1278

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1396

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2298

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3740

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

17455

2023.09.22

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

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

20

2026.10.28

热门下载

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

精品课程

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

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习

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

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