Allow doctrine/lexer 2

It is still possible to avoid a BC-break while doing so.

Author: greg0ire

composer.json

@@ -34,7 +34,7 @@
     "require": {
         "php": "^7.1 || ^8.0",
         "ext-tokenizer": "*",
-        "doctrine/lexer": "1.*",
+        "doctrine/lexer": "^1 || ^2",
         "psr/cache": "^1 || ^2 || ^3"
     },
     "require-dev": {

lib/Doctrine/Common/Annotations/DocLexer.php

@@ -15,6 +15,8 @@
 
 /**
  * Simple lexer for docblock annotations.
+ *
+ * @template-extends AbstractLexer<DocLexer::T_*>
  */
 final class DocLexer extends AbstractLexer
 {
@@ -39,7 +41,7 @@ final class DocLexer extends AbstractLexer
     public const T_COLON               = 112;
     public const T_MINUS               = 113;
 
-    /** @var array<string, int> */
+    /** @var array<string, self::T*> */
     protected $noCase = [
         '@'  => self::T_AT,
         ','  => self::T_COMMA,
@@ -53,7 +55,7 @@ final class DocLexer extends AbstractLexer
         '\\' => self::T_NAMESPACE_SEPARATOR,
     ];
 
-    /** @var array<string, int> */
+    /** @var array<string, self::T*> */
     protected $withCase = [
         'true'  => self::T_TRUE,
         'false' => self::T_FALSE,
@@ -126,4 +128,12 @@ protected function getType(&$value)
 
         return $type;
     }
+
+    /** @return array{value: int|string, type:self::T_*|null, position:int} */
+    public function peek(): array
+    {
+        $token = parent::peek();
+
+        return (array) $token;
+    }
 }

phpstan.neon

@@ -22,3 +22,5 @@ parameters:
 
         # That tag is empty on purpose
         - '#PHPDoc tag @var has invalid value \(\)\: Unexpected token "\*/", expected type at offset 9#'
+        # Backwards-compatibility
+        - '#^Return type.*of method.*DocLexer::peek.*should be compatible.*$#'

tests/Doctrine/Tests/Common/Annotations/DocLexerTest.php

@@ -19,9 +19,11 @@ public function testMarkerAnnotation(): void
 
         self::assertTrue($lexer->moveNext());
         self::assertNull($lexer->token);
+        self::assertNotNull($lexer->lookahead);
         self::assertEquals('@', $lexer->lookahead['value']);
 
         self::assertTrue($lexer->moveNext());
+        self::assertNotNull($lexer->token);
         self::assertEquals('@', $lexer->token['value']);
         self::assertEquals('Name', $lexer->lookahead['value']);