talentuno-official/composer-monorepo-plugin

1.0 2020-11-13 12:26 UTC

README

Note: this project is still experimental. Please provide feedback!

此插件为使用Composer包管理器时添加对Monorepos的支持。它引入了一种可维护的方法来管理单个存储库中的多个包的依赖关系,同时不会失去为每个单独的包具有显式依赖关系的优势。

使用此插件管理的存储库包含两种类型的包

  1. 由单个全局 composer.json 定义并由所有外部依赖项在存储库根目录中定义的Composer包。
  2. 项目子目录中的许多monorepo包,每个包都有自己的 monorepo.json,这是一个简化版的 composer.json 文件。

monorepos中的依赖关系可以是列在 composer.json 中的第三方Composer包,或者是项目中的monorepo包。

此插件构建步骤为每个只具有显式指定的依赖关系的包生成 vendor/autoload.php 文件。

此插件在构建autoload时执行以下步骤

  1. 它检测子目录中的 monorepo.json 文件(排除 vendor/),并将它们标记为包的根目录。
  2. 然后,它从本地安装的包中检索所有Composer包。
  3. 最后,对于每个具有 monorepo.json 的包,它使用该包中定义的所有依赖关系生成一个 vendor/autoload.php 文件,这些依赖关系来自其他monorepo包或常规Composer包。

此插件从Google Blaze/Bazel 和Facebook Buck 中汲取灵感,它们实现了一个单一的单一代码库,用于整个项目/公司。它是使用PHP和Composer进行单一代码库工作流程所缺失的部分。

关于Gregory Szorc博客上的更多细节

v0.12中的向后不兼容更改

在v0.12中,我们移除了 fiddler 脚本和构建PHAR存档的可能性。现在,该项目仅作为第一类Composer插件,并且需要Composer v1.1+才能使用 composer monorepo: 命令。

必须将 fiddler.json 文件重命名为 monorepo.json

如果您不想在项目中破坏这一点,请使用v0.11.6或更低版本。

安装

将composer monorepo插件添加到您的根composer.json中

$ composer require beberlei/composer-monorepo-plugin

它将被自动添加为Composer插件。

用法

每当Composer生成autoload文件(在安装、更新或dump-autoload期间)时,它将找到所有包含 monorepo.json 文件的子目录,并为它们生成子包autoload器。

您可以通过调用

$ composer monorepo:build

您在项目的根目录中创建一个 composer.json 文件,并使用此单一源代码库跨所有自己的包使用供应商库。

起初,这听起来与Composer方法相反,但它极大地简化了大项目的依赖关系管理。通常,如果您使用每个包的composer.json,您将会有大量更新狂潮,在10-20个包中更新一些基本库,如 "symfony/dependency-injection",或者有大量过时的包和许多不同版本。

然后,您的每个包都包含一个使用几乎与Composer相同的语法的 monorepo.json

{
    "deps": [
        "components/Foo",
        "vendor/symfony/symfony"
    ],
    "autoload": {
        "psr-0": {"Foo\\": "src/"}
    }
}

然后,您可以在composer.json旁边的根目录中运行 composer dump-autoload,此插件将检测所有包,并为每个包生成一个自定义的autoload器,就像子目录中存在composer.json一样模拟 composer dump-autoload

此插件将解决所有依赖项(不包含版本约束,因为假设代码在单体仓库中存在正确的版本)。

deps中的包名是从项目根目录开始的相对目录名,不是 Composer的包名。

您只需在每个包中require "vendor/autoload.php;,就像使用Composer一样。只包含来自monorepo.json的自动加载,这意味着所有依赖项都必须明确指定。

配置模式 monorepo.json

对于您单体仓库中的每个包,您必须添加一个monorepo.json文件,它借鉴了composer.json的格式。以下键是可用的

  • autoload - 配置当前包类和文件的自动加载设置。
  • autoload-dev - 配置开发自动加载需求。目前始终评估。
  • deps - 使用相对于项目根目录的相对路径作为包名,以数组形式配置所需的依赖项(不包含带有版本的键值对)。
  • deps-dev - 配置所需的开发依赖项

构建的Git集成

在单体仓库中,对于您想要知道哪个组件发生了变化的每个git提交范围,您可以使用git-changed?命令进行测试。

composer monorepo:git-changed? components/foo $TRAVIS_COMMIT_RANGE
if [ $? -eq 0 ]; then ant build fi