0

0

如何通过Composer.json中的support字段添加文档和Issue链接?

尼克

尼克

发布时间:2026-01-08 13:50:02

|

283人浏览过

|

来源于php中文网

原创

support 字段仅支持预定义键名,实际生效且被 Packagist 渲染的只有 docs 和 issues,二者必须为完整 HTTPS URL;其他键如 source、forum 等不被解析或展示,自定义键名将导致 composer validate 报错。

如何通过composer.json中的support字段添加文档和issue链接?

support 字段本身不支持直接添加文档链接或 Issue 链接——它只接受特定键名,且这些键名是预定义的、硬编码在 Composer 的 schema 中的。

support 字段只认这几个键:docsissuessourceforumwikiirctwitter

Composer 官方 Schema 明确限定 support 下只允许以下字段(大小写敏感,不能拼错):

  • docs:对应项目文档地址,例如 "docs": "https://example.com/docs"
  • issues:对应 Issue 跟踪地址(GitHub/GitLab 的 Issues 页面),例如 "issues": "https://github.com/user/repo/issues"
  • source:代码仓库地址(不是主页),例如 "source": "https://github.com/user/repo.git"
  • 其他如 forumwiki 等字段虽存在,但不会被 Packagist 或大多数工具解析展示,仅作保留字段

写成 documentationbugtrackerhelp 等自定义键名会被 Composer 忽略,且 composer validate 会报 schema 错误。

实际生效的只有 docsissues,且仅在 Packagist 页面显示

Packagist 是目前唯一消费 support 字段并公开渲染的平台。它的前端只读取并展示:

  • docs → 显示为 “Documentation” 标签页链接
  • issues → 显示为 “Issues” 标签页链接
  • source → 用于生成 “Source” 链接,但仅当未设 homepage 时才可能 fallback 使用

示例正确写法:

{
    "support": {
        "docs": "https://mylib.example.org/guide",
        "issues": "https://github.com/myorg/mylib/issues"
    }
}

注意:docs 值必须是完整 URL(含 https://),否则 Packagist 不识别;issues 同理,不能写成 "https://github.com/myorg/mylib"(这是主页,不是 issues 页)。

常见错误:混用 homepagesupport.docs,或漏掉协议

这两个字段用途不同,不可互相替代:

免费语音克隆
免费语音克隆

这是一个提供免费语音克隆服务的平台,用户只需上传或录制一段 5 秒以上的清晰语音样本,平台即可生成与用户声音高度一致的 AI 语音克隆。

下载
  • homepage 是包的主站(通常带介绍、下载、演示等),Packagist 将其显示在包名下方大标题旁
  • support.docs 是纯文档入口,Packagist 单独列为一个导航标签页
  • 若只填了 homepage,Packagist 不会自动从它推导出文档链接
  • docs 值是 "./docs""docs/index.html",验证失败且 Packagist 忽略

验证方式很简单:

composer validate

如果字段名拼错或 URL 缺少协议,会提示类似:

[Schema] support: The property docs is not defined and the definition does not allow additional properties.(字段名错误)

[Schema] support.docs: URL must start with http:// or https://(协议缺失)

真正起作用的只有 docsissues 这两个键,而且它们只在 Packagist 上可见。本地 composer install 或 IDE 插件完全不读取这个字段——别指望它影响开发流程或自动跳转。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

148

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

406

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

531

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

309

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

603

2023.06.14

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

643

2023.06.21

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

465

2023.07.31

Golang 分布式缓存与高可用架构
Golang 分布式缓存与高可用架构

本专题系统讲解 Golang 在分布式缓存与高可用系统中的应用,涵盖缓存设计原理、Redis/Etcd集成、数据一致性与过期策略、分布式锁、缓存穿透/雪崩/击穿解决方案,以及高可用架构设计。通过实战案例,帮助开发者掌握 如何使用 Go 构建稳定、高性能的分布式缓存系统,提升大型系统的响应速度与可靠性。

2

2026.01.09

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.8万人学习

AngularJS教程
AngularJS教程

共24课时 | 2.4万人学习

CSS教程
CSS教程

共754课时 | 18.2万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号