bug #5385 SingleLineCommentStyleFixer- run before NoUselessReturnFixe…

…r (kubawerlos)

This PR was merged into the 2.17 branch.

Discussion
----------

SingleLineCommentStyleFixer- run before NoUselessReturnFixer

Fixes #5382

Ping @mvorisek for review (as a reporter of bug).

Commits
-------

c262d5c Make single_line_comment_style runs after no_useless_return

src/Fixer/Comment/SingleLineCommentStyleFixer.php

@@ -98,6 +98,16 @@ public function getDefinition()
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * Must run after NoUselessReturnFixer.
+     */
+    public function getPriority()
+    {
+        return -19;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Fixer/ReturnNotation/NoUselessReturnFixer.php

@@ -55,7 +55,7 @@ function example($b) {
     /**
      * {@inheritdoc}
      *
-     * Must run before BlankLineBeforeReturnFixer, BlankLineBeforeStatementFixer, NoExtraBlankLinesFixer, NoWhitespaceInBlankLineFixer.
+     * Must run before BlankLineBeforeReturnFixer, BlankLineBeforeStatementFixer, NoExtraBlankLinesFixer, NoWhitespaceInBlankLineFixer, SingleLineCommentStyleFixer.
      * Must run after NoEmptyStatementFixer, NoUnneededCurlyBracesFixer, NoUselessElseFixer, SimplifiedNullReturnFixer.
      */
     public function getPriority()

tests/AutoReview/FixerFactoryTest.php

@@ -192,6 +192,7 @@ public function provideFixersPriorityCases()
             [$fixers['no_useless_return'], $fixers['blank_line_before_statement']],
             [$fixers['no_useless_return'], $fixers['no_extra_blank_lines']],
             [$fixers['no_useless_return'], $fixers['no_whitespace_in_blank_line']],
+            [$fixers['no_useless_return'], $fixers['single_line_comment_style']],
             [$fixers['no_useless_sprintf'], $fixers['method_argument_space']],
             [$fixers['no_useless_sprintf'], $fixers['native_function_casing']],
             [$fixers['no_useless_sprintf'], $fixers['no_empty_statement']],

tests/Fixtures/Integration/priority/no_useless_return,single_line_comment_style.test

@@ -0,0 +1,17 @@
+--TEST--
+Integration of fixers: no_useless_return,single_line_comment_style.
+--RULESET--
+{ "no_useless_return": true, "single_line_comment_style": true }
+--EXPECT--
+<?php
+function foo()
+{
+    // foo
+}
+
+--INPUT--
+<?php
+function foo()
+{
+    return/* foo */;
+}