feat(vite)!: automatically discover entrypoints (#1051)

innocenzi · web-flow · commit ebe3ef4eb434 · 2025-03-20T18:19:36.000+01:00
diff --git a/src/Tempest/Vite/src/BuildConfig.php b/src/Tempest/Vite/src/BuildConfig.php
diff --git a/src/Tempest/Vite/src/Installer/Tailwind/main.entrypoint.css b/src/Tempest/Vite/src/Installer/Tailwind/main.entrypoint.css
diff --git a/src/Tempest/Vite/src/Installer/Tailwind/main.entrypoint.ts b/src/Tempest/Vite/src/Installer/Tailwind/main.entrypoint.ts
diff --git a/src/Tempest/Vite/src/Installer/Vanilla/main.entrypoint.ts b/src/Tempest/Vite/src/Installer/Vanilla/main.entrypoint.ts
diff --git a/src/Tempest/Vite/src/Installer/ViteInstaller.php b/src/Tempest/Vite/src/Installer/ViteInstaller.php
@@ -59,9 +59,9 @@ public function install(): void
 
         // Publishes the Vite config
         $viteConfig = $this->publish(__DIR__ . "/{$templateDirectory}/vite.config.ts", destination: root_path('vite.config.ts'));
-        $mainTs = $this->publish(__DIR__ . "/{$templateDirectory}/main.ts", destination: src_path('main.ts'));
+        $mainTs = $this->publish(__DIR__ . "/{$templateDirectory}/main.entrypoint.ts", destination: src_path('main.entrypoint.ts'));
         $mainCss = $shouldInstallTailwind
-            ? $this->publish(__DIR__ . "/{$templateDirectory}/main.css", destination: src_path('main.css'))
+            ? $this->publish(__DIR__ . "/{$templateDirectory}/main.entrypoint.css", destination: src_path('main.entrypoint.css'))
             : null;
 
         // Install package.json scripts
@@ -79,8 +79,8 @@ public function install(): void
 
         // Updates the .gitignore
         $this->update(root_path('.gitignore'), function (ImmutableString $gitignore) {
-            if (! $gitignore->contains($this->viteConfig->build->bridgeFileName)) {
-                $gitignore = $gitignore->append(PHP_EOL, $this->viteConfig->build->bridgeFileName);
+            if (! $gitignore->contains($this->viteConfig->bridgeFileName)) {
+                $gitignore = $gitignore->append(PHP_EOL, $this->viteConfig->bridgeFileName);
             }
 
             if (! $gitignore->contains('node_modules')) {
@@ -101,18 +101,12 @@ public function install(): void
                 ? '<strong>Vite and Tailwind CSS are now installed in your project</strong>!'
                 : '<strong>Vite is now installed in your project</strong>!',
             PHP_EOL,
-            $viteConfig
-                ? sprintf('Configure <href="file://%s">vite.config.ts</href> as you see fit', $viteConfig)
-                : null,
-            $mainTs
-                ? sprintf(
-                    "Add <code><x-vite-tags :entrypoints='%s' /></code> to the <head> of your template",
-                    json_encode(array_filter([$mainCss, $mainTs]), JSON_UNESCAPED_SLASHES),
-                )
-                : 'Create a file and include it in your template with <code><x-vite-tags entrypoint="./path/to/file.ts" /></code>',
             "Run <code>{$packageManager->getRunCommand('dev')}</code> to start the <strong>development server</strong>",
+            $mainTs || $mainCss
+                ? 'Update <code>*.entrypoint.{ts,css}</code> files and observe changes in your browser'
+                : 'Create a <code>src/main.entrypoint.ts</code> file to get started with front-end code',
             PHP_EOL,
-            // '<style="fg-green">→</style> Read the <href="https://tempestphp.com/ocs/framework/vite">documentation</href>', // TODO: update when we have Vite docs
+            // '<style="fg-green">→</style> Read the <href="https://tempestphp.com/main/framework/vite">documentation</href>', // TODO: update when we have Vite docs
             '<style="fg-green">→</style> Join the <href="https://tempestphp.com/discord">Discord server</href>',
         ]);
     }
diff --git a/src/Tempest/Vite/src/TagsResolver/DevelopmentTagsResolver.php b/src/Tempest/Vite/src/TagsResolver/DevelopmentTagsResolver.php
@@ -26,7 +26,7 @@ public function resolveTags(array $entrypoints): array
     {
         return arr($entrypoints)
             ->map(function (string $entrypoint) {
-                if (! file_exists(root_path($entrypoint))) {
+                if (! file_exists($entrypoint) && ! file_exists(root_path($entrypoint))) {
                     throw new FileSystemEntrypointNotFoundException($entrypoint);
                 }
 
diff --git a/src/Tempest/Vite/src/TagsResolver/ManifestTagsResolver.php b/src/Tempest/Vite/src/TagsResolver/ManifestTagsResolver.php
@@ -238,7 +238,7 @@ private function getChunkPath(Chunk $chunk): string
 
     private function getAssetPath(string $path): string
     {
-        return ensure_starts_with($this->viteConfig->build->buildDirectory . '/' . $path, prefix: '/');
+        return ensure_starts_with($this->viteConfig->buildDirectory . '/' . $path, prefix: '/');
     }
 
     private function fileToAssetPath(string $file): string
diff --git a/src/Tempest/Vite/src/Vite.php b/src/Tempest/Vite/src/Vite.php
@@ -48,7 +48,7 @@ public function setNonce(string $nonce): void
     public function getTags(?array $entrypoints = null): array
     {
         return $this->getTagsResolver()->resolveTags(
-            array_filter($entrypoints ?: []) ?: array_filter($this->viteConfig->build->entrypoints ?: []),
+            array_filter($entrypoints ?: []) ?: array_filter($this->viteConfig->entrypoints ?: []),
         );
     }
 
@@ -97,7 +97,7 @@ private function getManifest(): Manifest
             return static::$manifest;
         }
 
-        if (! is_file($path = root_path('public', $this->viteConfig->build->buildDirectory, $this->viteConfig->build->manifest))) {
+        if (! is_file($path = root_path('public', $this->viteConfig->buildDirectory, $this->viteConfig->manifest))) {
             throw new ManifestNotFoundException($path);
         }
 
@@ -146,6 +146,6 @@ private function getBridgeFile(): ViteBridgeFile
 
     private function getBridgeFilePath(): string
     {
-        return root_path('public', $this->viteConfig->build->bridgeFileName);
+        return root_path('public', $this->viteConfig->bridgeFileName);
     }
 }
diff --git a/src/Tempest/Vite/src/ViteConfig.php b/src/Tempest/Vite/src/ViteConfig.php
@@ -10,15 +10,26 @@ final class ViteConfig
      * @param PrefetchConfig $prefetching Strategy for prefetching assets at runtime.
      * @param null|string $nonce The Content Security Policy nonce to apply to all generated tags.
      * @param string|false $integrityKey The key to check for integrity hashes within the manifest. Set to `false` to disable.
-     * @param BuildConfig $build Configuration related to the production build.
      * @param bool $useManifestDuringTesting Whether to use the manifest during tests. `false` by default.
+     * @param string $buildDirectory Name of the directory in which assets will be created by Vite. Relative to the `public` directory.
+     * @param string $bridgeFileName Name of the bridge file that the development server creates for Tempest to read. Relative to the `public` directory.
+     * @param string $manifest Name of the build manifest file generated by Vite for Tempest to read.
+     * @param string[] $entrypoints Paths to the entrypoints, relative to the root of the project.
      */
     public function __construct(
         public PrefetchConfig $prefetching = new PrefetchConfig(),
-        public BuildConfig $build = new BuildConfig(),
         public ?string $nonce = null,
         public string|false $integrityKey = 'integrity',
         public bool $useManifestDuringTesting = false,
+        public string $buildDirectory = 'build',
+        public string $bridgeFileName = 'vite-tempest',
+        public string $manifest = 'manifest.json',
+        public array $entrypoints = [],
     ) {
     }
+
+    public function addEntrypoint(string $path): void
+    {
+        $this->entrypoints[] = $path;
+    }
 }
diff --git a/src/Tempest/Vite/src/ViteConfigCommand.php b/src/Tempest/Vite/src/ViteConfigCommand.php
@@ -19,10 +19,10 @@ public function __construct(
     public function __invoke(): void
     {
         $this->console->writeRaw(json_encode([
-            'build_directory' => $this->viteConfig->build->buildDirectory,
-            'bridge_file_name' => $this->viteConfig->build->bridgeFileName,
-            'manifest' => $this->viteConfig->build->manifest,
-            'entrypoints' => $this->viteConfig->build->entrypoints,
+            'build_directory' => $this->viteConfig->buildDirectory,
+            'bridge_file_name' => $this->viteConfig->bridgeFileName,
+            'manifest' => $this->viteConfig->manifest,
+            'entrypoints' => $this->viteConfig->entrypoints,
         ]));
     }
 }
diff --git a/src/Tempest/Vite/src/ViteDiscovery.php b/src/Tempest/Vite/src/ViteDiscovery.php
@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Vite;
+
+use Tempest\Discovery\DiscoversPath;
+use Tempest\Discovery\Discovery;
+use Tempest\Discovery\DiscoveryLocation;
+use Tempest\Discovery\IsDiscovery;
+use Tempest\Reflection\ClassReflector;
+use Tempest\Vite\ViteConfig;
+
+use function Tempest\Support\str;
+use function Tempest\Support\Str\ends_with;
+
+final class ViteDiscovery implements Discovery, DiscoversPath
+{
+    use IsDiscovery;
+
+    public function __construct(
+        private readonly ViteConfig $viteConfig,
+    ) {
+    }
+
+    public function discover(DiscoveryLocation $location, ClassReflector $class): void
+    {
+        return;
+    }
+
+    public function discoverPath(DiscoveryLocation $location, string $path): void
+    {
+        if (! ends_with($path, ['.ts', '.css', '.js'])) {
+            return;
+        }
+
+        if (! str($path)->beforeLast('.')->endsWith('.entrypoint')) {
+            return;
+        }
+
+        if (! is_file($path)) {
+            return;
+        }
+
+        $this->discoveryItems->add($location, [$path]);
+    }
+
+    public function apply(): void
+    {
+        foreach ($this->discoveryItems as [$path]) {
+            $this->viteConfig->addEntrypoint($path);
+        }
+    }
+}
diff --git a/src/Tempest/Vite/src/ViteTagsComponent.php b/src/Tempest/Vite/src/ViteTagsComponent.php
@@ -24,7 +24,7 @@ public function compile(ViewComponentElement $element): string
         $entrypoints = match (true) {
             $element->hasAttribute('entrypoints') => '$entrypoints',
             $element->hasAttribute('entrypoint') => '$entrypoint',
-            default => var_export($this->viteConfig->build->entrypoints, return: true), // @mago-expect best-practices/no-debug-symbols
+            default => var_export($this->viteConfig->entrypoints, return: true), // @mago-expect best-practices/no-debug-symbols
         };
 
         return <<<HTML
diff --git a/src/Tempest/Vite/src/vite.config.php b/src/Tempest/Vite/src/vite.config.php
@@ -0,0 +1,5 @@
+<?php
+
+use Tempest\Vite\ViteConfig;
+
+return new ViteConfig();
diff --git a/tests/Integration/Vite/ViteConfigCommandTestCase.php b/tests/Integration/Vite/ViteConfigCommandTestCase.php
@@ -4,7 +4,6 @@
 
 namespace Tests\Tempest\Integration\Vite;
 
-use Tempest\Vite\BuildConfig;
 use Tempest\Vite\ViteConfig;
 use Tempest\Vite\ViteConfigCommand;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
@@ -24,12 +23,10 @@ public function test_outputs_json_default_config(): void
     public function test_outputs_json_custom_config(): void
     {
         $this->container->config(new ViteConfig(
-            build: new BuildConfig(
-                buildDirectory: 'build/website',
-                bridgeFileName: '.website',
-                manifest: 'website.json',
-                entrypoints: ['src/website/main.ts'],
-            ),
+            buildDirectory: 'build/website',
+            bridgeFileName: '.website',
+            manifest: 'website.json',
+            entrypoints: ['src/website/main.ts'],
         ));
 
         $this->console
diff --git a/tests/Integration/Vite/ViteTagsComponentTest.php b/tests/Integration/Vite/ViteTagsComponentTest.php
@@ -4,7 +4,6 @@
 
 namespace Tests\Tempest\Integration\Vite;
 
-use Tempest\Vite\BuildConfig;
 use Tempest\Vite\ViteConfig;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
 
@@ -27,9 +26,7 @@ public function test_dev_entrypoint(): void
         $this->vite->call(
             callback: function (): void {
                 $this->container->config(new ViteConfig(
-                    build: new BuildConfig(
-                        entrypoints: ['src/foo.ts', 'src/bar.css'],
-                    ),
+                    entrypoints: ['src/foo.ts', 'src/bar.css'],
                 ));
 
                 $html = $this->render(<<<'HTML'
@@ -62,9 +59,7 @@ public function test_dev_entrypoints(): void
         $this->vite->call(
             callback: function (): void {
                 $this->container->config(new ViteConfig(
-                    build: new BuildConfig(
-                        entrypoints: ['src/foo.ts', 'src/bar.css'],
-                    ),
+                    entrypoints: ['src/foo.ts', 'src/bar.css'],
                 ));
 
                 $html = $this->render(<<<'HTML'
@@ -97,9 +92,7 @@ public function test_dev_entrypoints_from_config(): void
         $this->vite->call(
             callback: function (): void {
                 $this->container->config(new ViteConfig(
-                    build: new BuildConfig(
-                        entrypoints: ['src/foo.ts', 'src/bar.css'],
-                    ),
+                    entrypoints: ['src/foo.ts', 'src/bar.css'],
                 ));
 
                 $html = $this->render(<<<'HTML'
@@ -133,9 +126,7 @@ public function test_production_entrypoint_from_config(): void
             callback: function (): void {
                 $this->container->config(new ViteConfig(
                     useManifestDuringTesting: true,
-                    build: new BuildConfig(
-                        entrypoints: ['src/foo.ts'],
-                    ),
+                    entrypoints: ['src/foo.ts'],
                 ));
 
                 $html = $this->render(<<<'HTML'
@@ -163,9 +154,7 @@ public function test_production_entrypoint(): void
             callback: function (): void {
                 $this->container->config(new ViteConfig(
                     useManifestDuringTesting: true,
-                    build: new BuildConfig(
-                        entrypoints: ['src/foo.ts'],
-                    ),
+                    entrypoints: ['src/foo.ts'],
                 ));
 
                 $html = $this->render(<<<'HTML'
@@ -193,9 +182,7 @@ public function test_production_entrypoints(): void
             callback: function (): void {
                 $this->container->config(new ViteConfig(
                     useManifestDuringTesting: true,
-                    build: new BuildConfig(
-                        entrypoints: ['src/foo.ts'],
-                    ),
+                    entrypoints: ['src/foo.ts'],
                 ));
 
                 $html = $this->render(<<<'HTML'
diff --git a/tests/Integration/Vite/ViteTest.php b/tests/Integration/Vite/ViteTest.php
@@ -4,10 +4,12 @@
 
 namespace Tests\Tempest\Integration\Vite;
 
-use Tempest\Vite\BuildConfig;
+use Tempest\Discovery\DiscoveryItems;
+use Tempest\Discovery\DiscoveryLocation;
 use Tempest\Vite\Exceptions\ManifestEntrypointNotFoundException;
 use Tempest\Vite\Vite;
 use Tempest\Vite\ViteConfig;
+use Tempest\Vite\ViteDiscovery;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
 
 /**
@@ -60,9 +62,7 @@ public function test_get_tags_in_development_with_configured_entrypoints(): void
         $this->vite->call(
             callback: function (): void {
                 $this->container->config(new ViteConfig(
-                    build: new BuildConfig(
-                        entrypoints: ['src/foo.ts', 'src/bar.css'],
-                    ),
+                    entrypoints: ['src/foo.ts', 'src/bar.css'],
                 ));
 
                 $vite = $this->container->get(Vite::class);
@@ -170,9 +170,7 @@ public function test_get_tags_with_entrypoints_and_global_entrypoints(): void
             callback: function (): void {
                 $this->container->config(new ViteConfig(
                     useManifestDuringTesting: true,
-                    build: new BuildConfig(
-                        entrypoints: ['src/foo.ts'],
-                    ),
+                    entrypoints: ['src/foo.ts'],
                 ));
 
                 $vite = $this->container->get(Vite::class);
@@ -188,4 +186,29 @@ public function test_get_tags_with_entrypoints_and_global_entrypoints(): void
             ],
         );
     }
+
+    public function test_discovery(): void
+    {
+        $this->vite->call(
+            root: __DIR__ . '/Fixtures/tmp',
+            callback: function (string $path): void {
+                $discovery = $this->container->get(ViteDiscovery::class);
+                $discovery->setItems(new DiscoveryItems([]));
+                $discovery->discoverPath(new DiscoveryLocation('', ''), $path);
+                $discovery->apply();
+
+                $vite = $this->container->get(Vite::class);
+                $tags = $vite->getTags();
+
+                $this->assertContains(
+                    needle: '<script type="module" src="http://localhost:5173/src/main.entrypoint.ts"></script>',
+                    haystack: $tags,
+                );
+            },
+            files: [
+                'src/main.entrypoint.ts' => '',
+                'public/vite-tempest' => ['url' => 'http://localhost:5173'],
+            ],
+        );
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public function resolveTags(array $entrypoints): array`
`26`	`26`	`{`
`27`	`27`	`return arr($entrypoints)`
`28`	`28`	`->map(function (string $entrypoint) {`
`29`		`- if (! file_exists(root_path($entrypoint))) {`
	`29`	`+ if (! file_exists($entrypoint) && ! file_exists(root_path($entrypoint))) {`
`30`	`30`	`throw new FileSystemEntrypointNotFoundException($entrypoint);`
`31`	`31`	`}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -238,7 +238,7 @@ private function getChunkPath(Chunk $chunk): string`
`238`	`238`
`239`	`239`	`private function getAssetPath(string $path): string`
`240`	`240`	`{`
`241`		`- return ensure_starts_with($this->viteConfig->build->buildDirectory . '/' . $path, prefix: '/');`
	`241`	`+ return ensure_starts_with($this->viteConfig->buildDirectory . '/' . $path, prefix: '/');`
`242`	`242`	`}`
`243`	`243`
`244`	`244`	`private function fileToAssetPath(string $file): string`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public function setNonce(string $nonce): void`
`48`	`48`	`public function getTags(?array $entrypoints = null): array`
`49`	`49`	`{`
`50`	`50`	`return $this->getTagsResolver()->resolveTags(`
`51`		`- array_filter($entrypoints ?: []) ?: array_filter($this->viteConfig->build->entrypoints ?: []),`
	`51`	`+ array_filter($entrypoints ?: []) ?: array_filter($this->viteConfig->entrypoints ?: []),`
`52`	`52`	`);`
`53`	`53`	`}`
`54`	`54`
`@@ -97,7 +97,7 @@ private function getManifest(): Manifest`
`97`	`97`	`return static::$manifest;`
`98`	`98`	`}`
`99`	`99`
`100`		`- if (! is_file($path = root_path('public', $this->viteConfig->build->buildDirectory, $this->viteConfig->build->manifest))) {`
	`100`	`+ if (! is_file($path = root_path('public', $this->viteConfig->buildDirectory, $this->viteConfig->manifest))) {`
`101`	`101`	`throw new ManifestNotFoundException($path);`
`102`	`102`	`}`
`103`	`103`
`@@ -146,6 +146,6 @@ private function getBridgeFile(): ViteBridgeFile`
`146`	`146`
`147`	`147`	`private function getBridgeFilePath(): string`
`148`	`148`	`{`
`149`		`- return root_path('public', $this->viteConfig->build->bridgeFileName);`
	`149`	`+ return root_path('public', $this->viteConfig->bridgeFileName);`
`150`	`150`	`}`
`151`	`151`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,10 @@ public function __construct(`
`19`	`19`	`public function __invoke(): void`
`20`	`20`	`{`
`21`	`21`	`$this->console->writeRaw(json_encode([`
`22`		`- 'build_directory' => $this->viteConfig->build->buildDirectory,`
`23`		`- 'bridge_file_name' => $this->viteConfig->build->bridgeFileName,`
`24`		`- 'manifest' => $this->viteConfig->build->manifest,`
`25`		`- 'entrypoints' => $this->viteConfig->build->entrypoints,`
	`22`	`+ 'build_directory' => $this->viteConfig->buildDirectory,`
	`23`	`+ 'bridge_file_name' => $this->viteConfig->bridgeFileName,`
	`24`	`+ 'manifest' => $this->viteConfig->manifest,`
	`25`	`+ 'entrypoints' => $this->viteConfig->entrypoints,`
`26`	`26`	`]));`
`27`	`27`	`}`
`28`	`28`	`}`