如何为 Composer 包添加 keywords,以提高在 Packagist 上的可发现性?

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

如何为 Composer 包添加 keywords,以提高在 Packagist 上的可发现性?-第1张图片-佛山资讯网

composer.json 中添加 keywords 字段,是提升包在 Packagist 上被搜索到概率的简单有效方式。Packagist 会索引这个字段,并在搜索时匹配关键词,帮助开发者更快定位你的包。

在 composer.json 中正确填写 keywords

keywords 是一个字符串数组,应放在根级(与 namedescription 同级),每个词尽量简洁、通用、有实际意义:

  • 用小写英文单词或短语,避免大小写混用或特殊符号
  • 优先选高频搜索词,比如 "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 通常会在几分钟内自动抓取更新。你可以:

标签: composer php word laravel js json 字符串数组

发布评论 0条评论)

还木有评论哦,快来抢沙发吧~