ecs.php

<?php

declare(strict_types=1);

use PhpCsFixer\Fixer\Casing\NativeFunctionCasingFixer;
use PhpCsFixer\Fixer\FunctionNotation\NativeFunctionInvocationFixer;
use PhpCsFixer\Fixer\Import\FullyQualifiedStrictTypesFixer;
use PhpCsFixer\Fixer\Import\GlobalNamespaceImportFixer;
use PhpCsFixer\Fixer\Phpdoc\GeneralPhpdocAnnotationRemoveFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocLineSpanFixer;
use PhpCsFixer\Fixer\StringNotation\SimpleToComplexStringVariableFixer;
use PhpCsFixer\Fixer\Whitespace\IndentationTypeFixer;
use PhpCsFixer\Fixer\Whitespace\MethodChainingIndentationFixer;
use SlevomatCodingStandard\Sniffs\Arrays\DisallowImplicitArrayCreationSniff;
use SlevomatCodingStandard\Sniffs\Classes\DisallowLateStaticBindingForConstantsSniff;
use SlevomatCodingStandard\Sniffs\Classes\UselessLateStaticBindingSniff;
use SlevomatCodingStandard\Sniffs\ControlStructures\RequireNullCoalesceOperatorSniff;
use SlevomatCodingStandard\Sniffs\Exceptions\DeadCatchSniff;
use SlevomatCodingStandard\Sniffs\Exceptions\ReferenceThrowableOnlySniff;
use SlevomatCodingStandard\Sniffs\Functions\StaticClosureSniff;
use SlevomatCodingStandard\Sniffs\Namespaces\ReferenceUsedNamesOnlySniff;
use SlevomatCodingStandard\Sniffs\Namespaces\UseFromSameNamespaceSniff;
use SlevomatCodingStandard\Sniffs\PHP\OptimizedFunctionsWithoutUnpackingSniff;
use SlevomatCodingStandard\Sniffs\PHP\UselessParenthesesSniff;
use SlevomatCodingStandard\Sniffs\PHP\UselessSemicolonSniff;
use SlevomatCodingStandard\Sniffs\Variables\DuplicateAssignmentToVariableSniff;
use SlevomatCodingStandard\Sniffs\Variables\UselessVariableSniff;
use Symplify\CodingStandard\Fixer\ArrayNotation\StandaloneLineInMultilineArrayFixer;
use Symplify\CodingStandard\Fixer\Commenting\ParamReturnAndVarTagMalformsFixer;
use Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;
use Symplify\EasyCodingStandard\ValueObject\Set\SetList;

# see https://github.com/symplify/easy-coding-standard
return static function (ECSConfig $ecsConfig): void {
    $ecsConfig->paths([
        __DIR__ . '/src',
        __DIR__ . '/ecs.php',
        // @todo add /tests
    ]);

    $ecsConfig->sets([
        # pick anything from https://github.com/symplify/easy-coding-standard#use-prepared-checker-sets
        SetList::PSR_12,
        SetList::COMMON,
        SetList::CLEAN_CODE,
        SetList::ARRAY,
        SetList::STRICT,
        SetList::SYMPLIFY,
        SetList::CONTROL_STRUCTURES,
    ]);

    $ecsConfig->skip([
        ReferenceUsedNamesOnlySniff::class . '.' . ReferenceUsedNamesOnlySniff::CODE_REFERENCE_VIA_FULLY_QUALIFIED_NAME_WITHOUT_NAMESPACE,
        ReferenceUsedNamesOnlySniff::class . '.' . ReferenceUsedNamesOnlySniff::CODE_PARTIAL_USE,

        # breaks code
        ReferenceThrowableOnlySniff::class . '.' . ReferenceThrowableOnlySniff::CODE_REFERENCED_GENERAL_EXCEPTION,
    ]);

    $ecsConfig->rule(MethodChainingIndentationFixer::class);

    $ecsConfig->ruleWithConfiguration(GeneralPhpdocAnnotationRemoveFixer::class, [
        'annotations' => ['author', 'package', 'group', 'autor', 'covers'],
    ]);

    # add preslash to every native function, to speedup process, e.g. \count()
    $ecsConfig->ruleWithConfiguration(NativeFunctionInvocationFixer::class, [
        'include' => [NativeFunctionInvocationFixer::SET_ALL],
    ]);

    # limit line length to 120 chars
    $ecsConfig->rule(LineLengthFixer::class);

    # imports FQN names
    $ecsConfig->ruleWithConfiguration(ReferenceUsedNamesOnlySniff::class, [
        'searchAnnotations' => true,
        'allowFullyQualifiedGlobalFunctions' => true,
        'allowFullyQualifiedGlobalConstants' => true,
        'allowPartialUses' => false,
    ]);

    # make @var annotation into doc block
    $ecsConfig->rule(PhpdocLineSpanFixer::class);

    $ecsConfig->rule(MethodChainingIndentationFixer::class);

    # array - item per line
    $ecsConfig->rule(StandaloneLineInMultilineArrayFixer::class);

    # make @param, @return and @var format united
    $ecsConfig->rule(ParamReturnAndVarTagMalformsFixer::class);

    # use 4 spaces to indent
    $ecsConfig->rule(IndentationTypeFixer::class);

    # native functions should be casted in lowercase
    $ecsConfig->rule(NativeFunctionCasingFixer::class);

    # import namespaces
    $ecsConfig->rule(FullyQualifiedStrictTypesFixer::class);

    $ecsConfig->rule(GlobalNamespaceImportFixer::class);

    # slevomat rules from ruleset.xml
    $ecsConfig->rule(UseFromSameNamespaceSniff::class);

    $ecsConfig->rule(DuplicateAssignmentToVariableSniff::class);

    $ecsConfig->rule(OptimizedFunctionsWithoutUnpackingSniff::class);

    $ecsConfig->rule(UselessSemicolonSniff::class);

    $ecsConfig->rule(DeadCatchSniff::class);

    $ecsConfig->rule(UselessVariableSniff::class);

    $ecsConfig->rule(UselessParenthesesSniff::class);

    $ecsConfig->rule(DisallowLateStaticBindingForConstantsSniff::class);

    $ecsConfig->rule(UselessLateStaticBindingSniff::class);

    $ecsConfig->rule(RequireNullCoalesceOperatorSniff::class);

    $ecsConfig->rule(StaticClosureSniff::class);

    $ecsConfig->rule(DisallowImplicitArrayCreationSniff::class);

    $ecsConfig->rule(SimpleToComplexStringVariableFixer::class);
};