如何在你的Composer包中推荐其他相关的包?(suggests字段)

尼克
发布: 2025-12-21 16:20:03
原创
990人浏览过
suggests 是 composer.json 中用于推荐非必需但常用或增强功能包的可选字段,类型为键值对对象,Composer 安装时以浅灰色在命令行末尾提示,不触发自动安装也不影响依赖解析。

如何在你的composer包中推荐其他相关的包?(suggests字段)

在 Composer 包的 composer.json 中,用 suggests 字段可以友好地向使用者推荐**非必需但常用或增强功能的相关包**。它不会触发自动安装,也不影响依赖解析,纯粹是给开发者看的提示。

什么是 suggests

suggests 是一个可选字段,类型为对象(key-value),键是包名,值是说明性文字(字符串)。Composer 安装或更新时,会在命令行末尾以浅灰色显示这些提示,帮助用户发现生态中配套的工具、驱动或扩展。

怎么写 suggests

在你的包的 composer.json 的根级别添加 suggests,例如:

Designify
Designify

拖入图片便可自动去除背景✨

Designify 90
查看详情 Designify
"suggests": {
    "monolog/monolog": "用于日志记录的完整 PSR-3 兼容库",
    "phpunit/phpunit": "运行单元测试所需(开发阶段)",
    "laravel/framework": "如在 Laravel 项目中使用,可配合官方适配器"
}
登录后复制

哪些情况适合加 suggests

  • 你的包提供可插拔接口,有第三方实现(比如缓存驱动、事件监听器、序列化器)
  • 常见搭配使用的工具类库(如测试、调试、文档生成)
  • 针对特定框架的桥接包(如 Symfony Bundle、Laravel Package)
  • 可选的高性能替代组件(如用 ext-redis 替代纯 PHP Redis 客户端)

注意事项

  • 不要把硬依赖写进 suggests —— 那该放 require
  • 避免推荐已废弃或维护不活跃的包
  • 说明文字尽量简短明确,让用户一眼看懂用途和场景
  • 不需要版本约束(suggests 不参与版本解析)

基本上就这些。合理使用 suggests,能让你的包更易用、更友好,也更容易融入更大的生态。

以上就是如何在你的Composer包中推荐其他相关的包?(suggests字段)的详细内容,更多请关注php中文网其它相关文章!

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

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

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

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