feat(vite): mention <x-vite-tags /> and documentation link in post-install instructions (#1473)

innocenzi · web-flow · commit 477dfa969844 · 2025-08-11T18:44:48.000+02:00
diff --git a/packages/support/src/JavaScript/DependencyInstaller.php b/packages/support/src/JavaScript/DependencyInstaller.php
@@ -41,7 +41,7 @@ public function installDependencies(string $cwd, string|array $dependencies, boo
     /**
      * Installs dependencies without interacting with the console.
      */
-    public function silentlyInstallDependencies(string $cwd, string|array $dependencies, bool $dev = false, ?PackageManager $defaultPackageManager = null): void
+    public function silentlyInstallDependencies(string $cwd, string|array $dependencies, bool $dev = false, PackageManager $defaultPackageManager = PackageManager::NPM): void
     {
         $install = $this->getInstallProcess(
             packageManager: PackageManager::detect($cwd) ?? $defaultPackageManager,
diff --git a/packages/vite/src/Installer/ViteInstaller.php b/packages/vite/src/Installer/ViteInstaller.php
@@ -29,7 +29,7 @@ public function __construct(
 
     private function shouldInstallTailwind(): bool
     {
-        $argument = $this->consoleArgumentBag->get('tailwind');
+        $argument = $this->consoleArgumentBag->get('tailwindcss');
 
         if ($argument === null || ! is_bool($argument->value)) {
             return $this->console->confirm('Install Tailwind CSS as well?', default: true);
@@ -42,8 +42,8 @@ public function install(): void
     {
         $shouldInstallTailwind = $this->shouldInstallTailwind();
         $templateDirectory = $shouldInstallTailwind
-            ? 'Tailwind'
-            : 'Vanilla';
+            ? 'tailwindcss'
+            : 'vanilla';
 
         // Installs the dependencies
         $this->javascript->installDependencies(
@@ -63,7 +63,12 @@ public function install(): void
             ? $this->publish(__DIR__ . "/{$templateDirectory}/main.css", destination: src_path('main.entrypoint.css'))
             : null;
 
-        // Install package.json scripts
+        // Adds `package.json` if it does not exist
+        if (! is_file(root_path('package.json'))) {
+            $this->publish(__DIR__ . '/package.json', root_path('package.json'));
+        }
+
+        // Installs package.json scripts
         $this->updateJson(root_path('package.json'), function (array $json) {
             $json['type'] = 'module';
             $json['scripts'] ??= [];
@@ -104,12 +109,13 @@ 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,
+            'Add <code><x-vite-tags /></code> to the <code><head></code> of your template',
             "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/main/framework/vite">documentation</href>', // TODO: update when we have Vite docs
+            '<style="fg-green">→</style> Read the <href="https://tempestphp.com/docs/features/asset-bundling">documentation</href>',
             '<style="fg-green">→</style> Join the <href="https://tempestphp.com/discord">Discord server</href>',
         ]);
     }
diff --git a/packages/vite/src/Installer/package.json b/packages/vite/src/Installer/package.json
@@ -0,0 +1,3 @@
+{
+	"type": "module"
+}
diff --git a/packages/vite/src/Installer/tailwindcss/main.css b/packages/vite/src/Installer/tailwindcss/main.css
diff --git a/packages/vite/src/Installer/tailwindcss/main.ts b/packages/vite/src/Installer/tailwindcss/main.ts
diff --git a/packages/vite/src/Installer/tailwindcss/vite.config.ts b/packages/vite/src/Installer/tailwindcss/vite.config.ts
diff --git a/rector.php b/rector.php
@@ -19,6 +19,7 @@
 use Rector\Php82\Rector\Param\AddSensitiveParameterAttributeRector;
 use Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector;
 use Rector\Php84\Rector\Param\ExplicitNullableParamTypeRector;
+use Rector\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector;
 use Rector\TypeDeclaration\Rector\ArrowFunction\AddArrowFunctionReturnTypeRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\ReturnNeverTypeRector;
 use Rector\TypeDeclaration\Rector\Closure\ClosureReturnTypeRector;
@@ -56,6 +57,7 @@
         ClosureReturnTypeRector::class,
         EncapsedStringsToSprintfRector::class,
         AddArrowFunctionReturnTypeRector::class,
+        PrivatizeFinalClassMethodRector::class,
     ])
     ->withParallel(300, 10, 10)
     ->withPreparedSets(
diff --git a/src/Tempest/Framework/Testing/InstallerTester.php b/src/Tempest/Framework/Testing/InstallerTester.php
@@ -9,9 +9,10 @@
 use RecursiveIteratorIterator;
 use Tempest\Container\Container;
 use Tempest\Core\Composer;
-use Tempest\Core\ComposerNamespace;
 use Tempest\Core\FrameworkKernel;
 use Tempest\Core\ShellExecutors\NullShellExecutor;
+use Tempest\Support\Arr;
+use Tempest\Support\Filesystem;
 use Tempest\Support\Namespace\Psr4Namespace;
 
 use function Tempest\Support\arr;
@@ -39,13 +40,8 @@ public function configure(string $root, Psr4Namespace $namespace): self
             ->setNamespaces($namespace)
             ->setShellExecutor($this->executor);
 
-        if (! is_dir($this->root)) {
-            mkdir($this->root, recursive: true);
-        }
-
-        if (! is_dir($namespace->path)) {
-            mkdir($namespace->path, recursive: true);
-        }
+        Filesystem\ensure_directory_exists($this->root);
+        Filesystem\ensure_directory_exists($namespace->path);
 
         return $this;
     }
@@ -66,20 +62,14 @@ public function put(string $path, string $contents): self
     {
         $path = $this->path($path);
 
-        $dir = dirname($path);
-
-        if (! is_dir($dir)) {
-            mkdir($dir, recursive: true);
-        }
-
-        file_put_contents($path, $contents);
+        Filesystem\write_file($path, $contents);
 
         return $this;
     }
 
     public function get(string $path): string
     {
-        return file_get_contents($this->path($path));
+        return Filesystem\read_file($this->path($path));
     }
 
     public function assertFileExists(string $path, ?string $content = null): self
@@ -96,17 +86,31 @@ public function assertFileExists(string $path, ?string $content = null): self
         return $this;
     }
 
-    public function assertFileContains(string $path, string $search): self
+    public function assertDirectoryExists(string $path): self
     {
-        Assert::assertStringContainsString(
-            needle: $search,
-            haystack: $this->get($path),
-            message: sprintf("File %s does not contain:\n %s", $path, $search),
+        Assert::assertDirectoryExists(
+            directory: $this->path($path),
+            message: sprintf('Directory "%s" does not exist', $path),
         );
 
         return $this;
     }
 
+    public function assertFileContains(string $path, string|iterable $search): self
+    {
+        $content = $this->get($path);
+
+        foreach (Arr\wrap($search) as $item) {
+            Assert::assertStringContainsString(
+                needle: $item,
+                haystack: $content,
+                message: sprintf("File %s does not contain:\n %s", $path, $item),
+            );
+        }
+
+        return $this;
+    }
+
     public function assertFileNotContains(string $path, string $search): self
     {
         Assert::assertStringNotContainsString(
@@ -130,17 +134,6 @@ public function assertCommandExecuted(string $command): self
 
     public function clean(): void
     {
-        $files = new RecursiveIteratorIterator(
-            new RecursiveDirectoryIterator($this->root, RecursiveDirectoryIterator::SKIP_DOTS),
-            RecursiveIteratorIterator::CHILD_FIRST,
-        );
-
-        foreach ($files as $file) {
-            $file->isDir()
-                ? @rmdir($file->getRealPath())
-                : @unlink($file->getRealPath());
-        }
-
-        @rmdir($this->root);
+        Filesystem\delete_directory($this->root);
     }
 }
diff --git a/tests/Integration/Vite/ViteInstallerTest.php b/tests/Integration/Vite/ViteInstallerTest.php
@@ -0,0 +1,54 @@
+<?php
+
+namespace Tests\Tempest\Integration\Vite;
+
+use PHPUnit\Framework\Attributes\After;
+use PHPUnit\Framework\Attributes\PreCondition;
+use PHPUnit\Framework\Attributes\Test;
+use Tempest\Core\Commands\InstallCommand;
+use Tempest\Support\JavaScript\DependencyInstaller;
+use Tempest\Support\Namespace\Psr4Namespace;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+
+final class ViteInstallerTest extends FrameworkIntegrationTestCase
+{
+    #[PreCondition]
+    protected function configure(): void
+    {
+        $this->installer->configure(__DIR__ . '/install', new Psr4Namespace('App\\', __DIR__ . '/install/app'));
+
+        // force usage of npm because bun will mutate Tempest's root install otherwise
+        touch(__DIR__ . '/install/package-lock.json');
+    }
+
+    #[After]
+    protected function after(): void
+    {
+        $this->installer->clean();
+    }
+
+    #[Test]
+    public function intalls_vite(): void
+    {
+        $this->console->call(InstallCommand::class, ['vite', '--force']);
+
+        $this->installer->assertFileExists('vite.config.ts');
+        $this->installer->assertFileExists('app/main.entrypoint.ts');
+        $this->installer->assertFileExists('app/main.entrypoint.css');
+
+        $this->installer->assertFileContains('package.json', '"vite"');
+        $this->installer->assertFileContains('package.json', '"vite build"');
+    }
+
+    #[Test]
+    public function intalls_tailwindcss(): void
+    {
+        $this->console->call(InstallCommand::class, ['vite', 'tailwindcss', '--force']);
+
+        $this->installer->assertFileExists('app/main.entrypoint.ts');
+
+        $this->installer->assertFileContains('app/main.entrypoint.css', '@import');
+        $this->installer->assertFileContains('package.json', ['"vite"', '"vite build"']);
+        $this->installer->assertFileContains('vite.config.ts', 'vite-plugin-tempest');
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function installDependencies(string $cwd, string\|array $dependencies, boo`
`41`	`41`	`/**`
`42`	`42`	`* Installs dependencies without interacting with the console.`
`43`	`43`	`*/`
`44`		`- public function silentlyInstallDependencies(string $cwd, string\|array $dependencies, bool $dev = false, ?PackageManager $defaultPackageManager = null): void`
	`44`	`+ public function silentlyInstallDependencies(string $cwd, string\|array $dependencies, bool $dev = false, PackageManager $defaultPackageManager = PackageManager::NPM): void`
`45`	`45`	`{`
`46`	`46`	`$install = $this->getInstallProcess(`
`47`	`47`	`packageManager: PackageManager::detect($cwd) ?? $defaultPackageManager,`