README

Composer 合并插件

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

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

Composer 合并插件是为了帮助安装MediaWiki 而创建的，它具有核心库要求以及可能通过 Composer 管理的可选库和扩展。

安装

Composer 合并插件 1.4.x（及更早版本）需要 Composer 1.x。

Composer 合并插件 2.0.x（及更新版本）与 Composer 2.x 和 1.x 兼容。

$ composer require wikimedia/composer-merge-plugin

从 Composer 1 升级到 2

如果您已经使用 Composer 合并插件 1.4（或更早版本）并且正在更新插件到 2.0（或更新版本），建议您首先使用 Composer 1 更新插件。

如果您使用 Composer 2 更新不兼容的插件，则该插件将被忽略

由于 "wikimedia/composer-merge-plugin" 插件需要不匹配您的 Composer 安装 ("2.0.0") 的插件 API 版本 ("^1.0")，因此已跳过该插件。您可能需要使用 "--no-plugins" 选项运行 composer update。

因此，Composer 将不知道合并的依赖项，并将删除它们，需要您再次运行 composer update 来重新安装合并的依赖项。

使用方法

{
    "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-replace": true,
            "merge-scripts": false
        }
    }
}

更新子级别 composer.json 文件

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

$ composer update

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

插件配置

插件从 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（可选，见下文 merge-replace）
• repositories
• require
• require-dev（可选，见下文merge-dev）
• 建议
• extra（可选，见下文merge-extra）
• scripts（可选，见下文merge-scripts）

require

require设置与include相同，除非模式匹配至少一个文件失败时，将导致错误。

递归

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

替换

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

忽略重复项

默认情况下，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模式激活（见上文replace），则此行为将改变，最后找到的键将获胜（例如，主配置中的键将被导入配置中的键替换）。如果指定了"merge-extra-deep": true，则部分将类似于array_merge_recursive()进行合并 - 但是重复的字符串数组键将被替换而不是合并，而数字数组键则按常规合并。合并extra部分的有用性取决于使用的Composer插件及其由Composer处理的顺序。

请注意，merge-plugin部分被排除在合并过程之外，但除非禁用递归（见recurse），否则总是由插件处理。

merge-replace

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

merge-scripts

设置"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和其他相关文档与您的更改保持一致。
• 每个功能一个Pull Request。尽量保持您的更改集中解决一个问题。这将使我们更容易审查更改，并使您更容易确保已更新必要的测试和文档。

许可

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