Merge pull request #242 from laravel/add-package-priority-system-to-guideline-inclusion

feat: add package priority guideline inclusion

Author: ashleyhindle

src/Install/GuidelineComposer.php

@@ -6,6 +6,7 @@
 
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Blade;
+use Laravel\Roster\Enums\Packages;
 use Laravel\Roster\Roster;
 use Symfony\Component\Finder\Exception\DirectoryNotFoundException;
 use Symfony\Component\Finder\Finder;
@@ -21,6 +22,16 @@ class GuidelineComposer
 
     protected GuidelineAssist $guidelineAssist;
 
+    /**
+     * Package priority system to handle conflicts between packages.
+     * When a higher-priority package is present, lower-priority packages are excluded from guidelines.
+     *
+     * @var array<string, string[]>
+     */
+    protected array $packagePriorities = [
+        Packages::PEST->value => [Packages::PHPUNIT->value],
+    ];
+
     public function __construct(protected Roster $roster, protected Herd $herd)
     {
         $this->config = new GuidelineConfig;
@@ -118,6 +129,11 @@ protected function find(): Collection
         // Add all core and version specific docs for Roster supported packages
         // We don't add guidelines for packages unsupported by Roster right now
         foreach ($this->roster->packages() as $package) {
+            // Skip packages that should be excluded due to priority rules
+            if ($this->shouldExcludePackage($package->package()->value)) {
+                continue;
+            }
+
             $guidelineDir = str_replace('_', '-', strtolower($package->name()));
 
             $guidelines->put(
@@ -152,6 +168,23 @@ protected function find(): Collection
             ->where(fn (array $guideline) => ! empty(trim($guideline['content'])));
     }
 
+    /**
+     * Determines if a package should be excluded from guidelines based on priority rules.
+     */
+    protected function shouldExcludePackage(string $packageName): bool
+    {
+        foreach ($this->packagePriorities as $priorityPackage => $excludedPackages) {
+            if (in_array($packageName, $excludedPackages)) {
+                $priorityEnum = Packages::from($priorityPackage);
+                if ($this->roster->uses($priorityEnum)) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
     /**
      * @param string $dirPath
      * @return array<array{content: string, name: string, path: ?string, custom: bool}>

tests/Feature/Install/GuidelineComposerTest.php

@@ -298,3 +298,36 @@
         ->toContain('.ai/custom-rule')
         ->toContain('.ai/project-specific');
 });
+
+test('excludes PHPUnit guidelines when Pest is present due to package priority', function () {
+    $packages = new PackageCollection([
+        new Package(Packages::LARAVEL, 'laravel/framework', '11.0.0'),
+        new Package(Packages::PEST, 'pestphp/pest', '3.0.0'),
+        new Package(Packages::PHPUNIT, 'phpunit/phpunit', '10.0.0'),
+    ]);
+
+    $this->roster->shouldReceive('packages')->andReturn($packages);
+    $this->roster->shouldReceive('uses')->with(Packages::PEST)->andReturn(true);
+
+    $guidelines = $this->composer->compose();
+
+    expect($guidelines)
+        ->toContain('=== pest/core rules ===')
+        ->not->toContain('=== phpunit/core rules ===');
+});
+
+test('includes PHPUnit guidelines when Pest is not present', function () {
+    $packages = new PackageCollection([
+        new Package(Packages::LARAVEL, 'laravel/framework', '11.0.0'),
+        new Package(Packages::PHPUNIT, 'phpunit/phpunit', '10.0.0'),
+    ]);
+
+    $this->roster->shouldReceive('packages')->andReturn($packages);
+    $this->roster->shouldReceive('uses')->with(Packages::PEST)->andReturn(false);
+
+    $guidelines = $this->composer->compose();
+
+    expect($guidelines)
+        ->toContain('=== phpunit/core rules ===')
+        ->not->toContain('=== pest/core rules ===');
+});