Fix priority between PHPDoc return type fixers

PHP-CS-Fixer · Jun 21, 2018 · 1364398 · 1364398
1 parent 0df921d
commit 1364398
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 2 deletions.
diff --git a/src/Fixer/FunctionNotation/PhpdocToReturnTypeFixer.php b/src/Fixer/FunctionNotation/PhpdocToReturnTypeFixer.php
@@ -128,8 +128,8 @@ public function isCandidate(Tokens $tokens)
     public function getPriority()
     {
         // should be run after PhpdocScalarFixer.
-        // should be run before ReturnTypeDeclarationFixer, FullyQualifiedStrictTypesFixer.
-        return 1;
+        // should be run before ReturnTypeDeclarationFixer, FullyQualifiedStrictTypesFixer, NoSuperfluousPhpdocTagsFixer.
+        return 8;
     }
 
     /**

diff --git a/tests/AutoReview/FixerFactoryTest.php b/tests/AutoReview/FixerFactoryTest.php
@@ -183,6 +183,7 @@ public function provideFixersPriorityCases()
             [$fixers['phpdoc_to_comment'], $fixers['no_empty_comment']],
             [$fixers['phpdoc_to_comment'], $fixers['phpdoc_no_useless_inheritdoc']],
             [$fixers['phpdoc_to_return_type'], $fixers['fully_qualified_strict_types']],
+            [$fixers['phpdoc_to_return_type'], $fixers['no_superfluous_phpdoc_tags']],
             [$fixers['phpdoc_to_return_type'], $fixers['return_type_declaration']],
             [$fixers['phpdoc_var_without_name'], $fixers['phpdoc_trim']],
             [$fixers['pow_to_exponentiation'], $fixers['binary_operator_spaces']],

diff --git a/tests/Fixtures/Integration/priority/phpdoc_to_return_type,no_superfluous_phpdoc_tags.test b/tests/Fixtures/Integration/priority/phpdoc_to_return_type,no_superfluous_phpdoc_tags.test
@@ -0,0 +1,26 @@
+--TEST--
+Integration of fixers: phpdoc_to_return_type,no_superfluous_phpdoc_tags.
+--RULESET--
+{"phpdoc_to_return_type": true, "no_superfluous_phpdoc_tags": true}
+--REQUIREMENTS--
+{"php": 70100}
+--EXPECT--
+<?php
+
+class Test {
+    /**
+     */
+    public function foo(): int {
+    }
+}
+
+--INPUT--
+<?php
+
+class Test {
+    /**
+     * @return int
+     */
+    public function foo() {
+    }
+}