and/isolate-composer

通过为项目内所有供应商代码的命名空间添加前缀来隔离composer依赖

1.1 2022-06-08 14:16 UTC

This package is auto-updated.

Last update: 2024-09-08 20:21:59 UTC


README

此插件的功能

此插件将所有供应商命名空间前缀为一个选定的值。这包括所有声明的命名空间、use语句、完全限定引用以及大多数引用命名空间的字符串值。

所有供应商代码和composer自动加载映射都更新为引用前缀命名空间。

此插件不做什么

它不会触及您项目中的任何代码。它只影响供应商目录中的代码,并且只影响引用受影响命名空间的代码。如果您将此应用于现有项目,则必须自己更新代码中的所有引用。

为什么我想使用这个?

此插件允许您在同一运行时运行两个利用composer依赖的项目,无需担心冲突的依赖项。最常见的例子是在WordPress环境中,所有插件都在同一运行时执行,并且可能依赖于相同的composer依赖项。每个使用此插件的项目的代码不能与其他任何项目冲突,除非供应商代码没有命名空间(在这种情况下,选择很少……)。

用法

使用此插件很简单。通过在项目中引入它来安装插件:composer require and/isolate-composer

通过添加以下内容到您的composer.json来配置插件

"config" : {
    "isolate": {
      "prefix": "Your\\Prefix\\Here\\",
      "blacklist": [],
      "autorun": false,
      "require-dev": false,
      "replacements" : {}
    }
}

唯一必需的值是prefix

配置插件后,运行隔离

composer isolate
composer dump

您的供应商代码现在已添加前缀!

确保在isolate之后进行dump,否则您的自动加载映射将不正确!

配置

prefix

这是将被添加到所有供应商命名空间的前缀值。它应该是一个有效的命名空间,并且应该对您的项目是唯一的。我建议您不要使用主项目命名空间,或者至少在末尾添加\\Vendor

blacklist

这是一个您不想添加前缀的包列表。匹配的包将不会扫描命名空间,但如果它包含来自其他未列入黑名单包的命名空间,则代码仍将被重写。

autorun

将此值设置为true将在每次dump之前自动运行隔离过程。

require-dev

默认情况下,只有require包会被扫描命名空间,而require-dev包将被忽略(如上所述,如果它们包含来自其他包的命名空间,则仍将被重写)。

将此值设置为true将包括require-dev包在扫描中,并且任何找到的命名空间都将被前缀。

replacements

这是一个手动修复供应商代码中的问题的位置,这些问题要么未被检测到和替换,要么在不应该替换时被替换。

解析和重写每个文件后,如果替换列表中有条目,它将对文件执行字符串替换。

字符串替换应该是幂等的,否则在多次执行中会出问题。

语法是

"replacements" : {
    "path/relative/to/vendor/root/file.php" : {
        "search" : "replace",
        "search" : "replace",
    },
    "path/relative/to/vendor/root/file.php" : {
            "search" : "replace",
            "search" : "replace",
        }
}