[FEATURE] Add comsumeWhitespaceWithComments and redirect comsumeWhite…

…space

Having comsumeWhitespace also consume comments and returning them was unexpected.

Signed-off-by: Daniel Ziegenberg <daniel@ziegenberg.at>

CHANGELOG.md

@@ -7,9 +7,12 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ### Added
 
+- Add `ParserState::comsumeWhitespaceWithComments` method (#668)
+
 ### Changed
 
 - Mark all class constants as `@internal` (#500)
+- Redirect `ParserState::comsumeWhitespace` to `ParserState::comsumeWhitespaceWithComments` (#668)
 
 ### Deprecated
 

src/Parsing/ParserState.php

@@ -226,12 +226,27 @@ public function parseCharacter($bIsForIdentifier)
     }
 
     /**
-     * @return array<int, Comment>|void
+     * Consumes whitespace and comments and returns a list of comments.
+     *
+     * @return list<Comment> List of comments.
+     *
+     * @throws UnexpectedEOFException
+     * @throws UnexpectedTokenException
+     */
+    public function comsumeWhitespace(): array
+    {
+        return $this->comsumeWhitespaceWithComments();
+    }
+
+    /**
+     * Consumes whitespace and comments and returns a list of comments.
+     *
+     * @return list<Comment> List of comments.
      *
      * @throws UnexpectedEOFException
      * @throws UnexpectedTokenException
      */
-    public function consumeWhiteSpace()
+    public function comsumeWhitespaceWithComments()
     {
         $aComments = [];
         do {