litestar-vite-plugin 0.1.4 → 0.1.7

package/README.md

@@ -1,3 +1,15 @@
 # Litestar Vite Plugin
 
-Code Adapted from Laravel's Vite Integration
+**Notice** This is experimental software
+
+## What is this?
+
+This is a library for Litestar and Vite that makes integration between the the two easier.  
+
+For details on usage, use the `litestar-vite` [plugin](https://github.com/cofin/litestar-vite)
+
+## Credit
+
+The team at Laravel have done an incredible job at making it easier to use common JS/TS frameworks with the framework.
+
+This plugin is more than a little inspired by the worker here [Laravel's Vite Integration](https://github.com/laravel/vite-plugin)

package/dist/index.cjs

@@ -40,6 +40,7 @@ const refreshPaths = [
   "**/*.py",
   "**/*.j2",
   "**/*.html.j2",
+  "**/*.html",
   "**/assets/**/*"
 ];
 function litestar(config) {
@@ -63,7 +64,7 @@ function resolveLitestarPlugin(pluginConfig) {
       userConfig = config;
       const ssr = !!userConfig.build?.ssr;
       const env = (0, import_vite.loadEnv)(mode, userConfig.envDir || process.cwd(), "");
-      const assetUrl = env.ASSET_URL || pluginConfig.assetUrl;
+      const assetUrl = env.LITESTAR_ASSET_URL || pluginConfig.assetUrl;
       const serverConfig = command === "serve" ? resolveDevelopmentEnvironmentServerConfig(
         pluginConfig.detectTls
       ) ?? resolveEnvironmentServerConfig(env) : void 0;
@@ -81,7 +82,7 @@ function resolveLitestarPlugin(pluginConfig) {
         },
         server: {
           origin: userConfig.server?.origin ?? "__litestar_vite_placeholder__",
-          ...process.env.LITESTAR_VITE_IN_CONTAINER ? {
+          ...process.env.LITESTAR_VITE_ALLOW_REMOTE ? {
             host: userConfig.server?.host ?? "0.0.0.0",
             port: userConfig.server?.port ?? (env.VITE_PORT ? parseInt(env.VITE_PORT) : 5173),
             strictPort: userConfig.server?.strictPort ?? true
@@ -233,12 +234,6 @@ function resolvePluginConfig(config) {
       'litestar-vite-plugin: missing configuration for "input".'
     );
   }
-  if (typeof config.rootDirectory === "undefined") {
-    config.rootDirectory = "";
-  }
-  if (typeof config.rootDirectory === "string") {
-    config.rootDirectory = config.rootDirectory.trim().replace(/^\/+/, "");
-  }
   if (typeof config.resourceDirectory === "string") {
     config.resourceDirectory = config.resourceDirectory.trim().replace(/^\/+/, "");
     if (config.resourceDirectory === "") {
@@ -255,11 +250,11 @@ function resolvePluginConfig(config) {
       );
     }
   }
-  if (typeof config.buildDirectory === "string") {
-    config.buildDirectory = config.buildDirectory.trim().replace(/^\/+/, "").replace(/\/+$/, "");
-    if (config.buildDirectory === "") {
+  if (typeof config.bundleDirectory === "string") {
+    config.bundleDirectory = config.bundleDirectory.trim().replace(/^\/+/, "").replace(/\/+$/, "");
+    if (config.bundleDirectory === "") {
       throw new Error(
-        "litestar-vite-plugin: buildDirectory must be a subdirectory. E.g. 'public'."
+        "litestar-vite-plugin: bundleDirectory must be a subdirectory. E.g. 'public'."
       );
     }
   }
@@ -272,10 +267,9 @@ function resolvePluginConfig(config) {
   return {
     input: config.input,
     assetUrl: config.assetUrl || (config.assetUrl ?? "static"),
-    rootDirectory: config.rootDirectory ?? void 0,
-    resourceDirectory: config.resourceDirectory ?? "",
-    assetDirectory: config.assetDirectory ?? "",
-    buildDirectory: config.buildDirectory || (config.buildDirectory ?? "public"),
+    resourceDirectory: config.resourceDirectory ?? "/resources/",
+    assetDirectory: config.assetDirectory ?? "assets",
+    bundleDirectory: config.bundleDirectory || (config.bundleDirectory ?? "public"),
     ssr: config.ssr ?? config.input,
     ssrOutputDirectory: config.ssrOutputDirectory ?? "bootstrap/ssr",
     refresh: config.refresh ?? false,
@@ -297,7 +291,7 @@ function resolveOutDir(config, ssr) {
   if (ssr) {
     return config.ssrOutputDirectory;
   }
-  return import_path.default.join(config.buildDirectory);
+  return import_path.default.join(config.bundleDirectory);
 }
 function resolveFullReloadConfig({
   refresh: config
@@ -327,7 +321,7 @@ function resolveDevServerUrl(address, config, userConfig) {
   const protocol = clientProtocol ?? serverProtocol;
   const configHmrHost = typeof config.server.hmr === "object" ? config.server.hmr.host : null;
   const configHost = typeof config.server.host === "string" ? config.server.host : null;
-  const remoteHost = process.env.LITESTAR_VITE_IN_CONTAINER && !userConfig.server?.host ? "localhost" : null;
+  const remoteHost = process.env.LITESTAR_VITE_ALLOW_REMOTE && !userConfig.server?.host ? "localhost" : null;
   const serverAddress = isIpv6(address) ? `[${address.address}]` : address.address;
   const host = configHmrHost ?? remoteHost ?? configHost ?? serverAddress;
   const configHmrClientPort = typeof config.server.hmr === "object" ? config.server.hmr.clientPort : null;

package/dist/index.d.ts

@@ -12,17 +12,11 @@ interface PluginConfig {
      */
     assetUrl?: string;
     /**
-     * The base directory for all Vite source
-     *
-     * @default undefined
-     */
-    rootDirectory?: string | undefined;
-    /**
-     * The public directory where all compiled assets should be written.
+     * The public directory where all compiled/bundled assets should be written.
      *
      * @default 'public'
      */
-    buildDirectory?: string;
+    bundleDirectory?: string;
     /**
      * The directory where all typescript/javascript source are written.  This is used as the default "@" alias is pointed.
      *
@@ -38,7 +32,7 @@ interface PluginConfig {
     /**
      * The path to the "hot" file.
      *
-     * @default `${assetDirectory}/hot`
+     * @default `${bundleDirectory}/hot`
      */
     hotFile?: string;
     /**
@@ -48,7 +42,7 @@ interface PluginConfig {
     /**
      * The directory where the SSR bundle should be written.
      *
-     * @default '${assetDirectory}/bootstrap/ssr'
+     * @default '${bundleDirectory}/bootstrap/ssr'
      */
     ssrOutputDirectory?: string;
     /**

package/dist/index.mjs

@@ -11,6 +11,7 @@ const refreshPaths = [
   "**/*.py",
   "**/*.j2",
   "**/*.html.j2",
+  "**/*.html",
   "**/assets/**/*"
 ];
 function litestar(config) {
@@ -34,7 +35,7 @@ function resolveLitestarPlugin(pluginConfig) {
       userConfig = config;
       const ssr = !!userConfig.build?.ssr;
       const env = loadEnv(mode, userConfig.envDir || process.cwd(), "");
-      const assetUrl = env.ASSET_URL || pluginConfig.assetUrl;
+      const assetUrl = env.LITESTAR_ASSET_URL || pluginConfig.assetUrl;
       const serverConfig = command === "serve" ? resolveDevelopmentEnvironmentServerConfig(
         pluginConfig.detectTls
       ) ?? resolveEnvironmentServerConfig(env) : void 0;
@@ -52,7 +53,7 @@ function resolveLitestarPlugin(pluginConfig) {
         },
         server: {
           origin: userConfig.server?.origin ?? "__litestar_vite_placeholder__",
-          ...process.env.LITESTAR_VITE_IN_CONTAINER ? {
+          ...process.env.LITESTAR_VITE_ALLOW_REMOTE ? {
             host: userConfig.server?.host ?? "0.0.0.0",
             port: userConfig.server?.port ?? (env.VITE_PORT ? parseInt(env.VITE_PORT) : 5173),
             strictPort: userConfig.server?.strictPort ?? true
@@ -204,12 +205,6 @@ function resolvePluginConfig(config) {
       'litestar-vite-plugin: missing configuration for "input".'
     );
   }
-  if (typeof config.rootDirectory === "undefined") {
-    config.rootDirectory = "";
-  }
-  if (typeof config.rootDirectory === "string") {
-    config.rootDirectory = config.rootDirectory.trim().replace(/^\/+/, "");
-  }
   if (typeof config.resourceDirectory === "string") {
     config.resourceDirectory = config.resourceDirectory.trim().replace(/^\/+/, "");
     if (config.resourceDirectory === "") {
@@ -226,11 +221,11 @@ function resolvePluginConfig(config) {
       );
     }
   }
-  if (typeof config.buildDirectory === "string") {
-    config.buildDirectory = config.buildDirectory.trim().replace(/^\/+/, "").replace(/\/+$/, "");
-    if (config.buildDirectory === "") {
+  if (typeof config.bundleDirectory === "string") {
+    config.bundleDirectory = config.bundleDirectory.trim().replace(/^\/+/, "").replace(/\/+$/, "");
+    if (config.bundleDirectory === "") {
       throw new Error(
-        "litestar-vite-plugin: buildDirectory must be a subdirectory. E.g. 'public'."
+        "litestar-vite-plugin: bundleDirectory must be a subdirectory. E.g. 'public'."
       );
     }
   }
@@ -243,10 +238,9 @@ function resolvePluginConfig(config) {
   return {
     input: config.input,
     assetUrl: config.assetUrl || (config.assetUrl ?? "static"),
-    rootDirectory: config.rootDirectory ?? void 0,
-    resourceDirectory: config.resourceDirectory ?? "",
-    assetDirectory: config.assetDirectory ?? "",
-    buildDirectory: config.buildDirectory || (config.buildDirectory ?? "public"),
+    resourceDirectory: config.resourceDirectory ?? "/resources/",
+    assetDirectory: config.assetDirectory ?? "assets",
+    bundleDirectory: config.bundleDirectory || (config.bundleDirectory ?? "public"),
     ssr: config.ssr ?? config.input,
     ssrOutputDirectory: config.ssrOutputDirectory ?? "bootstrap/ssr",
     refresh: config.refresh ?? false,
@@ -268,7 +262,7 @@ function resolveOutDir(config, ssr) {
   if (ssr) {
     return config.ssrOutputDirectory;
   }
-  return path.join(config.buildDirectory);
+  return path.join(config.bundleDirectory);
 }
 function resolveFullReloadConfig({
   refresh: config
@@ -298,7 +292,7 @@ function resolveDevServerUrl(address, config, userConfig) {
   const protocol = clientProtocol ?? serverProtocol;
   const configHmrHost = typeof config.server.hmr === "object" ? config.server.hmr.host : null;
   const configHost = typeof config.server.host === "string" ? config.server.host : null;
-  const remoteHost = process.env.LITESTAR_VITE_IN_CONTAINER && !userConfig.server?.host ? "localhost" : null;
+  const remoteHost = process.env.LITESTAR_VITE_ALLOW_REMOTE && !userConfig.server?.host ? "localhost" : null;
   const serverAddress = isIpv6(address) ? `[${address.address}]` : address.address;
   const host = configHmrHost ?? remoteHost ?? configHost ?? serverAddress;
   const configHmrClientPort = typeof config.server.hmr === "object" ? config.server.hmr.clientPort : null;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "litestar-vite-plugin",
-    "version": "0.1.4",
+    "version": "0.1.7",
     "description": "Litestar plugin for Vite.",
     "keywords": [
         "litestar",