Download the PHP package eonx-com/easy-quality without Composer

---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:

• Rectors
• Sniffs

Install (separately from the project's composer.json file)

1. Create a quality directory in your project root.
2. Go to the quality directory and run composer require eonx-com/easy-quality.
3. 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)
4. Add quality/vendor to Git ignore (either in a .gitignore file inside the quality directory or in you project's root .gitignore file).

5. Update your project's composer.json file by adding a post-install script (this will automate an installation of eonx-com/easy-quality on all the local machines):

6. Update your project's composer.json file by adding the following scripts. Here we use veewee/composer-run-parallel (install it as a dev dependency) for the check-all script to run multiple commands in parallel. Feel free to modiy these commands as you wish.

7. Make sure you have config files for ECS, Rector, PHPStan, and Qualimetrix.
8. Run composer check-all from the project source code root to make sure everything is working and fix the found issues.
9. 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:

Configure PhpStorm to match ECS sorting

The ECS set sorts class members via OrderedClassElementsFixer. To make PhpStorm's Code | Reformat Code (with Rearrange entries) produce exactly the same order, copy the code style scheme shipped with this package into your project:

See docs/phpstorm/settings.md for details (including why this cannot be done via .editorconfig).

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:

Using phpmetrics checker

Run

An example of pmc.json config file:

Using Qualimetrix checker

Create a configuration file for Qualimetrix in the quality folder of the project, e.g. quality/qmx.yaml.

Run

Expected output:

A short example of qmx.yaml config file, checking only coupling and complexity:

See the Qualimetrix documentation for the full list of rules and configuration options.