Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roma-glushko/grumphp-magento2
Magento 2 specific tasks for GrumPHP checker
https://github.com/roma-glushko/grumphp-magento2
grumphp-task magento magento2 static-analysis
Last synced: about 2 months ago
JSON representation
Magento 2 specific tasks for GrumPHP checker
- Host: GitHub
- URL: https://github.com/roma-glushko/grumphp-magento2
- Owner: roma-glushko
- License: mit
- Created: 2019-09-15T20:26:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-07T15:08:15.000Z (over 4 years ago)
- Last Synced: 2024-10-10T19:39:38.927Z (2 months ago)
- Topics: grumphp-task, magento, magento2, static-analysis
- Language: PHP
- Size: 39.1 KB
- Stars: 6
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grumphp-magento2
[](https://packagist.org/packages/roma-glushko/grumphp-magento2) [](https://packagist.org/packages/roma-glushko/grumphp-magento2)
Magento 2 specific tasks for GrumPHP checker
## Installation
The easiest way to install this package is through composer:
```bash
composer require --dev roma-glushko/grumphp-magento2
```
Add the extension loader to your `grumphp.yml`
```yaml
parameters:
extensions:
- Glushko\GrumphpMagento2\Extension\Loader
```
## Usage
### 🛠MagentoModuleRegistration
It's a common practice to commit config.php file in Magento 2. Especially, the file is useful for managing modules. The common issue is when during development people forget to register newly added modules to the config.php which can lead to outcomes that hard to troubleshoot. This task helps to watch for such cases and let to know when registration is missing.
To use this task, just specify this inside `grumphp.yml` in the `tasks:` section.
```yaml
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**
*Default: `./composer.json`*
Path to composer.json file of the project.
This file will be used to find Magento modules installed via Composer.
**composer_home_path**
*Default: `./var/composer_home`*
Path to Composer Home directory.
**configphp_path**
*Default: `./app/etc/config.php`*
Path to config.php file of the project.
**allowed_package_types**
*Default: `['magento2-module', 'magento2-component']`*
Magento package types that we need to track during checking of packages.
Sometimes vendors don't specify package type, but normally they should.
**allowed_packages**
*Default: `["magento/data-migration-tool": ["Magento_DataMigrationTool"]]`*
In case module vendor did not created a module in a normal way (no package type was specified or psr-4 autoloader prefix is different then module name), this config helps to watch for such packages.
Key of the array is a package name. The value is a list of module names that the package brings.
**custom_module_pattern**
*Default: `./app/code/*/*/registration.php`*
A glob() pattern that helps to find custom non-composer magento modules.
### 🛠MagentoLogNotification
It's useful to be notified when you have recently added records in Magento logs. This tasks checks log files located
under `log_patterns` and informs if there are logs that have been added inside of time frame defined in `record_stale_threshold`.
The `exclude_severities` helps to reduce noisy records.
```yaml
parameters:
tasks:
magento2-log-notification:
log_patterns:
- "./var/*/*.log"
record_stale_threshold: 1 # in days
exclude_severities:
- "INFO"
- "DEBUG"
```
**log_patterns**
*Default: `./var/*/*.log`*
Paths where log files should be watched
**record_stale_threshold**
*Default: `1`*
Stale threshold (in days) that helps to ignore old records in logs.
**exclude_severities**
*Default: `INFO, DEBUG`*
This config excludes records with specified severity levels.