README

EsfahanAhan PHP-CS-Fixer configuration

The default PHP-CS-Fixer configuration for EsfahanAhan projects.

Installation

composer require --dev esfahanahan/php-cs-fixer-config

Usage

Basic usage

.php-cs-fixer.php

<?php

require 'vendor/autoload.php';

return EsfahanAhan\PhpCsFixer\Config::fromFolders(['src']);

To exclude a subfolder:

<?php

require 'vendor/autoload.php';

return EsfahanAhan\PhpCsFixer\Config::fromFolders(['src'], null, ['ignoreThisDir']);

This will skip src/ignoreThisDir or src/foo/bar/ignoreThisDir. (The folder has to be relative to the ones in the first argument.)

You can also override rules per-project without overriding the core rules like this:

.php-cs-fixer.php

<?php

require 'vendor/autoload.php';

return EsfahanAhan\PhpCsFixer\Config::fromFolders(['src'])->mergeRules([
   'php_unit_strict' => false,
]);

Usage within a Laravel project

You can also preconfigure the configuration for a Laravel project by calling a special factory method:

.php-cs-fixer.php

<?php

require 'vendor/autoload.php';

return EsfahanAhan\PhpCsFixer\Config::forLaravel();

If need be, you can also append folders to fix in addition to Laravel's:

.php-cs-fixer.php

<?php

require 'vendor/autoload.php';

return EsfahanAhan\PhpCsFixer\Config::forLaravel(['some_other_folder']);

Targeting a specific PHP version

By default, the configuration will check the version of PHP you run the tool with, and proceed to enable/disable fixers depending on it.

You can override the target PHP version by passing it either as constructor argument, or as second argument to fromFolders:

.php-cs-fixer.php

<?php

require 'vendor/autoload.php';

return EsfahanAhan\PhpCsFixer\Config::fromFolders(['src'], '8.3');

// or

return EsfahanAhan\PhpCsFixer\Config::forLaravel([], '8.3');