Skip CommandMustHaveAsCommandAttributeRule when symfony/console not in require

README.md

@@ -2607,7 +2607,7 @@ return function (ContainerConfigurator $container) {
 
 ### CommandMustHaveAsCommandAttributeRule
 
-Every class that extends Symfony `Command` must declare the `#[AsCommand]` attribute.
+Every class that extends Symfony `Command` must declare the `#[AsCommand]` attribute. Skipped when `symfony/console` is not a `require` dependency (a `require-dev` only entry is ignored).
 
 ```yaml
 rules:

config/symfony-rules.neon

@@ -57,6 +57,11 @@ conditionalTags:
 services:
     - Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver
 
+    -
+        class: Symplify\PHPStanRules\Composer\ComposerRequireResolver
+        arguments:
+            workingDirectory: %currentWorkingDirectory%
+
     - Symplify\PHPStanRules\Rules\Symfony\SingleArgEventDispatchRule
     - Symplify\PHPStanRules\Rules\Symfony\NoListenerWithoutContractRule
     - Symplify\PHPStanRules\Rules\Symfony\NoStringInGetSubscribedEventsRule

src/Composer/ComposerRequireResolver.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Composer;
+
+final class ComposerRequireResolver
+{
+    /**
+     * @readonly
+     */
+    private string $workingDirectory;
+
+    public function __construct(string $workingDirectory)
+    {
+        $this->workingDirectory = $workingDirectory;
+    }
+
+    public function hasRequiredPackage(string $packageName): bool
+    {
+        $composerJsonFilePath = $this->workingDirectory . '/composer.json';
+        if (! is_file($composerJsonFilePath)) {
+            return false;
+        }
+
+        $composerJson = json_decode((string) file_get_contents($composerJsonFilePath), true);
+        if (! is_array($composerJson)) {
+            return false;
+        }
+
+        // only the "require" section counts, "require-dev" is skipped on purpose
+        $require = $composerJson['require'] ?? [];
+        if (! is_array($require)) {
+            return false;
+        }
+
+        return isset($require[$packageName]);
+    }
+}

src/Rules/Symfony/CommandMustHaveAsCommandAttributeRule.php

@@ -13,6 +13,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use Symfony\Component\Console\Command\Command;
+use Symplify\PHPStanRules\Composer\ComposerRequireResolver;
 use Symplify\PHPStanRules\Rules\Enum\SymfonyAttribute;
 
 /**
@@ -28,9 +29,9 @@ final class CommandMustHaveAsCommandAttributeRule implements Rule
     private ReflectionProvider $reflectionProvider;
 
     /**
-     * @var string
+     * @readonly
      */
-    private const LARAVEL_COMMAND_CLASS = 'Illuminate\Console\Command';
+    private ComposerRequireResolver $composerRequireResolver;
 
     /**
      * @var string
@@ -40,13 +41,17 @@ final class CommandMustHaveAsCommandAttributeRule implements Rule
     /**
      * @var string
      */
-    public const ERROR_MESSAGE = 'Class "%s" extends Command but is missing the #[AsCommand] attribute';
+    private const LARAVEL_COMMAND_CLASS = 'Illuminate\Console\Command';
 
-    private ?bool $hasSymfonyConsolePackage = null;
+    /**
+     * @var string
+     */
+    public const ERROR_MESSAGE = 'Class "%s" extends Command but is missing the #[AsCommand] attribute';
 
-    public function __construct(ReflectionProvider $reflectionProvider)
+    public function __construct(ReflectionProvider $reflectionProvider, ComposerRequireResolver $composerRequireResolver)
     {
         $this->reflectionProvider = $reflectionProvider;
+        $this->composerRequireResolver = $composerRequireResolver;
     }
 
     public function getNodeType(): string
@@ -66,8 +71,8 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        // only projects that depend on symfony/console in composer.json
-        if (! $this->hasSymfonyConsolePackage()) {
+        // symfony/console must be a direct production dependency, require-dev is skipped
+        if (! $this->composerRequireResolver->hasRequiredPackage(self::SYMFONY_CONSOLE_PACKAGE)) {
             return [];
         }
 
@@ -109,38 +114,4 @@ public function processNode(Node $node, Scope $scope): array
 
         return [$identifierRuleError];
     }
-
-    private function hasSymfonyConsolePackage(): bool
-    {
-        if ($this->hasSymfonyConsolePackage !== null) {
-            return $this->hasSymfonyConsolePackage;
-        }
-
-        $composerJsonFilePath = getcwd() . '/composer.json';
-        if (! is_file($composerJsonFilePath)) {
-            return $this->hasSymfonyConsolePackage = false;
-        }
-
-        $composerJsonContents = file_get_contents($composerJsonFilePath);
-        if ($composerJsonContents === false) {
-            return $this->hasSymfonyConsolePackage = false;
-        }
-
-        $composerJson = json_decode($composerJsonContents, true);
-        if (! is_array($composerJson)) {
-            return $this->hasSymfonyConsolePackage = false;
-        }
-
-        $requirePackages = $composerJson['require'] ?? [];
-        if (is_array($requirePackages) && isset($requirePackages[self::SYMFONY_CONSOLE_PACKAGE])) {
-            return $this->hasSymfonyConsolePackage = true;
-        }
-
-        $requireDevPackages = $composerJson['require-dev'] ?? [];
-        if (is_array($requireDevPackages) && isset($requireDevPackages[self::SYMFONY_CONSOLE_PACKAGE])) {
-            return $this->hasSymfonyConsolePackage = true;
-        }
-
-        return $this->hasSymfonyConsolePackage = false;
-    }
 }

tests/Composer/ComposerRequireResolverTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Composer;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use Symplify\PHPStanRules\Composer\ComposerRequireResolver;
+
+final class ComposerRequireResolverTest extends TestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $workingDirectory, bool $expectedHasPackage): void
+    {
+        $composerRequireResolver = new ComposerRequireResolver($workingDirectory);
+
+        $this->assertSame($expectedHasPackage, $composerRequireResolver->hasRequiredPackage('symfony/console'));
+    }
+
+    /**
+     * @return Iterator<array{string, bool}>
+     */
+    public static function provideData(): Iterator
+    {
+        yield [__DIR__ . '/Fixture/with-require', true];
+        yield [__DIR__ . '/Fixture/with-require-dev', false];
+        yield [__DIR__ . '/Fixture/without', false];
+        yield [__DIR__ . '/Fixture/non-existing-directory', false];
+    }
+}

tests/Composer/Fixture/with-require-dev/composer.json

@@ -0,0 +1,5 @@
+{
+    "require-dev": {
+        "symfony/console": "^7.0"
+    }
+}

tests/Composer/Fixture/with-require/composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "symfony/console": "^7.0"
+    }
+}

tests/Composer/Fixture/without/composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "php": ">=8.3"
+    }
+}

tests/Rules/Symfony/CommandMustHaveAsCommandAttributeRule/composer-fixture/composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "symfony/console": "^7.0"
+    }
+}

tests/Rules/Symfony/CommandMustHaveAsCommandAttributeRule/config/configured_rule.neon

@@ -1,5 +1,11 @@
 includes:
     - ../../../../config/included_services.neon
 
+services:
+    -
+        class: Symplify\PHPStanRules\Composer\ComposerRequireResolver
+        arguments:
+            workingDirectory: 'tests/Rules/Symfony/CommandMustHaveAsCommandAttributeRule/composer-fixture'
+
 rules:
     - Symplify\PHPStanRules\Rules\Symfony\CommandMustHaveAsCommandAttributeRule