skip framework and web profile bundle imports in NoRoutingPrefixRule (#181)

Author: TomasVotruba

src/Rules/Symfony/NoRoutingPrefixRule.php

@@ -7,6 +7,7 @@
 use PhpParser\Node;
 use PhpParser\Node\Expr\MethodCall;
 use PhpParser\Node\Identifier;
+use PhpParser\Node\Scalar\String_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleError;
@@ -42,8 +43,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        $methodName = $node->name->toString();
-        if ($methodName !== 'prefix') {
+        if ($node->name->toString() !== 'prefix') {
             return [];
         }
 
@@ -56,11 +56,39 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
+        if ($this->isAllowedExternalBundleImport($node)) {
+            return [];
+        }
+
         $ruleError = RuleErrorBuilder::message(self::ERROR_MESSAGE)
             ->line($node->getStartLine())
             ->identifier(SymfonyRuleIdentifier::NO_ROUTING_PREFIX)
             ->build();
 
         return [$ruleError];
     }
+
+    private function isAllowedExternalBundleImport(MethodCall $methodCall): bool
+    {
+        if (! $methodCall->var instanceof MethodCall) {
+            return false;
+        }
+
+        $parentCaller = $methodCall->var;
+        if (! $parentCaller->name instanceof Identifier || $parentCaller->name->toString() !== 'import') {
+            return false;
+        }
+
+        $importArgPath = $parentCaller->getArgs()[0]->value;
+        if (! $importArgPath instanceof String_) {
+            return false;
+        }
+
+        // these external bundles are typically prefixed on purpose
+        if (str_starts_with($importArgPath->value, '@FrameworkBundle')) {
+            return true;
+        }
+
+        return str_starts_with($importArgPath->value, '@WebProfilerBundle');
+    }
 }

tests/Rules/Symfony/NoRoutingPrefixRule/Fixture/skip_bundle_import.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
+
+return static function (RoutingConfigurator $routingConfigurator): void {
+    $routingConfigurator->import('@FrameworkBundle/Resources/config/routing/errors.xml')
+        ->prefix('/_error');
+};

tests/Rules/Symfony/NoRoutingPrefixRule/NoRoutingPrefixRuleTest.php

@@ -25,6 +25,10 @@ public static function provideData(): Iterator
             __DIR__ . '/Fixture/skip_no_route_prefix.php',
         ], []];
 
+        yield [[
+            __DIR__ . '/Fixture/skip_bundle_import.php',
+        ], []];
+
         yield [[
             __DIR__ . '/Fixture/routing_imports.php',
         ], [[NoRoutingPrefixRule::ERROR_MESSAGE, 8]]];