README

Composer 合并插件

在 Composer 运行时合并多个 composer.json 文件。

Composer 合并插件旨在简化部署应用程序时依赖关系管理，这些应用程序包含 composer.json 文件并期望某些部署安装额外的 Composer 管理库。它通过允许应用程序的顶级 composer.json 文件提供一个可选的附加配置文件列表来实现这一点。当运行 Composer 时，它将解析这些文件并将它们的配置设置合并到基本配置中。然后，将使用此组合配置下载额外库并生成自动加载器。

Composer 合并插件是为了帮助安装 MediaWiki 而创建的，它既有核心库需求，也有可选的库和扩展，这些库和扩展可以通过 Composer 进行管理。

安装

Composer 合并插件需要 Composer 1.0.0 或更高版本。

$ composer require wikimedia/composer-merge-plugin

用法

{
    "require": {
        "wikimedia/composer-merge-plugin": "dev-master"
    },
    "extra": {
        "merge-plugin": {
            "include": [
                "composer.local.json",
                "extensions/*/composer.json"
            ],
            "require": [
                "submodule/composer.json"
            ],
            "recurse": true,
            "replace": false,
            "ignore-duplicates": false,
            "merge-dev": true,
            "merge-extra": false,
            "merge-extra-deep": false,
            "merge-scripts": false
        }
    }
}

更新子级 composer.json 文件

为了使 composer-merge-plugin 能够安装来自您项目中的更新或新创建的子级 composer.json 文件中的依赖项，您需要运行以下命令：

$ composer update --lock

这将 指示 Composer 重新计算顶级 composer.json 文件的哈希值，从而触发 composer-merge-plugin 查找子级配置文件并更新您的依赖项。

插件配置

插件从 composer.json 的 extra 部分的 merge-plugin 部分读取其配置。需要一个 include 设置来告诉 Composer 合并插件要合并哪些文件。

include

include 设置可以指定单个值或值数组。每个值都被视为 PHP glob() 模式，用于标识要合并到当前 Composer 执行的根包配置中的额外 composer.json 风格配置文件。

以下配置文件的部分将被合并到 Composer 根包配置中，就像它们被直接包含在顶级 composer.json 文件中一样：

• autoload
• autoload-dev（可选，见下文 merge-dev）
• conflict
• provide
• replace
• repositories
• require
• require-dev（可选，见下文 merge-dev）
• suggest
• extra（可选，见下文 merge-extra）
• scripts（可选，见下文 merge-scripts）

require

require 设置与 include 设置相同，除非模式至少未匹配一个文件，则会导致错误。

recurse

默认情况下，合并插件是递归的；如果一个包含的文件有一个 merge-plugin 部分，它也将被处理。可以通过添加 "recurse": false 设置来禁用此功能。

replace

默认情况下，Composer 的冲突解决引擎用于确定当多个文件指定了同一个包时，应该安装哪个版本的包。可以通过提供 "replace": true 设置来更改到“最后指定版本获胜”的冲突解决策略。在这种模式下，合并文件中找到的重复包声明将覆盖由早期文件做出的声明。文件按照 include 设置中指定的顺序加载，globbed 文件按字母顺序处理。

忽略重复项

默认情况下，Composer 的冲突解决引擎用于确定当多个文件指定了同一个包时，应该安装哪个版本的包。可以通过提供 "ignore-duplicates": true 设置来更改到“首先指定版本获胜”的冲突解决策略。在这种模式下，合并文件中找到的重复包声明将忽略早期文件中做出的声明。文件按照 include 设置中指定的顺序加载，globbed 文件按字母顺序处理。

注意："replace": true 和 "ignore-duplicates": true 模式互斥。如果同时设置，则使用 "ignore-duplicates": true。

合并开发

默认情况下，包含文件的 autoload-dev 和 require-dev 部分将被合并。一个 "merge-dev": false 设置将禁用此行为。

合并额外项

一个 "merge-extra": true 设置使合并包含文件的 extra 部分的内容成为可能。额外部分的标准合并模式是接受找到的任何键的第一个版本（例如，主配置中的键胜过导入配置中找到的版本）。如果 replace 模式（见上方）处于活动状态，则此行为将更改，最后找到的键将获胜（例如，主配置中的键将被导入配置中的键替换）。如果指定了 "merge-extra-deep": true，则部分类似于 array_merge_recursive() 进行合并 - 但是重复的字符串数组键将被替换而不是合并，而数字数组键则按常规合并。合并额外部分的有用性取决于使用的 Composer 插件以及 Composer 处理它们的顺序。

注意，merge-plugin 部分不包括在合并过程中，但除非禁用递归（见上方），否则始终由插件处理。

合并脚本

一个 "merge-scripts": true 设置使合并包含文件的 scripts 部分的内容成为可能。脚本部分的标准合并模式是接受找到的任何键的第一个版本（例如，主配置中的键胜过导入配置中找到的版本）。如果 replace 模式（见上方）处于活动状态，则此行为将更改，最后找到的键将获胜（例如，主配置中的键将被导入配置中的键替换）。

注意：通过合并配置添加的 自定义命令 在使用 composer run-script my-cool-command 调用时将正常工作，但使用正常的 composer my-cool-command 快捷方式时则不可用。

运行测试

$ composer install
$ composer test

贡献

有关错误、功能请求和其他问题，应向 GitHub 项目 报告。我们接受通过 GitHub 上的 Pull Requests 的代码和文档贡献。

• 项目使用PSR-2 编码规范。包含的测试配置使用PHP Code Sniffer来验证约定。
• 鼓励进行测试。我们的测试覆盖率并不完美，但我们希望它能变得更好而不是更差，因此请尽量在您的更改中包含测试。
• 保持文档更新。确保README.md和其他相关文档与您的更改保持更新。
• 每个特性一个拉取请求。尽量使您的更改专注于解决单个问题。这将使我们更容易审查更改，并使您更容易确保已更新必要的测试和文档。

许可证

Composer 合并插件采用MIT许可证。有关详细信息，请参阅LICENSE文件。