Composer的 "funding" 字段有什么用_为你的开源Composer包添加赞助链接

冰火之心
发布: 2025-12-03 14:13:02
原创
183人浏览过
funding字段是Composer中用于声明开源项目赞助渠道的可选配置,它能在用户安装包时显示支持作者的提示。1. 该字段不干扰代码运行,仅用于展示GitHub、Patreon、Tidelift等平台的赞助链接。2. 添加后可通过composer install或update触发赞助提示,提升维护者获得经济支持的机会。3. 只需在composer.json中添加对应URL和类型即可启用,无需代码修改。4. 支持可持续开源开发,帮助贡献者获得合理回报。示例包含monolog包通过GitHub Sponsors和Tidelift获取资助的形式。建议使用Composer 2.0+以确保提示正常显示。

composer的 \

当你在使用 Composer 安装一些开源 PHP 包时,可能注意到 composer.json 文件中多了一个叫 funding 的字段。这个字段不会影响代码运行,也不参与依赖管理,但它有一个温暖的用途:帮助开源开发者获得经济支持。

什么是 funding 字段?

funding 是 Composer 提供的一个可选字段,允许包作者声明自己的赞助渠道。当其他人使用你的包时,Composer 可以在安装或更新过程中提示用户支持你。这为维护者提供了一种简单方式来接受捐赠,从而持续投入时间维护项目。

例如,一个典型的 composer.json 中的 funding 字段长这样:

{
    "name": "monolog/monolog",
    "funding": [
        {
            "url": "https://github.com/sponsors/Seldaek",
            "type": "github"
        },
        {
            "url": "https://tidelift.com/funding/github/packagist/monolog/monolog",
            "type": "tidelift"
        }
    ]
}
登录后复制

为什么你应该添加 funding 字段

如果你维护一个被广泛使用的开源 PHP 包,添加 funding 字段有这些好处:

  • 让用户更容易发现如何支持你 —— 很多人愿意赞助,但不知道从哪里入手
  • Composer 命令行工具会在安装时显示赞助提示,提升曝光度
  • 鼓励可持续的开源开发 —— 经济回报能激励长期维护
  • 无需改动代码,只需修改 composer.json 即可启用

支持哪些赞助平台

funding 字段不限定具体平台,常见的类型包括:

  • github:GitHub Sponsors 页面
  • patreon:Patreon 赞助页面
  • tidelift:Tidelift 订阅链接
  • open_collective:Open Collective 集体资金页
  • ko_filiberapay 等其他平台也可自定义添加

只要提供正确的 URL,任何合法的资助渠道都可以加入。

Fotor AI Face Generator
Fotor AI Face Generator

Fotor 平台的在线 AI 头像生成器

Fotor AI Face Generator 50
查看详情 Fotor AI Face Generator

如何为你的包添加 funding 支持

步骤非常简单:

  • 打开你项目的 composer.json 文件
  • 在根层级添加 funding 数组字段
  • 填入你的赞助链接和对应类型
  • 提交更改并发布新版本

示例:

"funding": [
    {
        "url": "https://github.com/sponsors/your-username",
        "type": "github"
    }
]
登录后复制

一旦发布,使用你包的开发者在执行 composer installcomposer update 时,就有可能看到类似提示:

[info] This package is funded by GitHub Sponsors. Consider supporting the author: https://github.com/sponsors/your-username

具体是否显示,取决于用户的 Composer 配置和版本(建议使用 Composer 2.0+)。

基本上就这些。不需要复杂设置,也不影响功能,但能让更多人看到你的努力,并有机会给予回报。

以上就是Composer的 "funding" 字段有什么用_为你的开源Composer包添加赞助链接的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

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