prooxxy/magento2-composer-constraints

一个为 Magento 2 添加相关性的 app/code 目录下 composer.json 文件的插件

2.0.0 2021-04-05 12:34 UTC

This package is auto-updated.

Last update: 2024-09-05 20:35:59 UTC


README

这是一个为 Magento 2 定制的 composer 插件,用于验证 propriatary app/code 模块 composer.json 文件中的约束与已安装的包。

在创建此插件时,Magento 建议在创建组件时添加 composer.json 文件。

我们建议您即使在无意将组件分发给使用 Magento 的其他商家的情况下,也应在组件的根目录中包含 composer.json。

然而,如果您的模块位于 app/code 目录中,这并不重要。您可以声明所有想要的约束,但随着项目的增长,您可能会忘记这些约束。

此插件的目标是使 app/code/Vendor/Module/composer.json 对开发者有意义。

功能

运行 composer install 后,将显示违反依赖关系的模块列表。

Platform requirement violations

该插件将扫描并验证 app/code 包及其依赖项,如果包版本不满足条件则发出警告。

由于此插件将 app/code 模块视为内存中的 composer 包,因此它可以在这些模块之间进行交叉检查。这意味着插件不仅会检查平台和 "vendor" 包,还可以扫描其他 app/code 模块,就像它们是真正的包一样。

安装

composer require prooxxy/magento2-composer-constraints

常见问题解答

我的模块没有显示在列表中

该插件仅显示具有依赖违反的模块。

也可能是因为您的模块的 composer.json 文件中没有 "version" 标签。这是 composer 解析器的需求。

如果检测到任何违反,此插件是否会阻止安装或以其他方式阻碍?

不会

我如何知道插件是否检测到我的模块?

运行带有 -v 标志的 composer,即使没有违反的模块也应该会显示。

我发现了一个错误!

太好了!提交一个错误报告!

路线图

  1. 验证与 2.4 的兼容性
  2. 插件应检测并尊重 "--ignore-platform-reqs"
  3. 插件应检查 require-dev 链接

兼容性矩阵

许可证

MIT