php-cs-fixer.php

<?php

declare(strict_types=1);

/**
 * Derafu: Foundation - Base for Derafu's Projects.
 *
 * Copyright (c) 2025 Esteban De La Fuente Rubio / Derafu <https://www.derafu.org>
 * Licensed under the MIT License.
 * See LICENSE file for more details.
 */

/**
 * Configuration file for PHP CS Fixer.
 */

use PhpCsFixer\Config;
use PhpCsFixer\Finder;

$dir = __DIR__;

$finder = Finder::create()
    ->in($dir)
    ->exclude('var')
;

return (new Config())
    // Allow risky rules that may change code logic.
    ->setRiskyAllowed(true)
    // Based on PSR-12, the latest style recommendation.
    ->setRules([
        '@PSR12' => true,
        // Add "declare(strict_types=1);" to files.
        // This adds it like <?php declare(strict_types=1); however, it is
        // recommended to edit or add it manually on separate lines.
        'declare_strict_types' => true,
        // Indent using spaces.
        'indentation_type' => true,
        // Sort "use" statements alphabetically.
        'ordered_imports' => [
            'sort_algorithm' => 'alpha',
        ],
        // Remove unused imports.
        'no_unused_imports' => true,
        // One import per statement.
        'single_import_per_statement' => true,
        // Convert arrays to short syntax "[]".
        'array_syntax' => [
            'syntax' => 'short',
        ],
        // Add trailing commas in multi-line arrays.
        'trailing_comma_in_multiline' => true,
        // Separate constants and properties.
        'class_attributes_separation' => [
            'elements' => [
                'const' => 'one',
                'property' => 'one',
                'method' => 'one',
            ],
        ],
        // Replace strpos with a boolean-returning function.
        // Example: use str_contains().
        'modernize_strpos' => true,
        // Convert anonymous functions to arrow functions.
        'use_arrow_functions' => true,
        // Use PHPUnit constructors instead of factory methods.
        'php_unit_construct' => true,
        // Use stricter assertions in PHPUnit.
        // Example: use assertSame() instead of assertEquals().
        'php_unit_strict' => true,
    ])
    ->setLineEnding("\n")
    ->setCacheFile($dir . '/var/cache/php-cs-fixer.cache')
    ->setFinder($finder)
;