litestar-vite 0.13.0__tar.gz → 0.13.1__tar.gz

{litestar_vite-0.13.0 → litestar_vite-0.13.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: litestar-vite
-Version: 0.13.0
+Version: 0.13.1
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j
@@ -19,16 +19,16 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Database
 Classifier: Topic :: Database :: Database Engines/Servers
 Classifier: Topic :: Software Development
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: litestar[jinja]>=2.7.0
 Provides-Extra: nodeenv
 Requires-Dist: nodeenv; extra == 'nodeenv'

{litestar_vite-0.13.0 → litestar_vite-0.13.1}/pyproject.toml

@@ -5,11 +5,11 @@ classifiers = [
   "License :: OSI Approved :: MIT License",
   "Natural Language :: English",
   "Operating System :: OS Independent",
-  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python",
   "Topic :: Software Development",
   "Typing :: Typed",
@@ -24,8 +24,8 @@ keywords = ["litestar", "vite"]
 license = { text = "MIT" }
 name = "litestar-vite"
 readme = "README.md"
-requires-python = ">=3.8"
-version = "0.13.0"
+requires-python = ">=3.9"
+version = "0.13.1"
 
 [project.urls]
 Changelog = "https://cofin.github.io/litestar-vite/latest/changelog"
@@ -83,7 +83,7 @@ test = [
 allow_dirty = true
 commit = true
 commit_args = "--no-verify"
-current_version = "0.13.0"
+current_version = "0.13.1"
 ignore_missing_files = false
 ignore_missing_version = false
 message = "chore(release): bump to v{new_version}"
@@ -262,17 +262,29 @@ lint.ignore = [
   "PLR0913", # too many arguments
   "PT",
   "TD",
+  "ARG002",  # ignore for now; investigate
+  "ARG003",  # ignore for now; investigate
   "PERF203", # ignore for now; investigate
+  "PD011",   # pandas
+  "PLR0912",
   "ISC001",
   "COM812",
+  "CPY001",
+  "PGH003",
+  "FA100",
+  "PLC0415", # import should be at the top of the file
+  "PLR0904", # too many public methods
+  "PLR0914",
+  "PLR0917",
+  "PLC2701", # private import
+  "S704",
+  "S404",
 ]
 lint.select = ["ALL"]
-# Allow unused variables when underscore-prefixed.
-lint.dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 src = ["src/py/litestar_vite", "src/py/tests"]
-target-version = "py38"
+target-version = "py39"
 unsafe-fixes = true
-
+lint.extend-safe-fixes = ["TC"]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"
@@ -311,6 +323,7 @@ max-complexity = 12
   "UP006",
   "SLF001",
   "ERA001",
+
 ]
 "tools/*.py" = [ "PLR0911"]
 
@@ -318,8 +331,10 @@ max-complexity = 12
 known-first-party = ["litestar_vite", "tests"]
 
 [tool.pyright]
-venvPath = "."
 disableBytesTypePromotions = true
+reportPrivateImportUsage = "none"
+reportUnknownVariableType = "none"
+reportUnnecessaryContains = "none"
 exclude = [
   "docs",
   "src/py/tests/unit/test_extensions",
@@ -328,9 +343,8 @@ exclude = [
   "src/py/tests/docker_service_fixtures.py",
 ]
 include = ["src/py/litestar_vite"]
-pythonVersion = "3.8"
+pythonVersion = "3.9"
 strict = ["src/py/litestar_vite/**/*"]
-venv = ".venv"
 
 [tool.mypy]
 disallow_untyped_defs = false
@@ -350,66 +364,3 @@ module = "tests.*"
 [tool.codespell]
 ignore-words-list = "selectin"
 skip = 'uv.lock,examples/inertia/package-lock.json,examples/inertia/public/assets/*.js'
-
-[tool.git-cliff.changelog]
-body = """
-{% if version %}\
-    `Release [v{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} <https://github.com/cofin/litestar-vite/releases/tag/v{{ version | trim_start_matches(pat="v") }}>`_
-    ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-    * `See All commits in v{{ version | trim_start_matches(pat="v") }} <https://github.com/cofin/litestar-vite/commits/v{{ version | trim_start_matches(pat="v") }}>`_
-{% else %}\
-    [unreleased]
-    ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-{% endif %}\
-{% if previous %}\
-    {% if previous.commit_id %}
-        `{{ previous.commit_id | truncate(length=7, end="") }} <https://github.com/cofin/litestar-vite/commit/{{ previous.commit_id }}>`_ ... \
-            `{{ commit_id | truncate(length=7, end="") }} <https://github.com/cofin/litestar-vite/commit/{{ commit_id }}>`_ \
-            | `See diff for {{ version | trim_start_matches(pat="v") }} <https://github.com/cofin/litestar-vite/compare/{{ previous.commit_id }}...{{ commit_id }}>`_
-    {% endif %}\
-{% endif %}\
-{% for group, commits in commits | group_by(attribute="group") %}
-    {{ group | upper_first }}
-    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-    {% for commit in commits %}
-        * (`{{ commit.id | truncate(length=7, end="") }} <https://github.com/cofin/litestar-vite/commit/{{ commit.id }}>`_) {% if commit.breaking %}[**breaking**] {% endif %} - {{ commit.message | upper_first }} ({{ commit.author.name  }})\
-          {% for footer in commit.footers -%}
-            , {{ footer.token }}{{ footer.separator }}{{ footer.value }}\
-          {% endfor %}\
-    {% endfor %}
-{% endfor %}\n
-"""
-footer = """
-Litestar vite Changelog
-"""
-header = """
-=========
-Changelog
-=========\n
-All commits to this project will be documented in this file.\n
-"""
-trim = true
-
-[tool.git-cliff.git]
-commit_parsers = [
-  { message = "^feat", group = "Features" },
-  { message = "^fix", group = "Bug Fixes" },
-  { message = "^doc", group = "Documentation" },
-  { message = "^perf", group = "Performance" },
-  { message = "^refactor", group = "Refactor" },
-  { message = "^style", group = "Styling" },
-  { message = "^test", group = "Testing" },
-  { message = "^chore\\(release\\): prepare for", skip = true },
-  { message = "^chore", group = "Miscellaneous Tasks" },
-  { body = ".*security", group = "Security" },
-]
-conventional_commits = true
-filter_commits = false
-filter_unconventional = true
-ignore_tags = ""
-protect_breaking_commits = false
-skip_tags = "v0.1.0-beta.1"
-sort_commits = "oldest"
-split_commits = false
-tag_pattern = "v[0-9]*"
-topo_order = false

{litestar_vite-0.13.0 → litestar_vite-0.13.1}/src/js/src/index.ts

@@ -3,7 +3,7 @@ import type { AddressInfo } from "node:net"
 import path from "node:path"
 import { fileURLToPath } from "node:url"
 import colors from "picocolors"
-import { type ConfigEnv, type Plugin, type PluginOption, type ResolvedConfig, type SSROptions, type UserConfig, loadEnv } from "vite"
+import { type ConfigEnv, type Plugin, type PluginOption, type ResolvedConfig, type SSROptions, type UserConfig, type ViteDevServer, loadEnv } from "vite"
 import fullReload, { type Config as FullReloadConfig } from "vite-plugin-full-reload"
 
 interface PluginConfig {
@@ -101,6 +101,38 @@ export default function litestar(config: string | string[] | PluginConfig): [Lit
   return [resolveLitestarPlugin(pluginConfig), ...(resolveFullReloadConfig(pluginConfig) as Plugin[])]
 }
 
+/**
+ * Resolve the index.html path to use for the Vite server.
+ */
+async function findIndexHtmlPath(server: ViteDevServer, pluginConfig: Required<PluginConfig>): Promise<string | null> {
+  if (!pluginConfig.autoDetectIndex) {
+    console.log("Auto-detection disabled.") // Debug log
+    return null
+  }
+
+  // Use server.config.root which is the resolved root directory
+  const root = server.config.root
+  const possiblePaths = [
+    path.join(root, "index.html"),
+    path.join(root, pluginConfig.resourceDirectory.replace(/^\//, ""), "index.html"), // Ensure resourceDirectory path is relative to root
+    path.join(root, "public", "index.html"), // Check public even if publicDir is false, might exist
+  ]
+  // console.log("Checking paths:", possiblePaths); // Debug log
+
+  for (const indexPath of possiblePaths) {
+    try {
+      // Use async access check
+      await fs.promises.access(indexPath)
+      // console.log("Found index.html at:", indexPath); // Debug log
+      return indexPath
+    } catch {
+      // File doesn't exist at this path, continue checking
+    }
+  }
+  // console.log("index.html not found in checked paths."); // Debug log
+  return null
+}
+
 /**
  * Resolve the Litestar Plugin configuration.
  */
@@ -108,9 +140,8 @@ function resolveLitestarPlugin(pluginConfig: Required<PluginConfig>): LitestarPl
   let viteDevServerUrl: DevServerUrl
   let resolvedConfig: ResolvedConfig
   let userConfig: UserConfig
-
   const defaultAliases: Record<string, string> = {
-    "@": pluginConfig.resourceDirectory || "/resources/",
+    "@": `/${pluginConfig.resourceDirectory.replace(/^\/+/, "").replace(/\/+$/, "")}/`,
   }
 
   return {
@@ -178,14 +209,30 @@ function resolveLitestarPlugin(pluginConfig: Required<PluginConfig>): LitestarPl
         ssr: {
           noExternal: noExternalInertiaHelpers(userConfig),
         },
+        // Explicitly set appType if you know you're serving an SPA index.html
+        // appType: 'spa', // Try adding this - might simplify things if appropriate
       }
     },
     configResolved(config) {
       resolvedConfig = config
+      // Ensure base ends with / for dev server if not empty
+      if (resolvedConfig.command === "serve" && resolvedConfig.base && !resolvedConfig.base.endsWith("/")) {
+        resolvedConfig = {
+          ...resolvedConfig,
+          base: `${resolvedConfig.base}/`,
+        }
+      }
+      // Debug log resolved config
+      // console.log("Resolved Vite Config:", resolvedConfig);
     },
-    transform(code: string): string | undefined {
-      if (resolvedConfig.command === "serve") {
+    transform(code: string, id: string): string | undefined {
+      // Added 'id' for context
+      // Avoid transforming unrelated files during serve if placeholder isn't present
+      if (resolvedConfig.command === "serve" && code.includes("__litestar_vite_placeholder__")) {
+        // Debug log transformation
+        // console.log(`Transforming ${id} with dev server URL: ${viteDevServerUrl}`);
         const transformedCode = code.replace(/__litestar_vite_placeholder__/g, viteDevServerUrl)
+        // Apply user transform *only* if the placeholder was found and replaced
         return pluginConfig.transformOnServe(transformedCode, viteDevServerUrl)
       }
       return undefined
@@ -194,25 +241,8 @@ function resolveLitestarPlugin(pluginConfig: Required<PluginConfig>): LitestarPl
       const envDir = resolvedConfig.envDir || process.cwd()
       const appUrl = loadEnv(resolvedConfig.mode, envDir, "APP_URL").APP_URL ?? "undefined"
 
-      // Check if we should serve SPA directly
-      const shouldServeIndex = () => {
-        if (!pluginConfig.autoDetectIndex) return false
-
-        // Check various common locations for index.html
-        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
-      }
+      // Find index.html path *once* when server starts for logging purposes
+      const initialIndexPath = await findIndexHtmlPath(server, pluginConfig)
 
       server.httpServer?.once("listening", () => {
         const address = server.httpServer?.address()
@@ -223,53 +253,91 @@ function resolveLitestarPlugin(pluginConfig: Required<PluginConfig>): LitestarPl
           fs.mkdirSync(path.dirname(pluginConfig.hotFile), { recursive: true })
           fs.writeFileSync(pluginConfig.hotFile, viteDevServerUrl)
 
-          const hasIndex = shouldServeIndex()
-
           setTimeout(() => {
-            server.config.logger.info(`\n  ${colors.red(`${colors.bold("LITESTAR")} ${litestarVersion()}`)}  ${colors.dim("plugin")} ${colors.bold(`v${pluginVersion()}`)}`)
-            server.config.logger.info("")
-            if (hasIndex) {
-              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("Serve Index")}: Serving application index with Vite`)
-              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("DEV URL")}: ${colors.cyan(viteDevServerUrl)}`)
-              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("APP_URL")}: ${colors.cyan(appUrl.replace(/:(\d+)/, (_, port) => `:${colors.bold(port)}`))}`)
+            // Use resolvedConfig.logger for consistency
+            resolvedConfig.logger.info(`\n  ${colors.red(`${colors.bold("LITESTAR")} ${litestarVersion()}`)}  ${colors.dim("plugin")} ${colors.bold(`v${pluginVersion()}`)}`)
+            resolvedConfig.logger.info("")
+            if (initialIndexPath) {
+              resolvedConfig.logger.info(
+                `  ${colors.green("➜")}  ${colors.bold("Index Mode")}: SPA (Serving ${colors.cyan(path.relative(server.config.root, initialIndexPath))} from root)`,
+              )
             } else {
-              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("Serve Index")}: Serving Litestar index with Vite`)
-              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("DEV URL")}: ${colors.cyan(viteDevServerUrl)}`)
-              server.config.logger.info(`  ${colors.green("➜")}  ${colors.bold("APP_URL")}: ${colors.cyan(appUrl.replace(/:(\d+)/, (_, port) => `:${colors.bold(port)}`))}`)
+              resolvedConfig.logger.info(`  ${colors.green("➜")}  ${colors.bold("Index Mode")}: Litestar (Plugin will serve placeholder for /index.html)`)
             }
+            resolvedConfig.logger.info(`  ${colors.green("➜")}  ${colors.bold("Dev Server")}: ${colors.cyan(viteDevServerUrl)}`)
+            resolvedConfig.logger.info(`  ${colors.green("➜")}  ${colors.bold("App URL")}:    ${colors.cyan(appUrl.replace(/:(\d+)/, (_, port) => `:${colors.bold(port)}`))}`)
+            resolvedConfig.logger.info(`  ${colors.green("➜")}  ${colors.bold("Assets Base")}: ${colors.cyan(resolvedConfig.base)}`) // Log the base path being used
           }, 100)
         }
       })
+
+      // Clean up hot file
       if (!exitHandlersBound) {
         const clean = () => {
-          if (fs.existsSync(pluginConfig.hotFile)) {
+          if (pluginConfig.hotFile && fs.existsSync(pluginConfig.hotFile)) {
+            // Check hotFile exists
             fs.rmSync(pluginConfig.hotFile)
           }
         }
-
         process.on("exit", clean)
         process.on("SIGINT", () => process.exit())
         process.on("SIGTERM", () => process.exit())
         process.on("SIGHUP", () => process.exit())
-
         exitHandlersBound = true
       }
 
-      return () =>
-        server.middlewares.use((req, res, next) => {
-          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),
-            )
+      // *** MODIFIED MIDDLEWARE ***
+      return () => {
+        // Run middleware early to intercept before Vite's base/HTML handlers
+        server.middlewares.use(async (req, res, next) => {
+          const indexPath = await findIndexHtmlPath(server, pluginConfig)
+
+          // Check if index.html exists AND the request is for the root or /index.html
+          if (indexPath && (req.url === "/" || req.url === "/index.html")) {
+            try {
+              const htmlContent = await fs.promises.readFile(indexPath, "utf-8")
+              // Transform the HTML using Vite's pipeline
+              const transformedHtml = await server.transformIndexHtml(
+                "/", // Use '/' as the URL for transformation context to ensure scripts are injected correctly relative to root
+                htmlContent,
+                req.originalUrl,
+              )
+              res.statusCode = 200
+              res.setHeader("Content-Type", "text/html")
+              res.end(transformedHtml)
+              // Request handled, stop further processing
+              return
+            } catch (e) {
+              // Log the error and pass it to Vite's error handler
+              resolvedConfig.logger.error(`Error serving index.html from ${indexPath}: ${e instanceof Error ? e.message : e}`)
+              next(e)
+              return
+            }
           }
 
+          // Original logic: If index.html should NOT be served automatically,
+          // AND the request is specifically for /index.html, serve the placeholder.
+          // Requests for '/' will likely be handled by Litestar in this case.
+          if (!indexPath && req.url === "/index.html") {
+            try {
+              const placeholderPath = path.join(dirname(), "dev-server-index.html")
+              const placeholderContent = await fs.promises.readFile(placeholderPath, "utf-8")
+              res.statusCode = 200 // Serve placeholder with 200 OK, or 404 if preferred
+              res.setHeader("Content-Type", "text/html")
+              res.end(placeholderContent.replace(/{{ APP_URL }}/g, appUrl))
+            } catch (e) {
+              resolvedConfig.logger.error(`Error serving placeholder index.html: ${e instanceof Error ? e.message : e}`)
+              res.statusCode = 404
+              res.end("Not Found (Error loading placeholder)")
+            }
+            // Request handled (or error), stop further processing
+            return
+          }
+
+          // If none of the above conditions matched, pass the request to the next middleware (Vite's default handlers)
           next()
         })
+      }
     },
   }
 }
@@ -327,7 +395,7 @@ function resolvePluginConfig(config: string | string[] | PluginConfig): Required
     throw new Error('litestar-vite-plugin: missing configuration for "input".')
   }
   if (typeof resolvedConfig.resourceDirectory === "string") {
-    resolvedConfig.resourceDirectory = resolvedConfig.resourceDirectory.trim().replace(/^\/+/, "")
+    resolvedConfig.resourceDirectory = resolvedConfig.resourceDirectory.trim().replace(/^\/+/, "").replace(/\/+$/, "")
 
     if (resolvedConfig.resourceDirectory === "") {
       throw new Error("litestar-vite-plugin: resourceDirectory must be a subdirectory. E.g. 'resources'.")
@@ -353,8 +421,8 @@ function resolvePluginConfig(config: string | string[] | PluginConfig): Required
   return {
     input: resolvedConfig.input,
     assetUrl: resolvedConfig.assetUrl ?? "static",
-    resourceDirectory: resolvedConfig.resourceDirectory ?? "/resources/",
-    bundleDirectory: resolvedConfig.bundleDirectory || (resolvedConfig.bundleDirectory ?? "public"),
+    resourceDirectory: resolvedConfig.resourceDirectory ?? "resources",
+    bundleDirectory: resolvedConfig.bundleDirectory ?? "public",
     ssr: resolvedConfig.ssr ?? resolvedConfig.input,
     ssrOutputDirectory: resolvedConfig.ssrOutputDirectory ?? path.join(resolvedConfig.resourceDirectory ?? "resources", "bootstrap/ssr"),
     refresh: resolvedConfig.refresh ?? false,
@@ -369,7 +437,12 @@ function resolvePluginConfig(config: string | string[] | PluginConfig): Required
  * Resolve the Vite base option from the configuration.
  */
 function resolveBase(config: Required<PluginConfig>, assetUrl: string): string {
-  return assetUrl + (assetUrl.endsWith("/") ? "" : "/")
+  // In development mode, use the assetUrl directly
+  if (process.env.NODE_ENV === "development") {
+    return assetUrl
+  }
+  // In production, use the full assetUrl
+  return assetUrl.endsWith("/") ? assetUrl : `${assetUrl}/`
 }
 
 /**
@@ -385,13 +458,15 @@ function resolveInput(config: Required<PluginConfig>, ssr: boolean): string | st
 
 /**
  * Resolve the Vite outDir path from the configuration.
+ * Should be relative to the project root for Vite config, Vite resolves it internally.
  */
-function resolveOutDir(config: Required<PluginConfig>, ssr: boolean): string | undefined {
+function resolveOutDir(config: Required<PluginConfig>, ssr: boolean): string {
   if (ssr) {
-    return config.ssrOutputDirectory
+    // Return path relative to root
+    return config.ssrOutputDirectory.replace(/^\/+/, "").replace(/\/+$/, "")
   }
-
-  return path.join(config.bundleDirectory)
+  // Return path relative to root
+  return config.bundleDirectory.replace(/^\/+/, "").replace(/\/+$/, "")
 }
 
 function resolveFullReloadConfig({ refresh: config }: Required<PluginConfig>): PluginOption[] {