Autoreview the PHPDoc of *Fixer::getPriority based on the priority map

src/Fixer/Alias/BacktickToShellExecFixer.php

@@ -55,10 +55,11 @@ public function getDefinition()
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before EscapeImplicitBackslashesFixer, ExplicitStringVariableFixer.
      */
     public function getPriority()
     {
-        // Should run before escape_implicit_backslashes
         return 2;
     }
 

src/Fixer/Alias/NoAliasFunctionsFixer.php

@@ -154,6 +154,16 @@ public function getDefinition()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run before ImplodeCallFixer, PhpUnitDedicateAssertFixer.
+     */
+    public function getPriority()
+    {
+        return 0;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Fixer/Alias/NoMixedEchoPrintFixer.php

@@ -75,10 +75,11 @@ public function getDefinition()
 
     /**
      * {@inheritdoc}
+     *
+     * Must run after NoShortEchoTagFixer.
      */
     public function getPriority()
     {
-        // should run after NoShortEchoTagFixer.
         return -10;
     }
 

src/Fixer/Alias/PowToExponentiationFixer.php

@@ -53,10 +53,11 @@ public function getDefinition()
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before BinaryOperatorSpacesFixer, MethodArgumentSpaceFixer, NativeFunctionCasingFixer, NoSpacesAfterFunctionNameFixer, NoSpacesInsideParenthesisFixer.
      */
     public function getPriority()
     {
-        // must be run before BinaryOperatorSpacesFixer
         return 3;
     }
 

src/Fixer/ArrayNotation/ArraySyntaxFixer.php

@@ -68,10 +68,11 @@ public function getDefinition()
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before BinaryOperatorSpacesFixer, TernaryOperatorSpacesFixer.
      */
     public function getPriority()
     {
-        // should be run before the BinaryOperatorSpacesFixer and TernaryOperatorSpacesFixer.
         return 1;
     }
 

src/Fixer/ArrayNotation/NoMultilineWhitespaceAroundDoubleArrowFixer.php

@@ -38,10 +38,11 @@ public function getDefinition()
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before BinaryOperatorSpacesFixer, TrailingCommaInMultilineArrayFixer.
      */
     public function getPriority()
     {
-        // should be run before the TrailingCommaInMultilineArrayFixer and BinaryOperatorSpacesFixer.
         return 1;
     }
 

src/Fixer/ArrayNotation/TrailingCommaInMultilineArrayFixer.php

@@ -61,6 +61,16 @@ public function getDefinition()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run after NoMultilineWhitespaceAroundDoubleArrowFixer.
+     */
+    public function getPriority()
+    {
+        return 0;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Fixer/Basic/BracesFixer.php

@@ -123,10 +123,12 @@ public function bar($baz)
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before ArrayIndentationFixer, MethodChainingIndentationFixer.
+     * Must run after ClassAttributesSeparationFixer, ElseifFixer, LineEndingFixer, MethodSeparationFixer, NoAlternativeSyntaxFixer, NoEmptyStatementFixer, NoUselessElseFixer, SingleTraitInsertPerStatementFixer.
      */
     public function getPriority()
     {
-        // should be run after the ElseIfFixer, LineEndingFixer, NoEmptyStatementFixer and NoUselessElseFixer
         return -25;
     }
 

src/Fixer/Casing/NativeFunctionCasingFixer.php

@@ -35,6 +35,16 @@ public function getDefinition()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run after FunctionToConstantFixer, PowToExponentiationFixer.
+     */
+    public function getPriority()
+    {
+        return 0;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Fixer/CastNotation/CastSpacesFixer.php

@@ -63,10 +63,11 @@ public function getDefinition()
 
     /**
      * {@inheritdoc}
+     *
+     * Must run after NoShortBoolCastFixer.
      */
     public function getPriority()
     {
-        // should be run after the NoShortBoolCastFixer
         return -10;
     }
 

src/Fixer/CastNotation/NoShortBoolCastFixer.php

@@ -25,10 +25,11 @@ final class NoShortBoolCastFixer extends AbstractFixer
 {
     /**
      * {@inheritdoc}
+     *
+     * Must run before CastSpacesFixer.
      */
     public function getPriority()
     {
-        // should be run before the CastSpacesFixer
         return -9;
     }
 

src/Fixer/ClassNotation/ClassAttributesSeparationFixer.php

@@ -104,11 +104,12 @@ class Sample
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before BracesFixer, IndentationTypeFixer.
+     * Must run after OrderedClassElementsFixer.
      */
     public function getPriority()
     {
-        // Must run before BracesFixer and IndentationTypeFixer fixers because this fixer
-        // might add line breaks to the code without indenting.
         return 55;
     }
 

src/Fixer/ClassNotation/FinalInternalClassFixer.php

@@ -69,6 +69,16 @@ public function getDefinition()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run after PhpUnitInternalClassFixer.
+     */
+    public function getPriority()
+    {
+        return 0;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Fixer/ClassNotation/MethodSeparationFixer.php

@@ -50,6 +50,17 @@ protected function bar()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run before BracesFixer, IndentationTypeFixer.
+     * Must run after OrderedClassElementsFixer.
+     */
+    public function getPriority()
+    {
+        return parent::getPriority();
+    }
+
     /**
      * Returns names of fixers to use instead, if any.
      *

src/Fixer/ClassNotation/NoBlankLinesAfterClassOpeningFixer.php

@@ -55,6 +55,16 @@ protected function foo()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run after OrderedClassElementsFixer.
+     */
+    public function getPriority()
+    {
+        return 0;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Fixer/ClassNotation/NoPhp4ConstructorFixer.php

@@ -48,10 +48,11 @@ public function Foo($bar)
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before OrderedClassElementsFixer.
      */
     public function getPriority()
     {
-        // must run before OrderedClassElementsFixer
         return 75;
     }
 

src/Fixer/ClassNotation/OrderedClassElementsFixer.php

@@ -210,11 +210,12 @@ public function C(){}
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before ClassAttributesSeparationFixer, MethodSeparationFixer, NoBlankLinesAfterClassOpeningFixer, SpaceAfterSemicolonFixer.
+     * Must run after NoPhp4ConstructorFixer, ProtectedToPrivateFixer.
      */
     public function getPriority()
     {
-        // must run before MethodSeparationFixer, NoBlankLinesAfterClassOpeningFixer and SpaceAfterSemicolonFixer.
-        // must run after ProtectedToPrivateFixer.
         return 65;
     }
 

src/Fixer/ClassNotation/ProtectedToPrivateFixer.php

@@ -49,9 +49,13 @@ protected function test()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run before OrderedClassElementsFixer.
+     */
     public function getPriority()
     {
-        // must run before OrderedClassElementsFixer.
         return 66;
     }
 

src/Fixer/ClassNotation/SingleTraitInsertPerStatementFixer.php

@@ -42,9 +42,13 @@ final class Example
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run before BracesFixer, SpaceAfterSemicolonFixer.
+     */
     public function getPriority()
     {
-        // must be run before Braces and SpaceAfterSemicolonFixer
         return 1;
     }
 

src/Fixer/Comment/CommentToPhpdocFixer.php

@@ -45,6 +45,8 @@ public function isRisky()
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before GeneralPhpdocAnnotationRemoveFixer, NoBlankLinesAfterPhpdocFixer, NoEmptyPhpdocFixer, NoSuperfluousPhpdocTagsFixer, PhpdocAddMissingParamAnnotationFixer, PhpdocAlignFixer, PhpdocAlignFixer, PhpdocAnnotationWithoutDotFixer, PhpdocInlineTagFixer, PhpdocNoAccessFixer, PhpdocNoAliasTagFixer, PhpdocNoEmptyReturnFixer, PhpdocNoPackageFixer, PhpdocNoUselessInheritdocFixer, PhpdocOrderFixer, PhpdocReturnSelfReferenceFixer, PhpdocSeparationFixer, PhpdocSingleLineVarSpacingFixer, PhpdocSummaryFixer, PhpdocToCommentFixer, PhpdocToReturnTypeFixer, PhpdocTrimConsecutiveBlankLineSeparationFixer, PhpdocTrimFixer, PhpdocTypesOrderFixer, PhpdocVarAnnotationCorrectOrderFixer, PhpdocVarWithoutNameFixer.
      */
     public function getPriority()
     {

src/Fixer/Comment/HeaderCommentFixer.php

@@ -112,11 +112,11 @@ public function isCandidate(Tokens $tokens)
 
     /**
      * {@inheritdoc}
+     *
+     * Must run after NoBlankLinesAfterPhpdocFixer.
      */
     public function getPriority()
     {
-        // should be run after the NoBlankLinesAfterPhpdocFixer.
-        //
         // When this fixer is configured with ["separate" => "bottom", "commentType" => "PHPDoc"]
         // and the target file has no namespace or declare() construct,
         // the fixed header comment gets trimmed by NoBlankLinesAfterPhpdocFixer if we run before it.

src/Fixer/Comment/NoEmptyCommentFixer.php

@@ -29,10 +29,12 @@ final class NoEmptyCommentFixer extends AbstractFixer
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before NoExtraBlankLinesFixer, NoTrailingWhitespaceFixer, NoWhitespaceInBlankLineFixer.
+     * Must run after PhpdocToCommentFixer.
      */
     public function getPriority()
     {
-        // should be run after PhpdocToCommentFixer and before NoExtraBlankLinesFixer, NoTrailingWhitespaceFixer and NoWhitespaceInBlankLineFixer.
         return 2;
     }
 

src/Fixer/Comment/NoTrailingWhitespaceInCommentFixer.php

@@ -38,6 +38,16 @@ public function getDefinition()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run after PhpdocNoUselessInheritdocFixer.
+     */
+    public function getPriority()
+    {
+        return 0;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Fixer/ControlStructure/ElseifFixer.php

@@ -36,6 +36,17 @@ public function getDefinition()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run before BracesFixer.
+     * Must run after NoAlternativeSyntaxFixer.
+     */
+    public function getPriority()
+    {
+        return 0;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Fixer/ControlStructure/NoAlternativeSyntaxFixer.php

@@ -64,10 +64,11 @@ public function isCandidate(Tokens $tokens)
 
     /**
      * {@inheritdoc}
+     *
+     * Must run before BracesFixer, ElseifFixer, NoSuperfluousElseifFixer, NoUselessElseFixer.
      */
     public function getPriority()
     {
-        // Should run before BracesFixer and ElseifFixer
         return 26;
     }
 

src/Fixer/ControlStructure/NoSuperfluousElseifFixer.php

@@ -42,6 +42,16 @@ public function getDefinition()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run after NoAlternativeSyntaxFixer.
+     */
+    public function getPriority()
+    {
+        parent::getPriority();
+    }
+
     /**
      * {@inheritdoc}
      */

src/Fixer/ControlStructure/NoUnneededControlParenthesesFixer.php

@@ -105,9 +105,9 @@ public function getDefinition()
     }
 
     /**
-     * Should be run before no_trailing_whitespace.
-     *
      * {@inheritdoc}
+     *
+     * Must run before NoTrailingWhitespaceFixer.
      */
     public function getPriority()
     {