Normalize comment classes

lib/PhpParser/Comment.php

@@ -147,16 +147,14 @@ public function __toString() : string {
      * without trailing whitespace on the first line, but with trailing whitespace
      * on all subsequent lines.
      *
-     * @return mixed|string
+     * @return string|null
      */
     public function getReformattedText() {
-        $text = $this->text;
-        $newlinePos = strpos($text, "\n");
-        if (false === $newlinePos) {
+        if ($this->startLine === $this->endLine) {
             // Single line comments don't need further processing
-            return $text;
+            return $this->text;
         }
-        if (preg_match('((*BSR_ANYCRLF)(*ANYCRLF)^.*(?:\R\s+\*.*)+$)', $text)) {
+        if (preg_match('((*BSR_ANYCRLF)(*ANYCRLF)^.*(?:\R\s+\*.*)+$)', $this->text)) {
             // Multi line comment of the type
             //
             //     /*
@@ -167,7 +165,7 @@ public function getReformattedText() {
             // is handled by replacing the whitespace sequences before the * by a single space
             return preg_replace('(^\s+\*)m', ' *', $this->text);
         }
-        if (preg_match('(^/\*\*?\s*[\r\n])', $text) && preg_match('(\n(\s*)\*/$)', $text, $matches)) {
+        if (preg_match('(^/\*\*?\s*[\r\n])', $this->text) && preg_match('(\n(\s*)\*/$)', $this->text, $matches)) {
             // Multi line comment of the type
             //
             //    /*
@@ -178,9 +176,9 @@ public function getReformattedText() {
             // is handled by removing the whitespace sequence on the line before the closing
             // */ on all lines. So if the last line is "    */", then "    " is removed at the
             // start of all lines.
-            return preg_replace('(^' . preg_quote($matches[1]) . ')m', '', $text);
+            return preg_replace('(^' . preg_quote($matches[1]) . ')m', '', $this->text);
         }
-        if (preg_match('(^/\*\*?\s*(?!\s))', $text, $matches)) {
+        if (preg_match('(^/\*\*?\s*(?!\s))', $this->text, $matches)) {
             // Multi line comment of the type
             //
             //     /* Some text.
@@ -190,13 +188,13 @@ public function getReformattedText() {
             //
             // is handled by removing the difference between the shortest whitespace prefix on all
             // lines and the length of the "/* " opening sequence.
-            $prefixLen = $this->getShortestWhitespacePrefixLen(substr($text, $newlinePos + 1));
+            $prefixLen = $this->getShortestWhitespacePrefixLen(explode("\n", $this->text, 2)[1]);
             $removeLen = $prefixLen - strlen($matches[0]);
-            return preg_replace('(^\s{' . $removeLen . '})m', '', $text);
+            return preg_replace('(^\s{' . $removeLen . '})m', '', $this->text);
         }
 
         // No idea how to format this comment, so simply return as is
-        return $text;
+        return $this->text;
     }
 
     /**
@@ -209,7 +207,7 @@ public function getReformattedText() {
      */
     private function getShortestWhitespacePrefixLen(string $str) : int {
         $lines = explode("\n", $str);
-        $shortestPrefixLen = \INF;
+        $shortestPrefixLen = 0;
         foreach ($lines as $line) {
             preg_match('(^\s*)', $line, $matches);
             $prefixLen = strlen($matches[0]);
@@ -221,14 +219,13 @@ private function getShortestWhitespacePrefixLen(string $str) : int {
     }
 
     /**
-     * @return       array
-     * @psalm-return array{nodeType:string, text:mixed, line:mixed, filePos:mixed}
+     * @psalm-return array{nodeType: string, text: string, line: int, filePos: int, tokenPos: int, endLine: int,
+     * endFilePos: int, endTokenPos: int}
      */
     public function jsonSerialize() : array {
         // Technically not a node, but we make it look like one anyway
-        $type = $this instanceof Comment\Doc ? 'Comment_Doc' : 'Comment';
         return [
-            'nodeType' => $type,
+            'nodeType' => 'Comment',
             'text' => $this->text,
             // TODO: Rename these to include "start".
             'line' => $this->startLine,

lib/PhpParser/Comment/Doc.php

@@ -4,4 +4,10 @@
 
 class Doc extends \PhpParser\Comment
 {
+    /**
+     * @inheritdoc
+     */
+    public function jsonSerialize() : array {
+        return ['nodeType' => 'Comment_Doc'] + parent::jsonSerialize();
+    }
 }