Improve type handing of Formatter::isClause

williamdes · williamdes · commit 1ac927f30a34 · 2023-03-11T15:17:02.000+01:00
Found on Scrutinizer

Signed-off-by: William Desportes &lt;williamdes@wdes.fr&gt;
diff --git a/src/Utils/Formatter.php b/src/Utils/Formatter.php
@@ -454,7 +454,7 @@ public function formatList($list)
                 // Checking if this clause ended.
                 $isClause = static::isClause($curr);
 
-                if ($isClause) {
+                if ($isClause !== false) {
                     if (
                         ($isClause === 2 || $this->options['clause_newline'])
                         && empty(self::$SHORT_CLAUSES[$lastClause])
@@ -766,7 +766,8 @@ public static function getGroupLength($list)
      *
      * @param Token $token the token to be checked
      *
-     * @return int|bool
+     * @return int|false
+     * @psalm-return 1|2|false
      */
     public static function isClause($token)
     {

Original file line number	Diff line number	Diff line change
`@@ -454,7 +454,7 @@ public function formatList($list)`
`454`	`454`	`// Checking if this clause ended.`
`455`	`455`	`$isClause = static::isClause($curr);`
`456`	`456`
`457`		`- if ($isClause) {`
	`457`	`+ if ($isClause !== false) {`
`458`	`458`	`if (`
`459`	`459`	`($isClause === 2 \|\| $this->options['clause_newline'])`
`460`	`460`	`&& empty(self::$SHORT_CLAUSES[$lastClause])`
`@@ -766,7 +766,8 @@ public static function getGroupLength($list)`
`766`	`766`	`*`
`767`	`767`	`* @param Token $token the token to be checked`
`768`	`768`	`*`
`769`		`- * @return int\|bool`
	`769`	`+ * @return int\|false`
	`770`	`+ * @psalm-return 1\|2\|false`
`770`	`771`	`*/`
`771`	`772`	`public static function isClause($token)`
`772`	`773`	`{`