README

Composer 合并插件

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

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

Composer 合并插件是为了帮助安装 MediaWiki 而创建的，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文件按字母顺序处理。

ignore-duplicates

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

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

merge-dev

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

merge-extra

"merge-extra": true设置可以启用合并包含文件的extra部分的内容。正常情况下，extra部分的合并模式是接受找到的任何键的第一个版本（例如，主配置中的键胜过导入配置中找到的版本）。如果激活了replace模式（见上文），则此行为将改变，最后一个找到的键将获胜（例如，主配置中的键将被导入配置中的键替换）。如果指定了"merge-extra-deep": true，则部分将像array_merge_recursive()一样合并 - 然而，字符串数组键的重复将替换而不是合并，而数字数组键将按常规合并。合并extra部分的有用性将根据使用的Composer插件及其由Composer处理的顺序而有所不同。

注意，merge-plugin部分不包括在合并过程中，但除非禁用递归（见上文），否则插件总是进行处理。

merge-scripts

"merge-scripts": true设置可以启用合并包含文件的scripts部分的内容。正常情况下，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 文件。