vertex-it/php-cs

Vertex IT shared PHP style rules for PHP-CS-Fixer

v1.1.7 2022-02-10 10:12 UTC

Requires

• friendsofphp/php-cs-fixer: v3.6.0

MIT

README

Vertex IT shared PHP style rules for PHP-CS-Fixer

Installation

First install the package in the "tools" directory:

mkdir --parents tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer vertex-it/php-cs:dev-master

After installation copy the file src/.php-cs-fixer.dist.php to the root of your project:

cp tools/php-cs-fixer/vendor/vertex-it/php-cs/src/.php-cs-fixer.dist.php .php-cs-fixer.dist.php

Usage

To run the PHP CS Fixer use the command

tools/php-cs-fixer/vendor/bin/php-cs-fixer fix

Integration with PHPStorm

To enable PHP CS Fixer inspections in PHPStorm run these steps:

1. Set up PHP interpreter.
2. In Settings > PHP > Quality tools > PHP CS Fixer choose your PHP interpreter and set path to cs fixer "tools/php-cs-fixer/vendor/bin/php-cs-fixer".
3. Go to Settings > Editor > Inspections and enable PHP CS Fixer validation. Select "Custom" for Ruleset, and select path ".php-cs-fixer.dist.php" from the root of the project.