在 composer.json 中添加 keywords 字段可提升包在 Packagist 上的搜索可见性;它为小写字符串数组,置于根级,应包含简洁通用的高频词如 "laravel"、"validation",避免无效词,并需配合 description、type 等字段优化。

在 composer.json 中添加 keywords 字段,是提升包在 Packagist 上被搜索到概率的简单有效方式。Packagist 会索引这个字段,并在搜索时匹配关键词,帮助开发者更快定位你的包。
在 composer.json 中正确填写 keywords
keywords 是一个字符串数组,应放在根级(与 name、description 同级),每个词尽量简洁、通用、有实际意义:
- 用小写英文单词或短语,避免大小写混用或特殊符号
- 优先选高频搜索词,比如
"laravel"、"validation"、"api"、"cache" - 包含技术栈、功能类型、使用场景,例如:
"symfony-bundle"、"json-api"、"middleware" - 避免过度堆砌或无关词(如 “php“、”composer”、”package” —— 这些几乎无区分度)
参考示例
一个 Laravel 验证规则扩展包的 keywords 可能这样写:
"keywords": [ "laravel", "validation", "rules", "custom-rule", "form-validation" ]
提交后生效时间与验证方式
修改 composer.json 并推送新版本(如打 tag 或 push 到默认分支)后,Packagist 通常会在几分钟内自动抓取更新。你可以:
- 访问你的包页面(
https://packagist.org/packages/your-vendor/your-package),查看右侧 Keywords 区域是否已更新 - 在 Packagist 搜索栏输入任一 keyword,确认你的包是否出现在结果前列
- 对比同类包的 keywords,持续优化(比如发现大家常用
"dto"而你用了"data-transfer-Object",可改为更简短形式)
配合其他字段效果更好
keywords 单独作用有限,建议同步优化:
- description:首句明确说明用途,自然嵌入 1–2 个核心关键词
- type:设为
library、laravel-package等标准类型,利于分类筛选 - autoload / extra:如有框架集成,可在
extra.laravel等字段中标明兼容性,间接增强相关搜索权重
基本上就这些 —— 不复杂但容易忽略,加几行 keywords,可能就让下一个 Laravel 开发者一眼找到你的包。
以上就是如何为 Composer 包添加 keywords,以提高在 Packagist 上的可发现性?的详细内容,更多请关注php中文网其它相关文章!