如何在你的composer.json中定义项目的支持信息(support)?

admin 百科 13
support字段用于声明项目技术支持渠道,是纯元数据,不影响安装或依赖解析;支持email、issues、source、docs等键,被Packagist、composer show等工具展示。

如何在你的composer.json中定义项目的支持信息(support)?-第1张图片-佛山资讯网

composer.json 中定义 support 字段,是为了向使用者(尤其是其他开发者或团队成员)清晰地说明该项目的技术支持渠道。它本身不会影响安装或依赖解析,但对开源项目、内部工具库或交付给客户的 PHP 包来说,是专业性和可维护性的重要体现。

support 字段的基本结构

support 是一个对象,支持多个常用支持方式,每个键对应一种联系途径,值为字符串。官方认可的键包括:

  • email:主支持邮箱(如 "support@example.com"
  • issues:问题跟踪地址(通常是 GitHub/GitLab 的 Issues 页面,如 "https://github.com/yourname/your-package/issues"
  • source:源码仓库地址(如 "https://github.com/yourname/your-package"
  • docs:文档网址(如 "https://yourname.github.io/your-package/docs"
  • rss:更新动态 RSS 地址(较少用)
  • forumchatirc 等:按需添加,Composer 不校验,但会被 Packagist 等平台识别展示

实际写法示例

以下是一个典型的 support 配置片段,可直接放入 composer.json 的根对象中(与 namedescription 同级):

"support": {
  "email": "help@myapp.local",
  "issues": "https://gitlab.example.com/mygroup/myapp/-/issues",
  "source": "https://gitlab.example.com/mygroup/myapp",
  "docs": "https://myapp.local/docs",
  "chat": "https://slack.myapp.local"
}

登录后复制

注意:所有 URL 建议使用 HTTPS;邮箱应为真实可用的支持入口;sourceissues 地址最好保持一致平台(如都用 GitLab),避免混淆。

标签: php js git json composer github app 工具 ai gitlab 邮箱

发布评论 0条评论)

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