litestar-vite-plugin 0.8.3 → 0.10.0

package/README.md

@@ -18,6 +18,8 @@ from pathlib import Path
 from litestar import Controller, get, Litestar
 from litestar.response import Template
 from litestar.status_codes import HTTP_200_OK
+from litestar.template.config import TemplateConfig
+from litestar.contrib.jinja import JinjaTemplateEngine
 from litestar_vite import ViteConfig, VitePlugin
 
 class WebController(Controller):
@@ -29,9 +31,9 @@ class WebController(Controller):
     async def index(self) -> Template:
         return Template(template_name="index.html.j2")
 
-
-vite = VitePlugin(config=ViteConfig(template_dir='templates/'))
-app = Litestar(plugins=[vite], route_handlers=[WebController])
+template_config = TemplateConfig(engine=JinjaTemplateEngine(directory='templates/'))
+vite = VitePlugin(config=ViteConfig())
+app = Litestar(plugins=[vite], template_config=template_config, route_handlers=[WebController])
 
 ```
 

package/dist/js/index.d.ts

@@ -52,6 +52,12 @@ interface PluginConfig {
      * @default null
      */
     detectTls?: string | boolean | null;
+    /**
+     * Automatically detect the index.html file.
+     *
+     * @default true
+     */
+    autoDetectIndex?: boolean;
     /**
      * Transform the code while serving.
      */

package/dist/js/index.js

@@ -5,7 +5,7 @@ import colors from "picocolors";
 import { loadEnv } from "vite";
 import fullReload from "vite-plugin-full-reload";
 let exitHandlersBound = false;
-const refreshPaths = ["**/*.py", "**/*.j2", "**/*.html.j2", "**/*.html", "**/assets/**/*"];
+const refreshPaths = ["src/**", "resources/**", "assets/**"].filter((path2) => fs.existsSync(path2.replace(/\*\*$/, "")));
 function litestar(config) {
   const pluginConfig = resolvePluginConfig(config);
   return [resolveLitestarPlugin(pluginConfig), ...resolveFullReloadConfig(pluginConfig)];
@@ -83,9 +83,25 @@ function resolveLitestarPlugin(pluginConfig) {
       }
       return void 0;
     },
-    configureServer(server) {
+    async configureServer(server) {
       const envDir = resolvedConfig.envDir || process.cwd();
       const appUrl = loadEnv(resolvedConfig.mode, envDir, "APP_URL").APP_URL ?? "undefined";
+      const shouldServeIndex = () => {
+        if (!pluginConfig.autoDetectIndex) return false;
+        const possiblePaths = [
+          path.join(server.config.root, "index.html"),
+          path.join(server.config.root, pluginConfig.resourceDirectory, "index.html"),
+          path.join(server.config.root, "public", "index.html")
+        ];
+        for (const indexPath of possiblePaths) {
+          try {
+            fs.accessSync(indexPath);
+            return true;
+          } catch {
+          }
+        }
+        return false;
+      };
       server.httpServer?.once("listening", () => {
         const address = server.httpServer?.address();
         const isAddressInfo = (x) => typeof x === "object";
@@ -93,11 +109,20 @@ function resolveLitestarPlugin(pluginConfig) {
           viteDevServerUrl = userConfig.server?.origin ? userConfig.server.origin : resolveDevServerUrl(address, server.config, userConfig);
           fs.mkdirSync(path.dirname(pluginConfig.hotFile), { recursive: true });
           fs.writeFileSync(pluginConfig.hotFile, viteDevServerUrl);
+          const hasIndex = shouldServeIndex();
           setTimeout(() => {
             server.config.logger.info(`
   ${colors.red(`${colors.bold("LITESTAR")} ${litestarVersion()}`)}  ${colors.dim("plugin")} ${colors.bold(`v${pluginVersion()}`)}`);
             server.config.logger.info("");
-            server.config.logger.info(`  ${colors.green("\u279C")}  ${colors.bold("APP_URL")}: ${colors.cyan(appUrl.replace(/:(\d+)/, (_, port) => `:${colors.bold(port)}`))}`);
+            if (hasIndex) {
+              server.config.logger.info(`  ${colors.green("\u279C")}  ${colors.bold("Serve Index")}: Serving application index with Vite`);
+              server.config.logger.info(`  ${colors.green("\u279C")}  ${colors.bold("DEV URL")}: ${colors.cyan(viteDevServerUrl)}`);
+              server.config.logger.info(`  ${colors.green("\u279C")}  ${colors.bold("APP_URL")}: ${colors.cyan(appUrl.replace(/:(\d+)/, (_, port) => `:${colors.bold(port)}`))}`);
+            } else {
+              server.config.logger.info(`  ${colors.green("\u279C")}  ${colors.bold("Serve Index")}: Serving Litestar index with Vite`);
+              server.config.logger.info(`  ${colors.green("\u279C")}  ${colors.bold("DEV URL")}: ${colors.cyan(viteDevServerUrl)}`);
+              server.config.logger.info(`  ${colors.green("\u279C")}  ${colors.bold("APP_URL")}: ${colors.cyan(appUrl.replace(/:(\d+)/, (_, port) => `:${colors.bold(port)}`))}`);
+            }
           }, 100);
         }
       });
@@ -114,7 +139,7 @@ function resolveLitestarPlugin(pluginConfig) {
         exitHandlersBound = true;
       }
       return () => server.middlewares.use((req, res, next) => {
-        if (req.url === "/index.html") {
+        if (!shouldServeIndex() && req.url === "/index.html") {
           res.statusCode = 404;
           res.end(
             fs.readFileSync(path.join(dirname(), "dev-server-index.html")).toString().replace(/{{ APP_URL }}/g, appUrl)
@@ -187,6 +212,7 @@ function resolvePluginConfig(config) {
     refresh: resolvedConfig.refresh ?? false,
     hotFile: resolvedConfig.hotFile ?? path.join(resolvedConfig.bundleDirectory ?? "public", "hot"),
     detectTls: resolvedConfig.detectTls ?? false,
+    autoDetectIndex: resolvedConfig.autoDetectIndex ?? true,
     transformOnServe: resolvedConfig.transformOnServe ?? ((code) => code)
   };
 }

package/dist/js/inertia-helpers/index.js

@@ -105,8 +105,9 @@ export function isRoute(url, routeName) {
         const regexPattern = routePattern.replace(/\//g, "\\/").replace(/\{([^}]+):([^}]+)\}/g, (match, paramName, paramType) => {
             switch (paramType) {
                 case "str":
-                case "path":
                     return "([^/]+)";
+                case "path":
+                    return "(.*)";
                 case "uuid":
                     return "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}";
                 default:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "litestar-vite-plugin",
-  "version": "0.8.3",
+  "version": "0.10.0",
   "type": "module",
   "description": "Litestar plugin for Vite.",
   "keywords": ["litestar", "vite", "vite-plugin"],
@@ -42,13 +42,13 @@
     "happy-dom": "^15.11.7",
     "typescript": "^5.7.2",
     "vite": "^6.0.1",
-    "vitest": "^2.1.6"
+    "vitest": "^2.1.8"
   },
   "peerDependencies": {
-    "vite": ">=5.0.0"
+    "vite": "^5.0.0 || ^6.0.0"
   },
   "engines": {
-    "node": "^18.0.0 || >=20.0.0"
+    "node": "^18.0.0 || ^20.0.0 || >=22.0.0"
   },
   "dependencies": {
     "picocolors": "^1.1.1",