Download the PHP package creatuity/magento-quality-tools without Composer
On this page you can find all versions of the php package creatuity/magento-quality-tools. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download creatuity/magento-quality-tools
More information about creatuity/magento-quality-tools
Files in creatuity/magento-quality-tools
Package magento-quality-tools
Short Description The composer package basing on GrumPHP tool with pre-defined configuration for Magento projects
License
Informations about the package magento-quality-tools
GRUMPHP
Installation
DO NOT create a grumphp.yml
file in the root directory when you will be prompted
Add the following to your composer.json
According to the issue with Magento Coding Standard package it's also needed to add this to your composer.json
file
and run composer install
to apply the changes.
Usage
- Make sure that your changes are in GIT staging area.
- When you want to commit your changes, type.
to run tasks defined in grumphp.yml
only on the code from the commit.
This command will be also run when you try to do a commit - it uses git pre-commit hook.
Built-in tasks
This package has pre-defined configuration of grumphp.yml
file, thanks for that you can install
and just use it. Currently, the package contains these tasks :
- jsonlint
- xmllint
- phplint
- yamllint
- composer
- phpcs
- phpcsfixer2
- phpmd
- phpstan - Currently the level is set to 6
- git_commit_message - This task validates a message in a commit. Allowed length of body and subject
is limited to 120 characters. It also requires to begin a message from a task number, example -
[PROJECTX-123] Test commit
- git_branch_name - The task validates a branch name. It allows to use two type of branch names:
- Task branches - which starts from
hotfix|bugfix|feature
prefix and contains a task number and short description, example -feature/PROJECTX-short-description
- Release branches -
release/0.1.1
- Task branches - which starts from
- git_blacklist - This task checks if a developer didn't use one of blacklisted words like
var_dump
orconsole.log
Compatibility
- Magento >= 2.4.2
- PHP version >= 7.2 || >= 8.1
Known Issues
- If you're getting an error like this one :
check this issue on the Github https://github.com/magento/magento2/issues/33430
All versions of magento-quality-tools with dependencies
phpstan/phpstan Version 1.8.*
phpstan/extension-installer Version ^1.1
bitexpert/phpstan-magento Version ^0.24.0
overtrue/phplint Version ^3.1
friendsofphp/php-cs-fixer Version ~2.16 || ~3.3
magento/magento-coding-standard Version *
squizlabs/php_codesniffer Version ^3.5.4
php-parallel-lint/php-parallel-lint Version ^1.3
phpmd/phpmd Version ^2.12
phpro/grumphp-shim Version ^1.13
symfony/yaml Version ~5.3 || ~6.0
seld/jsonlint Version ^1.9