Skip to content

Commit c9c409e

Browse files
ashleyhindleashleyhindle
committed
feat: add 'all' script to output all guidelines in one file for evaluation/management
1 parent 4397b0a commit c9c409e

File tree

3 files changed

+160
-2
lines changed

3 files changed

+160
-2
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ src/Console/AssistCommand.php
88
composer.lock
99
/phpunit.xml
1010
.phpunit.result.cache
11+
all.md

‎all.php‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
require_once __DIR__.'/vendor/autoload.php';
6+
7+
use Laravel\Boost\Install\GuidelineComposer;
8+
use Laravel\Boost\Install\GuidelineConfig;
9+
use Laravel\Boost\Install\Herd;
10+
use Laravel\Roster\Roster;
11+
use Orchestra\Testbench\Concerns\CreatesApplication;
12+
13+
// Create a simple class that uses Orchestra Testbench to bootstrap Laravel
14+
$testbench = new class
15+
{
16+
use CreatesApplication;
17+
18+
protected function getPackageProviders($app)
19+
{
20+
// No need to register Laravel Boost since we're just using Blade
21+
return [];
22+
}
23+
24+
protected function defineEnvironment($app)
25+
{
26+
// Set a .test URL to enable Herd guidelines if needed
27+
$app['config']->set('app.url', 'http://localhost.test');
28+
}
29+
30+
public function bootstrap()
31+
{
32+
$app = $this->createApplication();
33+
34+
return $app;
35+
}
36+
};
37+
38+
// Bootstrap the Laravel application
39+
$app = $testbench->bootstrap();
40+
41+
// Create a mock Roster that returns ALL packages from .ai/ directory
42+
$mockRoster = new class extends Roster
43+
{
44+
public function packages(): \Laravel\Roster\PackageCollection
45+
{
46+
$packages = [];
47+
48+
// Find all package directories in .ai/
49+
$directories = glob(__DIR__.'/.ai/*', GLOB_ONLYDIR);
50+
51+
foreach ($directories as $dir) {
52+
$packageName = basename($dir);
53+
54+
// Skip special directories handled elsewhere in GuidelineComposer
55+
if (in_array($packageName, ['boost', 'herd'])) {
56+
continue;
57+
}
58+
59+
// Map directory names to Roster enum values where they exist
60+
$enumMapping = [
61+
'php' => \Laravel\Roster\Enums\Packages::LARAVEL, // Use Laravel as placeholder for php
62+
'laravel' => \Laravel\Roster\Enums\Packages::LARAVEL,
63+
'fluxui-free' => \Laravel\Roster\Enums\Packages::FLUXUI_FREE,
64+
'fluxui-pro' => \Laravel\Roster\Enums\Packages::FLUXUI_PRO,
65+
'inertia-laravel' => \Laravel\Roster\Enums\Packages::INERTIA_LARAVEL,
66+
'inertia-react' => \Laravel\Roster\Enums\Packages::INERTIA_REACT,
67+
'inertia-vue' => \Laravel\Roster\Enums\Packages::INERTIA_VUE,
68+
'livewire' => \Laravel\Roster\Enums\Packages::LIVEWIRE,
69+
'pest' => \Laravel\Roster\Enums\Packages::PEST,
70+
'phpunit' => \Laravel\Roster\Enums\Packages::PHPUNIT,
71+
'pint' => \Laravel\Roster\Enums\Packages::PINT,
72+
'volt' => \Laravel\Roster\Enums\Packages::VOLT,
73+
'folio' => \Laravel\Roster\Enums\Packages::FOLIO,
74+
'pennant' => \Laravel\Roster\Enums\Packages::PENNANT,
75+
'tailwindcss' => \Laravel\Roster\Enums\Packages::TAILWINDCSS,
76+
];
77+
78+
if (isset($enumMapping[$packageName])) {
79+
// Find ALL version directories and create a package for each
80+
$versionDirs = glob(__DIR__."/.ai/{$packageName}/*", GLOB_ONLYDIR);
81+
if (! empty($versionDirs)) {
82+
$versions = array_map('basename', $versionDirs);
83+
sort($versions, SORT_NUMERIC);
84+
85+
// Create a package instance for each version found
86+
foreach ($versions as $versionNumber) {
87+
$packages[] = new \Laravel\Roster\Package(
88+
$enumMapping[$packageName],
89+
$packageName,
90+
$versionNumber.'.0.0',
91+
false
92+
);
93+
}
94+
} else {
95+
// No version directories, just add the core package
96+
$packages[] = new \Laravel\Roster\Package(
97+
$enumMapping[$packageName],
98+
$packageName,
99+
'1.0.0',
100+
false
101+
);
102+
}
103+
}
104+
}
105+
106+
return new \Laravel\Roster\PackageCollection($packages);
107+
}
108+
};
109+
110+
$herd = new Herd();
111+
112+
// Create GuidelineComposer with all config options enabled to get ALL guidelines
113+
$config = new GuidelineConfig();
114+
$config->laravelStyle = true;
115+
$config->hasAnApi = true;
116+
$config->caresAboutLocalization = true;
117+
$config->enforceTests = true;
118+
119+
// Use the real GuidelineComposer with our mock Roster - this will use the exact same ordering logic
120+
$composer = new GuidelineComposer($mockRoster, $herd);
121+
$composer->config($config);
122+
123+
// Get the guidelines that GuidelineComposer would normally find
124+
$guidelines = $composer->guidelines();
125+
126+
// Add missing PHP versions (since GuidelineComposer only adds current PHP version)
127+
$reflection = new ReflectionClass($composer);
128+
$guidelineDirMethod = $reflection->getMethod('guidelinesDir');
129+
$guidelineDirMethod->setAccessible(true);
130+
131+
$phpVersions = ['8.1', '8.2', '8.3', '8.4'];
132+
$currentPhp = PHP_MAJOR_VERSION.'.'.PHP_MINOR_VERSION;
133+
134+
foreach ($phpVersions as $phpVersion) {
135+
if ($phpVersion !== $currentPhp) {
136+
$content = $guidelineDirMethod->invoke($composer, "php/{$phpVersion}");
137+
if (! empty($content)) {
138+
$guidelines->put("php/v{$phpVersion}", $content);
139+
}
140+
}
141+
}
142+
143+
// Now compose ALL guidelines (original + missing PHP versions)
144+
echo GuidelineComposer::composeGuidelines($guidelines);

