Download the PHP package eonx-com/easy-quality without Composer
On this page you can find all versions of the php package eonx-com/easy-quality. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download eonx-com/easy-quality
More information about eonx-com/easy-quality
Files in eonx-com/easy-quality
Package easy-quality
Short Description Makes using of code quality tools for PHP projects of EonX easier
License MIT
Informations about the package easy-quality
---eonx_docs--- title: Introduction weight: 0 ---eonx_docs---
This package is a way to centralise reusable classes used for coding standards and quality tools. It contains:
Install (separately from the project's composer.json file)
- Create a
quality
directory in your project root. - Go to the
quality
directory and runcomposer require eonx-com/easy-quality
. - Set env variables to speed up local execution:
EONX_EASY_QUALITY_JOB_SIZE
- number of files to process in parallel (default: 2)EONX_EASY_QUALITY_MAX_NUMBER_OF_PROCESS
- maximum number of parallel processes (default: 4)EONX_EASY_QUALITY_TIMEOUT_SECONDS
- timeout in seconds for each process (default: 120)
- Add
quality/vendor
to Git ignore (either in a.gitignore
file inside thequality
directory or in you project's root.gitignore
file). -
Update your project's
composer.json
file by adding a post-install script (this will automate an installation ofeonx-com/easy-quality
on all the local machines): -
Update your project's
composer.json
file by adding the following scripts. Here we useveewee/composer-run-parallel
(install it as a dev dependency) for thecheck-all
script to run multiple commands in parallel. Feel free to modiy these commands as you wish. - Make sure you have config files for ECS, Rector, PHP Mess Detector, and PHPStan in the project source code root.
- Run
composer check-all
from the project source code root to make sure everything is working and fix the found issues. - If you want to use the quality tools in CI, here is an example of a GitHub action configuration:
Prepare configuration file for ECS (Easy Coding Standard) Sniffs
Create a configuration file for ECS in the quality
folder of the project.
For example see quality/ecs.php.
Run ECS check
Go to the root folder of the project and run
or
Expected output:
Prepare configuration file for Rector
Create a configuration file for Rector in the quality
folder of the project.
For example see quality/rector.php.
Run Rector check
Go to the root folder of the project and run
or
Expected output:
All versions of easy-quality with dependencies
jangregor/phpstan-prophecy Version 1.0.2
phpmd/phpmd Version 2.15.0
phpmetrics/phpmetrics Version ^2.8
phpstan/phpdoc-parser Version 1.32.0
phpstan/phpstan Version 1.12.5
rector/rector Version 1.2.5
slevomat/coding-standard Version 8.15.0
symplify/easy-coding-standard Version 12.3.5
symplify/phpstan-extensions Version 11.4.3
symplify/phpstan-rules Version 13.0.1