Why does the PhpdocAlignFixer adds a space in front of the Return Doc

[maluramichael]

$ bin/ecs --version
EasyCodingStandard 11.5.0

I dont know why our configuration creates this behavior, maybe one can help me here.

1) src/Controller/Frontend/DefaultController.php

    ---------- begin diff ----------
@@ -39,7 +39,7 @@
      /**
       * @Route("/", name="homepage")
       *
-      * @return RedirectResponse
+       * @return RedirectResponse
       */
      public function indexAction(): RedirectResponse
      {
    ----------- end diff -----------


Applied checkers:

 * PhpCsFixer\Fixer\Phpdoc\PhpdocAlignFixer




 [OK] 1 error successfully fixed and no other errors found!

This is our configuration. There is nothing special configured for this rule

<?php

use App\Fixer\MethodArgumentSpaceLulububuFixer;
use App\Fixer\MultilinePromotedPropertiesFixer;
use App\Fixer\PhpDocApiResourceLulububuFixer;
use App\Fixer\PhpDocDoctrineOnDeleteLulububuFixer;
use PhpCsFixer\Fixer\Alias\ArrayPushFixer;
use PhpCsFixer\Fixer\ArrayNotation\TrimArraySpacesFixer;
use PhpCsFixer\Fixer\ArrayNotation\WhitespaceAfterCommaInArrayFixer;
use PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer;
use PhpCsFixer\Fixer\ClassNotation\NoBlankLinesAfterClassOpeningFixer;
use PhpCsFixer\Fixer\Comment\MultilineCommentOpeningClosingFixer;
use PhpCsFixer\Fixer\ControlStructure\NoUselessElseFixer;
use PhpCsFixer\Fixer\ControlStructure\TrailingCommaInMultilineFixer;
use PhpCsFixer\Fixer\DoctrineAnnotation\DoctrineAnnotationBracesFixer;
use PhpCsFixer\Fixer\DoctrineAnnotation\DoctrineAnnotationIndentationFixer;
use PhpCsFixer\Fixer\Import\GlobalNamespaceImportFixer;
use PhpCsFixer\Fixer\Import\NoUnusedImportsFixer;
use PhpCsFixer\Fixer\Import\OrderedImportsFixer;
use PhpCsFixer\Fixer\Import\SingleLineAfterImportsFixer;
use PhpCsFixer\Fixer\NamespaceNotation\BlankLineAfterNamespaceFixer;
use PhpCsFixer\Fixer\Operator\BinaryOperatorSpacesFixer;
use PhpCsFixer\Fixer\Phpdoc\AlignMultilineCommentFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocAddMissingParamAnnotationFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocAlignFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocIndentFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocLineSpanFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocOrderFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocScalarFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocSeparationFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocSingleLineVarSpacingFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocTrimFixer;
use PhpCsFixer\Fixer\Phpdoc\PhpdocVarAnnotationCorrectOrderFixer;
use PhpCsFixer\Fixer\ReturnNotation\NoUselessReturnFixer;
use PhpCsFixer\Fixer\Semicolon\MultilineWhitespaceBeforeSemicolonsFixer;
use PhpCsFixer\Fixer\StringNotation\SimpleToComplexStringVariableFixer;
use PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer;
use PhpCsFixer\Fixer\Whitespace\ArrayIndentationFixer;
use PhpCsFixer\Fixer\Whitespace\BlankLineBeforeStatementFixer;
use PhpCsFixer\Fixer\Whitespace\CompactNullableTypehintFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return static function (ECSConfig $ecsConfig): void {
    $ecsConfig->skip([
        'src/Fixer/*',
        '*/bootstrap.php',
        'tests/*',
        'vendor/*',
        'var/*',
        'node_modules/*',
        MultilinePromotedPropertiesFixer::class => [
            'src/Entity/*',
        ],
    ]);
    // Add your own config here
    $ecsConfig->paths([
        __DIR__ . '/src',
        __DIR__ . '/tests',
    ]);
    $ecsConfig->rules([
        AlignMultilineCommentFixer::class,
        ArrayIndentationFixer::class,
        ArrayPushFixer::class,
        BlankLineAfterNamespaceFixer::class,
        BlankLineBeforeStatementFixer::class,
        CompactNullableTypehintFixer::class,
        DoctrineAnnotationBracesFixer::class,
        DoctrineAnnotationIndentationFixer::class,
        GlobalNamespaceImportFixer::class,
        MultilineCommentOpeningClosingFixer::class,
        MultilinePromotedPropertiesFixer::class,
        NoBlankLinesAfterClassOpeningFixer::class,
        NoUnusedImportsFixer::class,
        NoUselessElseFixer::class,
        NoUselessReturnFixer::class,
        OrderedImportsFixer::class,
        PhpdocAddMissingParamAnnotationFixer::class,
        PhpdocAlignFixer::class,
        PhpdocIndentFixer::class,
        PhpdocLineSpanFixer::class,
        PhpdocOrderFixer::class,
        PhpdocScalarFixer::class,
        PhpdocSeparationFixer::class,
        PhpdocSingleLineVarSpacingFixer::class,
        PhpdocTrimFixer::class,
        PhpdocVarAnnotationCorrectOrderFixer::class,
        SimpleToComplexStringVariableFixer::class,
        SingleLineAfterImportsFixer::class,
        SingleQuoteFixer::class,
        TrimArraySpacesFixer::class,
        WhitespaceAfterCommaInArrayFixer::class,
    ]);
    $ecsConfig->ruleWithConfiguration(
        TrailingCommaInMultilineFixer::class,
        [
            'elements' => [
                'arrays',
                'parameters',
            ],
        ]
    );
    $ecsConfig->ruleWithConfiguration(
        BinaryOperatorSpacesFixer::class,
        [
            'default' => BinaryOperatorSpacesFixer::ALIGN,
        ]
    );
    $ecsConfig->ruleWithConfiguration(
        ClassAttributesSeparationFixer::class,
        [
            'elements' => [
                'const'    => ClassAttributesSeparationFixer::SPACING_NONE,
                'method'   => ClassAttributesSeparationFixer::SPACING_ONE,
                'property' => ClassAttributesSeparationFixer::SPACING_ONE,
            ],
        ]
    );
    $ecsConfig->ruleWithConfiguration(
        MultilineWhitespaceBeforeSemicolonsFixer::class,
        [
            'strategy' => MultilineWhitespaceBeforeSemicolonsFixer::STRATEGY_NEW_LINE_FOR_CHAINED_CALLS,
        ]
    );

    // Lulububu Custom Rules
    $ecsConfig->rules([
        PhpDocApiResourceLulububuFixer::class,
        PhpDocDoctrineOnDeleteLulububuFixer::class,
    ]);
    $ecsConfig->ruleWithConfiguration(
        MethodArgumentSpaceLulububuFixer::class,
        [
            'on_multiline'                     => 'ensure_fully_multiline',
            'keep_multiple_spaces_after_comma' => true,
        ]
    );
};

[Wirone]

Just for the record: you're using Easy Coding Standard but you're asking for help in PHP-CS-Fixer 😉. Even though ECS uses fixers internally, it has its own engine for running checkers (not only fixers, but also sniffs).

Please provide actual code snippet so we can verify it, but from the diff it seems like you have 5 space indentation (for method and the phpDoc). With proper indentation no changes are applied by phpdoc_align:

[maluramichael]

Oh ok sorry. I thought i post here because of the rule that was complaining. Thought ECS is just a wrapper for php-cs-fixer.

You are right just this method was indented with 5 spaces 🤦🏻‍♂️ i don't know why. Thank you so much.