PHP-CS-Fixer v3.x migration guide for custom configuration

.php-cs-fixer.php

<?php

$config = new \PhpCsFixer\Config();
$config->setRules([
    '@PSR2' => true,
    'array_indentation' => true,
    'array_syntax' => ['syntax' => 'short'],
    'combine_consecutive_unsets' => true,
    'class_attributes_separation' => ['elements' => ['method' => 'one']],
    'multiline_whitespace_before_semicolons' => true,
    'single_quote' => true,
    'binary_operator_spaces' => [],
    'braces' => [
        'allow_single_line_closure' => true,
    ],
    'concat_space' => ['spacing' => 'none'],
    'declare_equal_normalize' => true,
    'function_typehint_space' => true,
    'single_line_comment_style' => ['comment_types' => ['hash']],
    'include' => true,
    'lowercase_cast' => true,
    'no_extra_blank_lines' => [
        'tokens' => [
            'curly_brace_block',
            'extra',
            'parenthesis_brace_block',
            'square_brace_block',
            'throw',
            'use',
        ],
    ],
    'no_multiline_whitespace_around_double_arrow' => true,
    'no_spaces_around_offset' => true,
    'no_unused_imports' => true,
    'ordered_imports' => ['sort_algorithm' => 'alpha'],
    'no_whitespace_before_comma_in_array' => true,
    'no_whitespace_in_blank_line' => true,
    'object_operator_without_whitespace' => true,
    'phpdoc_order' => false,
    'phpdoc_summary' => true,
    'return_type_declaration' => ['space_before' => 'one'],
    'single_blank_line_before_namespace' => true,
    'ternary_operator_spaces' => true,
    'trim_array_spaces' => true,
    'trailing_comma_in_multiline' => ['elements' => ['arrays']],
    'unary_operator_spaces' => true,
    'whitespace_after_comma_in_array' => true,
    'function_declaration' => true,
    'indentation_type' => true,
    'no_spaces_after_function_name' => true,
    'no_spaces_inside_parenthesis' => true,
    'not_operator_with_successor_space' => true,
])
    ->setLineEnding("\n")
    ->setUsingCache(false);

return $config;

README.md

Recently (27/07/2021) I have updated my PHP-CS-Fixer to 3.x. I found out there are a lot of things updated from 2.x to 3.x. This gist is about the new configuration file I made, following the migration guide.

Basically, I ran this command PHP_CS_FIXER_FUTURE_MODE=1 php-cs-fixer fix, and fixed the issues given on console.

I used to use a custom .php_cs configuration from zaratedev/.php_cs. I had to rename the file from .php_cs to .php-cs-fixer.php as a cricial change mentioned on migration guide.

Useful links:

• https://mlocati.github.io/php-cs-fixer-configurator/
• https://reposhub.com/php/code-analysis/FriendsOfPHP-PHP-CS-Fixer.html