Add fixer's descriptions (#910)

src/Fixer/CommentSurroundedBySpacesFixer.php

@@ -27,6 +27,7 @@ public function getDefinition(): FixerDefinitionInterface
             [new CodeSample('<?php
 /*foo*/
 ')],
+            '',
         );
     }
 

src/Fixer/CommentedOutFunctionFixer.php

@@ -36,7 +36,7 @@ public function getDefinition(): FixerDefinitionInterface
             [new CodeSample('<?php
 var_dump($x);
 ')],
-            null,
+            '',
             'when any of the configured functions have side effects or are overwritten',
         );
     }

src/Fixer/ConstructorEmptyBracesFixer.php

@@ -36,6 +36,7 @@ public function __construct(
 ',
                 ),
             ],
+            '',
         );
     }
 

src/Fixer/DataProviderNameFixer.php

@@ -57,7 +57,7 @@ public function dataProvider() {}
 ',
                 ),
             ],
-            null,
+            '',
             'when relying on name of data provider function',
         );
     }

src/Fixer/DataProviderReturnTypeFixer.php

@@ -40,7 +40,7 @@ public function provideSomethingCases(): array {}
 ',
                 ),
             ],
-            null,
+            '',
             'when relying on signature of data provider',
         );
     }

src/Fixer/DataProviderStaticFixer.php

@@ -52,7 +52,7 @@ public function provideSomethingCases() {}
 ',
                 ),
             ],
-            null,
+            '',
             'when `force` is set to `true`',
         );
     }

src/Fixer/DeclareAfterOpeningTagFixer.php

@@ -26,6 +26,7 @@ public function getDefinition(): FixerDefinitionInterface
         return new FixerDefinition(
             'Declare statement for strict types must be placed in the same line, after opening tag.',
             [new CodeSample("<?php\n\$foo;\ndeclare(strict_types=1);\n\$bar;\n")],
+            '',
         );
     }
 

src/Fixer/EmptyFunctionBodyFixer.php

@@ -28,6 +28,7 @@ public function getDefinition(): FixerDefinitionInterface
 {
 }
 ')],
+            '',
         );
     }
 

src/Fixer/InternalClassCasingFixer.php

@@ -36,6 +36,7 @@ public function getDefinition(): FixerDefinitionInterface
         return new FixerDefinition(
             'Classes defined internally by extension or core must be referenced with the correct case.',
             [new CodeSample("<?php\n\$foo = new STDClass();\n")],
+            '',
         );
     }
 

src/Fixer/IssetToArrayKeyExistsFixer.php

@@ -33,7 +33,7 @@ public function getDefinition(): FixerDefinitionInterface
 ',
                 ),
             ],
-            null,
+            '',
             'when array is not defined, is multi-dimensional or behaviour is relying on the null value',
         );
     }

src/Fixer/MultilineCommentOpeningClosingAloneFixer.php

@@ -25,6 +25,7 @@ public function getDefinition(): FixerDefinitionInterface
         return new FixerDefinition(
             'Multiline comments or PHPDocs must contain an opening and closing line with no additional content.',
             [new CodeSample("<?php\n/** Hello\n * World!\n */;\n")],
+            '',
         );
     }
 

src/Fixer/MultilinePromotedPropertiesFixer.php

@@ -45,6 +45,7 @@ public function __construct(private array $a, private bool $b, private int $i) {
                     new VersionSpecification(80000),
                 ),
             ],
+            '',
         );
     }
 

src/Fixer/NoCommentedOutCodeFixer.php

@@ -27,6 +27,7 @@ public function getDefinition(): FixerDefinitionInterface
         return new FixerDefinition(
             'There can be no commented out code.',
             [new CodeSample("<?php\n//var_dump(\$_POST);\nprint_r(\$_POST);\n")],
+            '',
         );
     }
 

src/Fixer/NoDoctrineMigrationsGeneratedCommentFixer.php

@@ -43,6 +43,7 @@ public function down(Schema $schema)
     }
 }
 ')],
+            '',
         );
     }
 

src/Fixer/NoDuplicatedArrayKeyFixer.php

@@ -41,6 +41,7 @@ public function getDefinition(): FixerDefinitionInterface
     "foo" => 3,
 ];
 ')],
