README

为 GrumPHP 检查器定制的 Magento 2 特定任务

安装

通过 composer 安装此包是最简单的方法

composer require --dev roma-glushko/grumphp-magento2

将扩展加载器添加到您的 grumphp.yml

parameters:
    extensions:
        - Glushko\GrumphpMagento2\Extension\Loader

使用

🛠 MagentoModuleRegistration

在 Magento 2 中提交 config.php 文件是一种常见做法。特别是，此文件对于管理模块非常有用。常见的问题是，在开发过程中，人们忘记将新添加的模块注册到 config.php 中，这可能导致难以调试的结果。此任务可以帮助监控此类情况，并在注册缺失时通知。

要使用此任务，只需在 grumphp.yml 中的 tasks: 部分指定此内容。

parameters:
    tasks:
        magento2-module-registration:
            composer_json_path: ~
            composer_home_path: ~
            configphp_path: ~
            allowed_package_types: ~
            custom_module_pattern: ~
            allowed_packages:
                magento/data-migration-tool: ["Magento_DataMigrationTool"]
                another-vendor/cool-module: ["AnotherVendor_CoolModule"]
            

composer_json_path

默认值：./composer.json

项目 composer.json 文件的路径。此文件将用于查找通过 Composer 安装的 Magento 模块。

composer_home_path

默认值：./var/composer_home

Composer 主目录的路径。

configphp_path

默认值：./app/etc/config.php

项目 config.php 文件的路径。

allowed_package_types

默认值：['magento2-module', 'magento2-component']

在检查包期间需要跟踪的 Magento 包类型。有时供应商没有指定包类型，但通常应该指定。

allowed_packages

默认值：["magento/data-migration-tool": ["Magento_DataMigrationTool"]]

如果模块供应商没有以正常方式创建模块（没有指定包类型或 psr-4 自动加载前缀与模块名称不同），此配置有助于监控此类包。数组的键是包名称。值是包提供的模块名称列表。

custom_module_pattern

默认值：./app/code/*/*/registration.php

一个 glob() 模式，有助于找到自定义的非 Composer Magento 模块。

🛠 MagentoLogNotification

当您最近在 Magento 日志中添加记录时，这非常有用。此任务检查位于 log_patterns 下的日志文件，并在 record_stale_threshold 定义的时间段内添加了日志时通知。配置 exclude_severities 帮助减少嘈杂的记录。

parameters:
    tasks:
        magento2-log-notification:
            log_patterns:
              - "./var/*/*.log"
            record_stale_threshold: 1 # in days
            exclude_severities:
              - "INFO"
              - "DEBUG"

log_patterns

默认值：./var/*/*.log

应监控日志文件的路径。

record_stale_threshold

默认值：1

旧记录的陈旧阈值（以天为单位），这有助于忽略日志中的旧记录。

exclude_severities

默认值：INFO, DEBUG

此配置排除了具有指定严重级别的记录。