CommentSurroundedBySpacesFixer must run before PhpdocToCommentFixer (#806)

kubawerlos · web-flow · commit b3a7c140ec54 · 2022-08-11T20:24:28.000+02:00
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-3451-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3454-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)
diff --git a/src/Fixer/CommentSurroundedBySpacesFixer.php b/src/Fixer/CommentSurroundedBySpacesFixer.php
@@ -31,12 +31,12 @@ public function getDefinition(): FixerDefinitionInterface
     }
 
     /**
-     * Must run before MultilineCommentOpeningClosingFixer.
+     * Must run before MultilineCommentOpeningClosingFixer, PhpdocToCommentFixer.
      * Must run after CommentedOutFunctionFixer.
      */
     public function getPriority(): int
     {
-        return 1;
+        return 26;
     }
 
     public function isCandidate(Tokens $tokens): bool
diff --git a/src/Fixer/CommentedOutFunctionFixer.php b/src/Fixer/CommentedOutFunctionFixer.php
@@ -66,7 +66,7 @@ public function configure(array $configuration): void
      */
     public function getPriority(): int
     {
-        return 2;
+        return 27;
     }
 
     public function isCandidate(Tokens $tokens): bool
diff --git a/tests/priority_fixtures/Custom_comment_surrounded_by_spaces,phpdoc_to_comment.test b/tests/priority_fixtures/Custom_comment_surrounded_by_spaces,phpdoc_to_comment.test
@@ -0,0 +1,9 @@
+--CONFIGURATION--
+{ "PhpCsFixerCustomFixers/comment_surrounded_by_spaces": true, "phpdoc_to_comment": true }
+--EXPECTED--
+<?php
+/* foo */
+
+--INPUT--
+<?php
+/**foo*/

Original file line number	Diff line number	Diff line change
`@@ -31,12 +31,12 @@ public function getDefinition(): FixerDefinitionInterface`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`/**`
`34`		`- * Must run before MultilineCommentOpeningClosingFixer.`
	`34`	`+ * Must run before MultilineCommentOpeningClosingFixer, PhpdocToCommentFixer.`
`35`	`35`	`* Must run after CommentedOutFunctionFixer.`
`36`	`36`	`*/`
`37`	`37`	`public function getPriority(): int`
`38`	`38`	`{`
`39`		`- return 1;`
	`39`	`+ return 26;`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`public function isCandidate(Tokens $tokens): bool`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public function configure(array $configuration): void`
`66`	`66`	`*/`
`67`	`67`	`public function getPriority(): int`
`68`	`68`	`{`
`69`		`- return 2;`
	`69`	`+ return 27;`
`70`	`70`	`}`
`71`	`71`
`72`	`72`	`public function isCandidate(Tokens $tokens): bool`