Rename RemoveSetterGetterDocblockFixer to RemoveMethodNameDuplicateDescriptionFixer (#66)

Author: MatTheCat

README.md

@@ -145,11 +145,11 @@ Fixes @param, @return, `@var` and inline `@var` annotations broken formats
 
 <br>
 
-## RemoveSetterGetterDocblockFixer
+## RemoveMethodNameDuplicateDescriptionFixer
 
-Remove docblock description from getter/setter methods, that only repeats the method name
+Remove docblock descriptions which duplicate their method name
 
-- class: [`Symplify\CodingStandard\Fixer\Annotation\RemoveSetterGetterDocblockFixer`](../src/Fixer/Annotation/RemoveSetterGetterDocblockFixer.php)
+- class: [`Symplify\CodingStandard\Fixer\Annotation\RemoveRedundantDescriptionFixer`](../src/Fixer/Annotation/RemoveRedundantDescriptionFixer.php)
 
 ```diff
  /**

config/symplify.php

@@ -4,7 +4,7 @@
 
 use PhpCsFixer\Fixer\Phpdoc\GeneralPhpdocAnnotationRemoveFixer;
 use Symplify\CodingStandard\Fixer\Annotation\RemovePHPStormAnnotationFixer;
-use Symplify\CodingStandard\Fixer\Annotation\RemoveSetterGetterDocblockFixer;
+use Symplify\CodingStandard\Fixer\Annotation\RemoveMethodNameDuplicateDescriptionFixer;
 use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayListItemNewlineFixer;
 use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer;
 use Symplify\CodingStandard\Fixer\Commenting\ParamReturnAndVarTagMalformsFixer;
@@ -22,7 +22,7 @@
         RemovePHPStormAnnotationFixer::class,
         ParamReturnAndVarTagMalformsFixer::class,
         RemoveUselessDefaultCommentFixer::class,
-        RemoveSetterGetterDocblockFixer::class,
+        RemoveMethodNameDuplicateDescriptionFixer::class,
 
         // arrays
         ArrayListItemNewlineFixer::class,

src/Fixer/Annotation/RemoveSetterGetterDocblockFixer.php renamed to src/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer.php

@@ -15,14 +15,14 @@
 use Symplify\CodingStandard\TokenRunner\Traverser\TokenReverser;
 
 /**
- * @see \Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveSetterGetterDocblockFixer\RemoveSetterGetterDocblockFixerTest
+ * @see \Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveRedundantDescriptionFixer\RemoveRedundantDescriptionFixerTest
  */
-final class RemoveSetterGetterDocblockFixer extends AbstractSymplifyFixer
+final class RemoveMethodNameDuplicateDescriptionFixer extends AbstractSymplifyFixer
 {
     /**
      * @var string
      */
-    private const ERROR_MESSAGE = 'Remove setter and getter only docblocks';
+    private const ERROR_MESSAGE = 'Remove docblock descriptions which duplicate their method name';
 
     private readonly MethodNameResolver $methodNameResolver;
 

tests/Fixer/Annotation/RemoveSetterGetterDocblockFixer/Fixture/simple_annotation.php.inc renamed to tests/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer/Fixture/simple_annotation.php.inc

@@ -1,6 +1,6 @@
 <?php
 
-namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveSetterGetterDocblockFixer\Fixture;
+namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveMethodNameDuplicateDescriptionFixer\Fixture;
 
 final class SimpleAnnotation
 {
@@ -16,7 +16,7 @@ final class SimpleAnnotation
 -----
 <?php
 
-namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveSetterGetterDocblockFixer\Fixture;
+namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveMethodNameDuplicateDescriptionFixer\Fixture;
 
 final class SimpleAnnotation
 {

tests/Fixer/Annotation/RemoveSetterGetterDocblockFixer/Fixture/with_return_date_time.php.inc renamed to tests/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer/Fixture/with_return_date_time.php.inc

@@ -1,6 +1,6 @@
 <?php
 
-namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveSetterGetterDocblockFixer\Fixture;
+namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveMethodNameDuplicateDescriptionFixer\Fixture;
 
 final class WithReturnDateTime
 {
@@ -18,7 +18,7 @@ final class WithReturnDateTime
 -----
 <?php
 
-namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveSetterGetterDocblockFixer\Fixture;
+namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveMethodNameDuplicateDescriptionFixer\Fixture;
 
 final class WithReturnDateTime
 {

tests/Fixer/Annotation/RemoveSetterGetterDocblockFixer/RemoveSetterGetterDocblockFixerTest.php renamed to tests/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer/RemoveMethodNameDuplicateDescriptionFixerTest.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveSetterGetterDocblockFixer;
+namespace Symplify\CodingStandard\Tests\Fixer\Annotation\RemoveMethodNameDuplicateDescriptionFixer;
 
 use Iterator;
 use PHPUnit\Framework\Attributes\DataProvider;
 use Symplify\EasyCodingStandard\Testing\PHPUnit\AbstractCheckerTestCase;
 
-final class RemoveSetterGetterDocblockFixerTest extends AbstractCheckerTestCase
+final class RemoveMethodNameDuplicateDescriptionFixerTest extends AbstractCheckerTestCase
 {
     #[DataProvider('provideData')]
     public function test(string $filePath): void

tests/Fixer/Annotation/RemoveSetterGetterDocblockFixer/config/configured_rule.php renamed to tests/Fixer/Annotation/RemoveMethodNameDuplicateDescriptionFixer/config/configured_rule.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-use Symplify\CodingStandard\Fixer\Annotation\RemoveSetterGetterDocblockFixer;
+use Symplify\CodingStandard\Fixer\Annotation\RemoveMethodNameDuplicateDescriptionFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 
 return static function (ECSConfig $ecsConfig): void {
     $ecsConfig->rules([
-        RemoveSetterGetterDocblockFixer::class,
+        RemoveMethodNameDuplicateDescriptionFixer::class,
     ]);
 };