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,或漏掉协议

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

HaloTool
HaloTool

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 插件完全不读取这个字段——别指望它影响开发流程或自动跳转。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

163

2023.12.25

json数据格式
json数据格式

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

458

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

84

2025.09.10

github中文官网入口 github中文版官网网页进入
github中文官网入口 github中文版官网网页进入

github中文官网入口https://docs.github.com/zh/get-started,GitHub 是一种基于云的平台,可在其中存储、共享并与他人一起编写代码。 通过将代码存储在GitHub 上的“存储库”中,你可以: “展示或共享”你的工作。 持续“跟踪和管理”对代码的更改。

4604

2026.01.21

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

1000

2023.07.05

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

582

2023.07.06

Python WebSocket实时通信与异步服务开发实践
Python WebSocket实时通信与异步服务开发实践

本专题聚焦 Python 在实时通信场景中的开发实践,系统讲解 WebSocket 协议原理、长连接管理、消息推送机制以及异步服务架构设计。内容包括客户端与服务端通信实现、连接稳定性优化、消息队列集成及高并发处理策略。通过完整案例,帮助开发者构建高效稳定的实时通信系统,适用于聊天应用、实时数据推送等场景。

7

2026.03.18

热门下载

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

精品课程

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

共46课时 | 3.7万人学习

AngularJS教程
AngularJS教程

共24课时 | 4.3万人学习

CSS教程
CSS教程

共754课时 | 44.5万人学习

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

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