.php-cs-fixer.dist.php

<?php

/**
 * @noinspection PhpUndefinedNamespaceInspection
 * @noinspection PhpUndefinedClassInspection
 */

declare(strict_types=1);

use PhpCsFixer\Config;
use PhpCsFixer\Finder;

/**
 * Namespace root.
 *
 * Used to ensure compliant classnames for classes that use PSR-4 autoloading.
 */
$namespaceRoot = './src';

/**
 * Rulesets and overrides.
 */
$rules = [
    '@PER'                                   => true,
    '@PER:risky'                             => true,
    '@PSR1'                                  => true,
    '@PSR12'                                 => true,
    '@PSR12:risky'                           => true,
    '@Symfony'                               => true,
    '@Symfony:risky'                         => true,
    'blank_line_after_opening_tag'           => false, // due to WordPress
    'class_definition'                       => [
        'space_before_parenthesis' => true,
        'single_line'              => true,
    ],
    'method_argument_space'                  => [
        'on_multiline' => 'ensure_fully_multiline',
    ],
    'ordered_imports'                        => [
        'imports_order'  => [
            'class',
            'function',
            'const',
        ],
        'sort_algorithm' => 'alpha',
    ],
    'echo_tag_syntax'                        => [
        'format' => 'short',
    ],
    'single_class_element_per_statement'     => [
        'elements' => ['property'],
    ],
    'not_operator_with_successor_space'      => true,
    'single_quote'                           => [
        'strings_containing_single_quote_chars' => true,
    ],
    'class_attributes_separation'            => [
        'elements' => [
            'const'        => 'one',
            'method'       => 'one',
            'property'     => 'one',
            'trait_import' => 'none',
        ],
    ],
    'combine_consecutive_unsets'             => true,
    'combine_consecutive_issets'             => true,
    'concat_space'                           => [
        'spacing' => 'one',
    ],
    'no_trailing_comma_in_singleline_array'  => true,
    'array_syntax'                           => [
        'syntax' => 'short',
    ],
    'align_multiline_comment'                => true,
    'array_indentation'                      => true,
    'binary_operator_spaces'                 => [
        'default'   => 'single_space',
        'operators' => [
            '='  => 'align_single_space_minimal',
            '=>' => 'align_single_space_minimal',
        ],
    ],
    'blank_line_before_statement'            => [
        'statements' => [
            'break',
            'case',
            'continue',
            'declare',
            'default',
            'exit',
            'goto',
            'include',
            'include_once',
            'require',
            'require_once',
            'return',
            'switch',
            'throw',
            'try',
        ],
    ],
    'doctrine_annotation_spaces'             => true,
    'escape_implicit_backslashes'            => true,
    'explicit_indirect_variable'             => true,
    'explicit_string_variable'               => true,
    'global_namespace_import'                => [
        'import_classes'   => true,
        'import_constants' => true,
        'import_functions' => true,
    ],
    'heredoc_to_nowdoc'                      => true,
    'method_chaining_indentation'            => true,
    'multiline_comment_opening_closing'      => true,
    'multiline_whitespace_before_semicolons' => [
        'strategy' => 'no_multi_line',
    ],
    'no_alternative_syntax'                  => [
        'fix_non_monolithic_code' => false,
    ],
    'no_extra_blank_lines'                   => [
        'tokens' => [
            'break',
            'case',
            'continue',
            'curly_brace_block',
            'default',
            'extra',
            'parenthesis_brace_block',
            'return',
            'square_brace_block',
            'switch',
            'throw',
            'use',
            'attribute',
        ],
    ],
    'no_null_property_initialization'        => true,
    'no_superfluous_elseif'                  => true,
    'no_trailing_comma_in_list_call'         => true,
    'no_useless_else'                        => true,
    'no_useless_return'                      => true,
    'operator_linebreak'                     => [
        'only_booleans' => true,
    ],
    'php_unit_internal_class'                => true,
    'php_unit_test_class_requires_covers'    => true,
    'phpdoc_add_missing_param_annotation'    => true,
    'phpdoc_no_empty_return'                 => true,
    'phpdoc_order_by_value'                  => true,
    'phpdoc_to_comment'                      => false,
    'phpdoc_var_annotation_correct_order'    => true,
    'psr_autoloading'                        => [
        'dir' => $namespaceRoot,
    ],
    'return_assignment'                      => true,
];

/**
 * Directories to exclude.
 */
$dirs = [
    __DIR__ . '/src',
    __DIR__ . '/tests',
    __DIR__ . '/wp-content/themes/socialbrothers'
];

/**
 * Cache dir and file location.
 */
$cacheDirectory = __DIR__ . '/.var/cache';
$cacheFile      = "{$cacheDirectory}/.php-cs-fixer.cache";

/**
 * Create a .cache dir if not already present.
 */
if (!file_exists($cacheDirectory) && !mkdir($cacheDirectory, 0700) && !is_dir($cacheDirectory)) {
    throw new RuntimeException(
        sprintf('Directory "%s" was not created', $cacheDirectory)
    );
}

return (new Config())
    ->setRules($rules)
    ->setRiskyAllowed(true)
    ->setCacheFile($cacheFile)
    ->setFinder(
        Finder::create()
              ->name(['/\.?.*.php/'])
              ->in($dirs)
    );