[FEATURE] Add comsumeWhitespaceWithComments and redirect comsumeWhite…

…space (MyIntervals#670) Having comsumeWhitespace also consume comments and returning them was unexpected. Signed-off-by: Daniel Ziegenberg <[email protected]>
ziegenberg · Aug 25, 2024 · 62dddaf · 62dddaf
1 parent d2fb94a
commit 62dddaf
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,8 +7,12 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ### Added
 
+- Add `ParserState::comsumeWhitespaceWithComments()` method (#670)
+
 ### Changed
 
+- Redirect `ParserState::comsumeWhitespace()` to `ParserState::comsumeWhitespaceWithComments()` (#670)
+
 ### Deprecated
 
 ### Removed

diff --git a/src/Parsing/ParserState.php b/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 {