如何在 composer.json 的 extra 字段中存储自定义配置信息?

admin 百科 13
可在 composer.json 的 extra 字段中写入任意合法 JSON 结构以存放项目自定义配置,Composer 不解析但插件和脚本可通过 $composer->getPackage()->getExtra() 读取,支持嵌套、多种数据类型,推荐小写短横线命名,避免敏感信息。

如何在 composer.json 的 extra 字段中存储自定义配置信息?-第1张图片-佛山资讯网

可以在 composer.jsonextra 字段中直接写入任意合法的 JSON 结构,用于存放项目专属的自定义配置,Composer 本身不解析或使用这些内容,但插件和脚本可以读取它们。

extra 字段的基本写法

extra 是一个自由格式的对象(即 JSON object),只要符合 JSON 语法即可。推荐用小写字母加短横线(kebab-case)或驼峰命名,避免与 Composer 官方字段冲突(如 branch-aliasinstaller-paths 等已保留字段)。

  • 支持嵌套对象和数组
  • 值可以是字符串、数字、布尔值、数组或对象
  • 不要放敏感信息(如密钥、密码),该文件通常会提交到版本库

在 composer.json 中添加自定义配置示例

比如为部署脚本配置环境参数:

"extra": {
  "deploy": {
    "host": "example.com",
    "path": "/var/www/myapp",
    "user": "deployer"
  },
  "build": {
    "skip-tests": true,
    "minify-js": true
  }
}

登录后复制

在自定义脚本或插件中读取 extra 配置

通过 Composer 的 API,在事件监听器或命令中获取:

标签: php js json composer app 工具

发布评论 0条评论)

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