PrettyPHP.php

<?php

namespace romanzipp\Fixer\Presets;

class PrettyPHP extends AbstractPreset
{
    public function getRules(): array
    {
        return [
            '@Symfony' => true,                         // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/ruleSets/Symfony.rst
            'array_indentation' => true,                // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/whitespace/array_indentation.rst
            // see https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues/4487
            'braces' => true,                           // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/basic/braces.rst
            'concat_space' => [                         // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/operator/concat_space.rst
                'spacing' => 'one',
            ],
            'no_superfluous_phpdoc_tags' => false,      // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/phpdoc/no_superfluous_phpdoc_tags.rst
            'no_useless_return' => true,                // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/return_notation/no_useless_return.rst
            'not_operator_with_space' => true,          // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/operator/not_operator_with_space.rst
            'phpdoc_align' => [                         // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/phpdoc/phpdoc_align.rst
                'align' => 'left',
            ],
            'phpdoc_return_self_reference' => [         // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/phpdoc/phpdoc_return_self_reference.rst
                'replacements' => [
                    'this' => 'self',
                    '@this' => 'self',
                    '$self' => 'self',
                    '@self' => 'self',
                    '$static' => 'static',
                    '@static' => 'static',
                ],
            ],
            'phpdoc_no_alias_tag' => [                  // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/phpdoc/phpdoc_no_alias_tag.rst
                'replacements' => [
                    'type' => 'var',
                    'link' => 'see',
                ],
            ],
            'phpdoc_order' => true,                     // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/phpdoc/phpdoc_order.rst
            'phpdoc_to_comment' => false,               // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/phpdoc/phpdoc_to_comment.rst
            'fully_qualified_strict_types' => [         // https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/import/fully_qualified_strict_types.rst
                'import_symbols' => false,
                'phpdoc_tags' => [],
                'leading_backslash_in_global_namespace' => true,
            ],
        ];
    }

    protected function getFilePatterns(): array
    {
        return [
            '*.php',
            '.php_cs',
            '.php_cs.dist',
            '.php-cs-fixer.php',
            '.php-cs-fixer.dist.php',
        ];
    }

    protected function getExcludedDirectories(): array
    {
        return [
            'vendor',
        ];
    }

    protected function getExcludedFiles(): array
    {
        return [];
    }
}