Allow registering of custom rich parser node visitors

Author: ondrejmirtes

conf/config.neon

@@ -360,6 +360,8 @@ services:
 
 	-
 		class: PhpParser\NodeVisitor\NodeConnectingVisitor
+		tags:
+			- phpstan.parser.richParserNodeVisitor
 
 	-
 		class: PhpParser\PrettyPrinter\Standard
@@ -601,6 +603,8 @@ services:
 
 	-
 		class: PHPStan\NodeVisitor\StatementOrderVisitor
+		tags:
+			- phpstan.parser.richParserNodeVisitor
 
 	-
 		class: PHPStan\Parallel\ParallelAnalyser

src/DependencyInjection/ConditionalTagsExtension.php

@@ -7,6 +7,7 @@
 use Nette\Schema\Expect;
 use PHPStan\Analyser\TypeSpecifierFactory;
 use PHPStan\Broker\BrokerFactory;
+use PHPStan\Parser\RichParser;
 use PHPStan\PhpDoc\TypeNodeResolverExtension;
 use PHPStan\Rules\RegistryFactory;
 use PHPStan\ShouldNotHappenException;
@@ -31,6 +32,7 @@ public function getConfigSchema(): Nette\Schema\Schema
 			TypeSpecifierFactory::FUNCTION_TYPE_SPECIFYING_EXTENSION_TAG => $bool,
 			TypeSpecifierFactory::METHOD_TYPE_SPECIFYING_EXTENSION_TAG => $bool,
 			TypeSpecifierFactory::STATIC_METHOD_TYPE_SPECIFYING_EXTENSION_TAG => $bool,
+			RichParser::VISITOR_SERVICE_TAG => $bool,
 		])->min(1));
 	}
 

src/Parser/RichParser.php

@@ -7,9 +7,8 @@
 use PhpParser\Node;
 use PhpParser\NodeTraverser;
 use PhpParser\NodeVisitor\NameResolver;
-use PhpParser\NodeVisitor\NodeConnectingVisitor;
+use PHPStan\DependencyInjection\Container;
 use PHPStan\File\FileReader;
-use PHPStan\NodeVisitor\StatementOrderVisitor;
 use PHPStan\ShouldNotHappenException;
 use function is_string;
 use function strpos;
@@ -20,12 +19,13 @@
 class RichParser implements Parser
 {
 
+	public const VISITOR_SERVICE_TAG = 'phpstan.parser.richParserNodeVisitor';
+
 	public function __construct(
 		private \PhpParser\Parser $parser,
 		private Lexer $lexer,
 		private NameResolver $nameResolver,
-		private NodeConnectingVisitor $nodeConnectingVisitor,
-		private StatementOrderVisitor $statementOrderVisitor,
+		private Container $container,
 	)
 	{
 	}
@@ -60,8 +60,10 @@ public function parseString(string $sourceCode): array
 
 		$nodeTraverser = new NodeTraverser();
 		$nodeTraverser->addVisitor($this->nameResolver);
-		$nodeTraverser->addVisitor($this->nodeConnectingVisitor);
-		$nodeTraverser->addVisitor($this->statementOrderVisitor);
+
+		foreach ($this->container->getServicesByTag(self::VISITOR_SERVICE_TAG) as $visitor) {
+			$nodeTraverser->addVisitor($visitor);
+		}
 
 		/** @var array<Node\Stmt> */
 		$nodes = $nodeTraverser->traverse($nodes);

tests/PHPStan/Analyser/AnalyserTest.php

@@ -497,8 +497,7 @@ private function createAnalyser(bool $reportUnmatchedIgnoredErrors): Analyser
 				new Php7($lexer),
 				$lexer,
 				new NameResolver(),
-				new NodeConnectingVisitor(),
-				new StatementOrderVisitor(),
+				self::getContainer(),
 			),
 			new DependencyResolver($fileHelper, $reflectionProvider, new ExportedNodeResolver($fileTypeMapper, $printer)),
 			$reportUnmatchedIgnoredErrors,