README

此包允许对 Magento 2 模块包进行静态分析，以提供包的完整性检查。

支持的工具

• Composer.json 包依赖检查器 - 检查主题中的 *.xml, *.js, *.php 和 *.phtml，如果使用了其他包，并检查相应的模块/包是否已在 composer.json 中声明为必需。
• Module.xml 依赖检查器 - 分析包的 etc/module.xml 文件是否在 'sequence' 部分包含所有在 *.xml, *.js, *.php 和 *.phtml 文件中使用的 Magento 2 模块。
• 包结构检查器 - 验证所有新添加的 Magento 2 模块是否具有所有必需文件的正确结构。

独立安装

1. 将您的访问令牌添加到 auth.json（请参阅如何创建访问令牌）。

composer config --global --auth gitlab-token.gitlab.com {ACCESS_TOKEN}

1. 从 Gitlab 仓库安装项目

composer create-project run_as_root/integrity-checker --repository-url="{\"type\": \"vcs\", \"url\": \"git@gitlab.com:oleksandr.kravchuk1/integrity-checker.git\"}" -s dev integrity-checker dev-development --remove-vcs

包安装

1. 将 Gitlab 仓库添加到项目的 composer.json 中可用的仓库列表

composer config repositories.integrity-checker '{"type": "vcs", "url": "git@gitlab.com:oleksandr.kravchuk1/integrity-checker.git"}'

1. 将您的访问令牌添加到 auth.json（请参阅如何创建访问令牌）。

composer config --global --auth gitlab-token.gitlab.com {ACCESS_TOKEN}

1. 将包的最小稳定性更改为 dev（仅在开发期间需要）。

composer config minimum-stability dev 

1. 通过 composer 安装包

composer require --dev run_as_root/integrity-checker dev-development

用法

依赖检查器

bin/dependencies {magento root} {folder} {folder2} {folder3}

{magento root} - Magento 2 项目根目录的路径。工具需要定义 composer.lock。{folder} 中的所有包将通过 composer.json 文件被识别。{folder} - 预期在 magento 根文件夹内部相对。依赖检查将针对 composer.json 和 etc/module.xml 一起运行。

模块结构检查器

bin/structure {magento root} {folder} {folder2} {folder3}

{magento root} - Magento 2 项目根目录的路径。工具通过 registration.php 文件收集 {folder} 中的所有包。对于每个模块，它将当前结构与标准结构进行比较，并打印差异，如果未遵循标准结构。

标准包结构

docs
src
  etc
    module.xml
README.md
composer.json
registration.php