+            '',
         );
     }
 

src/Fixer/NoDuplicatedImportsFixer.php

@@ -32,6 +32,7 @@ public function getDefinition(): FixerDefinitionInterface
 use Foo;
 use Bar;
 ')],
+            '',
         );
     }
 

src/Fixer/NoImportFromGlobalNamespaceFixer.php

@@ -33,6 +33,7 @@ class Bar {
     public function __construct(DateTime $dateTime) {}
 }
 ')],
+            '',
         );
     }
 

src/Fixer/NoLeadingSlashInGlobalNamespaceFixer.php

@@ -28,6 +28,7 @@ public function getDefinition(): FixerDefinitionInterface
 namespace Bar;
 $y = new \Baz();
 ')],
+            '',
         );
     }
 

src/Fixer/NoNullableBooleanTypeFixer.php

@@ -28,7 +28,7 @@ function foo(?bool $bar) : ?bool
      return $bar;
  }
 ')],
-            null,
+            '',
             'when the null is used',
         );
     }

src/Fixer/NoPhpStormGeneratedCommentFixer.php

@@ -33,6 +33,7 @@ public function getDefinition(): FixerDefinitionInterface
  */
 namespace Foo;
 ')],
+            '',
         );
     }
 

src/Fixer/NoReferenceInFunctionDefinitionFixer.php

@@ -26,7 +26,7 @@ public function getDefinition(): FixerDefinitionInterface
             [new CodeSample('<?php
 function foo(&$x) {}
 ')],
-            null,
+            '',
             'when rely on reference',
         );
     }

src/Fixer/NoSuperfluousConcatenationFixer.php

@@ -32,6 +32,7 @@ public function getDefinition(): FixerDefinitionInterface
         return new FixerDefinition(
             'There should be no superfluous concatenation of strings.',
             [new CodeSample("<?php\necho 'foo' . 'bar';\n")],
+            '',
         );
     }
 

src/Fixer/NoTrailingCommaInSinglelineFixer.php

@@ -26,6 +26,7 @@ public function getDefinition(): FixerDefinitionInterface
             [
                 new CodeSample("<?php\n\$x = ['foo', 'bar', ];\n"),
             ],
+            '',
         );
     }
 

src/Fixer/NoUselessCommentFixer.php

@@ -38,6 +38,7 @@ function getBar() {}
 }
 '),
             ],
+            '',
         );
     }
 

src/Fixer/NoUselessDirnameCallFixer.php

@@ -27,6 +27,7 @@ public function getDefinition(): FixerDefinitionInterface
             [new CodeSample('<?php
 require dirname(__DIR__) . "/vendor/autoload.php";
 ')],
+            '',
         );
     }
 

src/Fixer/NoUselessDoctrineRepositoryCommentFixer.php

@@ -32,6 +32,7 @@ public function getDefinition(): FixerDefinitionInterface
  */
 class FooRepository extends EntityRepository {}
 ')],
+            '',
         );
     }
 

src/Fixer/NoUselessParenthesisFixer.php

@@ -29,6 +29,7 @@ public function getDefinition(): FixerDefinitionInterface
 foo(($bar));
 '),
             ],
+            '',
         );
     }
 

src/Fixer/NoUselessStrlenFixer.php

@@ -33,7 +33,7 @@ public function getDefinition(): FixerDefinitionInterface
 ',
                 ),
             ],
-            null,
+            '',
             'when the function `strlen` is overridden',
         );
     }

src/Fixer/NumericLiteralSeparatorFixer.php

@@ -54,6 +54,7 @@ public function getDefinition(): FixerDefinitionInterface
 ',
                 new VersionSpecification(70400),
             )],
+            '',
         );
     }
 

src/Fixer/PhpUnitAssertArgumentsOrderFixer.php

@@ -51,7 +51,7 @@ public function testFoo() {
     }
 }
 ')],
-            null,
+            '',
             'when original PHPUnit methods are overwritten',
         );
     }

src/Fixer/PhpUnitDedicatedAssertFixer.php

@@ -56,7 +56,7 @@ public function testFoo() {
     }
 }
 ')],
