feat: add preload command

composer.json

@@ -18,6 +18,7 @@
 	"minimum-stability": "stable",
 	"require": {
 		"php": ">=8.1",
+		"illuminate/console": "^11|^10",
 		"illuminate/support": "^11|^10",
 		"guzzlehttp/guzzle": "^7"
 	},

docs/commands/preload.mdx

@@ -0,0 +1,33 @@
+---
+title: 'Preload command'
+sidebarTitle: 'Preload '
+description: 'Preload all Unicon commands on deployment'
+icon: 'terminal'
+---
+
+Unicon provides the `icons:preload` to preload all icons on deployment.
+
+```bash
+php artisan icons:preload
+```
+
+While Unicon will hapilly fetch icons on-demand, this command will ensure that
+even the first render of an icon will be as fast as possible, because they will
+be pulled from the cache instead of the Iconify API.
+
+## Caveats
+
+This command performs a recursive regex search on all the Blade files in your
+application (excluding `node_modules` and `vendor`). This means that only icons 
+that are statically defined will be detected.
+
+| Will be found ✅ | Will not be found ❌ |
+| ------------- | ----------------- |
+| `<x-icon name="noto:unicorn" />` | `<x-icon name="{{ $icon }}" />` |
+| `<x-icon name="heroicons:clock" />` | `<x-icon :name="$name" />` |
+
+<Tip>
+Icons whose name is dynamically defined will have to be fetched on-demand
+the very first time they are rendered, and subsequent renders will be cached
+all the same.
+</Tip>

docs/mint.json

@@ -56,6 +56,10 @@
 			"group": "Components",
 			"pages": ["components/blade-component", "components/helper-function"]
 		},
+		{
+			"group": "Commands",
+			"pages": ["commands/preload"]
+		},
 		{
 			"group": "Reference",
 			"pages": ["config-reference", "credits"]

src/Commands/IconsPreloadCommand.php

@@ -0,0 +1,115 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hedger\Unicon\Commands;
+
+use Hedger\Unicon\IconRenderer;
+use Illuminate\Console\Command;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
+
+class IconsPreloadCommand extends Command
+{
+    /**
+     * The name and signature of the console command
+     */
+    protected $signature = 'icons:preload';
+
+    /**
+     * The console command description
+     */
+    protected $description = 'Preloads all Unicon icons';
+
+    public function __construct(
+        protected IconRenderer $renderer,
+    ) {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command
+     */
+    public function handle(): int
+    {
+        $this->info('Looking for icons to preload in your Blade files...');
+
+        $this->findAllBladeFiles()
+            ->flatMap(fn(string $file) => $this->findIconsInFile($file))
+            ->unique()
+            ->sort()
+            ->each(fn(string $icon) => $this->preloadIcon($icon));
+
+        return self::SUCCESS;
+    }
+
+    /**
+     * Find all Blade files in the application
+     * 
+     * This method will look for all Blade files in the application and return
+     * them as an array of paths.
+     * 
+     * @return Collection<string>
+     */
+    protected function findAllBladeFiles(): Collection
+    {
+        return $this->glob('*.blade.php');
+    }
+
+    /**
+     * Recursive glob
+     * 
+     * This method will recursively glob files using the given pattern.
+     */
+    protected function glob(string $pattern, ?string $root = null): Collection
+    {
+        $root ??= base_path();
+
+        $files = collect(glob($root . '/' . $pattern));
+
+        collect(glob($root . '/*', GLOB_ONLYDIR))->each(function ($dir) use (&$files, $pattern) {
+            if (!in_array(basename($dir), ['node_modules', 'vendor'])) {
+                $files = $files->merge($this->glob($pattern, $dir));
+            }
+        });
+
+        return $files;
+    }
+
+    /**
+     * Find all icons in a Blade file
+     * 
+     * This method will attempt to find all Unicon icons in a Blade file
+     * by performing a regex search on the file contents. This implementation
+     * only works for icons that have been statitcally defined. Variables in
+     * the name attribute will not be evaluated.
+     */
+    protected function findIconsInFile(string $path): Collection
+    {
+        $contents = file_get_contents($path);
+
+        $componentName = Str::snake(config('unicon.name', 'icon'));
+
+        $hasMatches = preg_match_all(
+            pattern: '/<x-' . $componentName . '\s+name\s*=\s*(["\'])(?<name>[\s\S]*?)\1/m',
+            subject: $contents,
+            matches: $matches,
+            flags: PREG_SET_ORDER,
+        );
+
+        if (!$hasMatches) {
+            return [];
+        }
+
+        return collect($matches)->map(fn($match) => $match['name']);
+    }
+
+    /**
+     * Preloads an icon
+     */
+    protected function preloadIcon(string $icon): void
+    {
+        $this->info("Preloading {$icon}...");
+        $this->renderer->render($icon);
+    }
+}

src/IconServiceProvider.php

@@ -13,7 +13,7 @@ class IconServiceProvider extends ServiceProvider
     public function register(): void
     {
         // Merge the default configuration
-        $this->mergeConfigFrom(__DIR__.'/../config/unicon.php', 'unicon');
+        $this->mergeConfigFrom(__DIR__ . '/../config/unicon.php', 'unicon');
 
         // Bind the IconRenderer to the container
         $this->app->bind(IconRenderer::class, function (Application $app) {
@@ -34,8 +34,12 @@ public function boot(): void
     {
         if ($this->app->runningInConsole()) {
             $this->publishes([
-                __DIR__.'/../config/unicon.php' => config_path('unicon.php'),
+                __DIR__ . '/../config/unicon.php' => config_path('unicon.php'),
             ], 'unicon-config');
+
+            $this->commands([
+                Commands\IconsPreloadCommand::class,
+            ]);
         }
     }
 }