Feat: Add PhpdocToCommentFixer (part of #94)

Author: OndraM

ecs-internal.php

@@ -5,7 +5,7 @@
 use Symplify\CodingStandard\Fixer\LineLength\LineLengthFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 
-/**
+/*
  * Internal rules configuration for the lmc/coding-standard project itself
  */
 return ECSConfig::configure()

ecs.php

@@ -106,6 +106,7 @@
 use PhpCsFixer\Fixer\Phpdoc\PhpdocReturnSelfReferenceFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocScalarFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocSingleLineVarSpacingFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocToCommentFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocTrimFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocTypesFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocVarAnnotationCorrectOrderFixer;
@@ -331,6 +332,8 @@
             PhpdocSingleLineVarSpacingFixer::class,
             // PHPDoc should start and end with content
             PhpdocTrimFixer::class,
+            // Docblocks should only be used on structural elements.
+            PhpdocToCommentFixer::class,
             // The correct case must be used for standard PHP types in PHPDoc.
             PhpdocTypesFixer::class,
             // `@var` and `@type` annotations must have type and name in the correct order

tests/Integration/Fixtures/Basic.correct.php.inc

@@ -24,6 +24,13 @@ class Basic
 
     public function fooBar(mixed $foo): mixed
     {
+        // PhpdocToCommentFixer
+        /*
+         * Phpdoc used instead of plain comment
+         */
+        if ($foo === 'bar') {
+            $baz = 'bat';
+        }
         // TernaryToElvisOperatorFixer
         return ($foo ?: 'not true');
     }

tests/Integration/Fixtures/Basic.wrong.php.inc

@@ -20,6 +20,13 @@ class Basic
 
     public function fooBar(mixed $foo): mixed
     {
+        // PhpdocToCommentFixer
+        /**
+         * Phpdoc used instead of plain comment
+         */
+        if ($foo === 'bar') {
+            $baz = 'bat';
+        }
         // TernaryToElvisOperatorFixer
         return ($foo ? $foo : 'not true');
     }