-            null,
+            '',
             'when original PHPUnit methods are overwritten',
         );
     }

src/Fixer/PhpdocArrayStyleFixer.php

@@ -32,6 +32,7 @@ function foo() { return [1, 2]; }
 ',
                 ),
             ],
+            '',
         );
     }
 

src/Fixer/PhpdocNoIncorrectVarAnnotationFixer.php

@@ -31,6 +31,7 @@ public function getDefinition(): FixerDefinitionInterface
 /** @var Foo $foo */
 $bar = new Foo();
 ')],
+            '',
         );
     }
 

src/Fixer/PhpdocNoSuperfluousParamFixer.php

@@ -34,6 +34,7 @@ public function getDefinition(): FixerDefinitionInterface
  */
 function foo($b, $s) {}
 ')],
+            '',
         );
     }
 

src/Fixer/PhpdocOnlyAllowedAnnotationsFixer.php

@@ -44,6 +44,7 @@ function foo_bar() {}
 ',
                 ['elements' => ['author', 'version']],
             )],
+            '',
         );
     }
 

src/Fixer/PhpdocParamOrderFixer.php

@@ -42,6 +42,7 @@ public function getDefinition(): FixerDefinitionInterface
  */
 function foo($a, $b, $c) {}
 ')],
+            '',
         );
     }
 

src/Fixer/PhpdocParamTypeFixer.php

@@ -31,6 +31,7 @@ public function getDefinition(): FixerDefinitionInterface
  */
 function a($foo, $bar) {}
 ')],
+            '',
         );
     }
 

src/Fixer/PhpdocSelfAccessorFixer.php

@@ -35,6 +35,7 @@ class Foo {
      private $instance;
 }
 ')],
+            '',
         );
     }
 

src/Fixer/PhpdocSingleLineVarFixer.php

@@ -32,6 +32,7 @@ class Foo {
     private $name;
 }
 ')],
+            '',
         );
     }
 

src/Fixer/PhpdocTypesCommaSpacesFixer.php

@@ -23,6 +23,7 @@ public function getDefinition(): FixerDefinitionInterface
         return new FixerDefinition(
             'PHPDoc types commas must not be preceded by whitespace, and must be succeeded by single whitespace.',
             [new CodeSample("<?php /** @var array<int,string> */\n")],
+            '',
         );
     }
 

src/Fixer/PhpdocTypesTrimFixer.php

@@ -28,6 +28,7 @@ public function getDefinition(): FixerDefinitionInterface
  */
 function foo($x) {}
 ')],
+            '',
         );
     }
 

src/Fixer/PhpdocVarAnnotationToAssertFixer.php

@@ -30,6 +30,7 @@ public function getDefinition(): FixerDefinitionInterface
 /** @var string $x */
 $x = getValue();
 ')],
+            '',
         );
     }
 

src/Fixer/PromotedConstructorPropertyFixer.php

@@ -54,6 +54,7 @@ public function __construct(string $bar) {
                     new VersionSpecification(80000),
                 ),
             ],
+            '',
         );
     }
 

src/Fixer/ReadonlyPromotedPropertiesFixer.php

@@ -38,7 +38,7 @@ public function __construct(
                     new VersionSpecification(80100),
                 ),
             ],
-            null,
+            '',
             'when property is written',
         );
     }

src/Fixer/SingleSpaceAfterStatementFixer.php

@@ -86,6 +86,7 @@ public function getDefinition(): FixerDefinitionInterface
         return new FixerDefinition(
             'Statements not followed by a semicolon must be followed by a single space.',
             [new CodeSample("<?php\n\$foo = new    Foo();\necho\$foo->bar();\n")],
+            '',
         );
     }
 

src/Fixer/SingleSpaceBeforeStatementFixer.php

@@ -80,6 +80,7 @@ public function getDefinition(): FixerDefinitionInterface
         return new FixerDefinition(
             'Statements not preceded by a line break must be preceded by a single space.',
             [new CodeSample("<?php\n\$foo =new Foo();\n")],
+            '',
         );
     }
 

src/Fixer/StringableInterfaceFixer.php

@@ -32,6 +32,7 @@ public function __toString()
    }
 }
 ')],
+            '',
         );
     }