‎src/Install/GuidelineComposer.php‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,18 @@ public function config(GuidelineConfig $config): self
3636
*/
3737
public function compose(): string
3838
{
39-
return $this->guidelines()
39+
return self::composeGuidelines($this->guidelines());
40+
}
41+
42+
/**
43+
* Static method to compose guidelines from a collection.
44+
* Can be used without Laravel dependencies.
45+
*
46+
* @param Collection<string, string> $guidelines
47+
*/
48+
public static function composeGuidelines(Collection $guidelines): string
49+
{
50+
return $guidelines
4051
->map(fn ($content, $key) => "\n=== {$key} ===\n\n{$content}")
4152
->join("\n\n");
4253
}
@@ -182,9 +193,11 @@ protected function guideline(string $path): ?string
182193
// Read the file content
183194
$content = file_get_contents($path);
184195

185-
// Temporarily replace backticks with placeholders before Blade processing so we support inline code
196+
// Temporarily replace backticks and PHP opening tags with placeholders before Blade processing
197+
// This prevents Blade from trying to execute PHP code examples and supports inline code
186198
$placeholders = [
187199
'`' => '___SINGLE_BACKTICK___',
200+
'<?php' => '___OPEN_PHP_TAG___',
188201
];
189202

190203
$content = str_replace(array_keys($placeholders), array_values($placeholders), $content);

0 commit comments

Comments
 (0)