PyPI - litestar-vite - Versions diffs - 0.13.2__tar.gz → 0.14.0__tar.gz - Mend

litestar-vite 0.13.2tar.gz → 0.14.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of litestar-vite might be problematic. Click here for more details.

Files changed (88) hide show

{litestar_vite-0.13.2 → litestar_vite-0.14.0}/.gitignore RENAMED Viewed

@@ -172,3 +172,10 @@ node_modules
 *.swo
 *.swp
 .venv
+CLAUDE.md
+GEMINI.md
+# Example build outputs and package-lock files
+examples/*/public/
+examples/*/package-lock.json
+examples/*/frontend/package-lock.json

{litestar_vite-0.13.2 → litestar_vite-0.14.0}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: litestar-vite
-Version: 0.13.2
+Version: 0.14.0
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j
@@ -29,7 +29,9 @@ Classifier: Topic :: Database :: Database Engines/Servers
 Classifier: Topic :: Software Development
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
-Requires-Dist: litestar[jinja]>=2.7.0
+Requires-Dist: litestar>=2.7.0
+Provides-Extra: jinja
+Requires-Dist: jinja2; extra == 'jinja'
 Provides-Extra: nodeenv
 Requires-Dist: nodeenv; extra == 'nodeenv'
 Description-Content-Type: text/markdown
@@ -73,7 +75,7 @@ app = Litestar(plugins=[vite], template_config=template_config, route_handlers=[
 ```
-Create a template to serve the application in `./templates/index.html.h2`:
+Create a template to serve the application in `./templates/index.html.j2`:
 ```html
 <!DOCTYPE html>

{litestar_vite-0.13.2 → litestar_vite-0.14.0}/README.md RENAMED Viewed

@@ -37,7 +37,7 @@ app = Litestar(plugins=[vite], template_config=template_config, route_handlers=[
 ```
-Create a template to serve the application in `./templates/index.html.h2`:
+Create a template to serve the application in `./templates/index.html.j2`:
 ```html
 <!DOCTYPE html>

{litestar_vite-0.13.2 → litestar_vite-0.14.0}/pyproject.toml RENAMED Viewed

@@ -18,14 +18,14 @@ classifiers = [
   "Topic :: Database",
   "Topic :: Database :: Database Engines/Servers",
 ]
-dependencies = ["litestar[jinja]>=2.7.0"]
+dependencies = ["litestar>=2.7.0"]
 description = "Vite plugin for Litestar"
 keywords = ["litestar", "vite"]
 license = { text = "MIT" }
 name = "litestar-vite"
 readme = "README.md"
 requires-python = ">=3.9"
-version = "0.13.2"
+version = "0.14.0"
 [project.urls]
 Changelog = "https://cofin.github.io/litestar-vite/latest/changelog"
@@ -36,6 +36,7 @@ Issue = "https://github.com/cofin/litestar-vite/issues/"
 Source = "https://github.com/cofin/litestar-vite"
 [project.optional-dependencies]
+jinja = [ "jinja2"]
 nodeenv = ["nodeenv"]
 [build-system]
@@ -83,7 +84,7 @@ test = [
 allow_dirty = true
 commit = true
 commit_args = "--no-verify"
-current_version = "0.13.2"
+current_version = "0.14.0"
 ignore_missing_files = false
 ignore_missing_version = false
 message = "chore(release): bump to v{new_version}"

litestar_vite-0.14.0/src/js/tests/vite-compatibility.test.ts ADDED Viewed

@@ -0,0 +1,513 @@
+import { beforeEach, describe, expect, it, vi } from "vitest"
+import litestar from "../src"
+// Mock the fs module for consistent testing
+vi.mock("fs", async () => {
+  const actual = await vi.importActual<typeof import("fs")>("fs")
+  return {
+    promises: actual.promises,
+    default: {
+      ...actual,
+      existsSync: (path: string) => ["resources/", "assets/", "src/"].includes(path) || actual.existsSync(path),
+      readFileSync: actual.readFileSync,
+      mkdirSync: actual.mkdirSync,
+      writeFileSync: actual.writeFileSync,
+      rmSync: actual.rmSync,
+    },
+  }
+})
+// Mock process.env for testing
+const originalEnv = process.env
+beforeEach(() => {
+  vi.resetModules()
+  process.env = { ...originalEnv }
+  vi.clearAllMocks()
+})
+describe("Vite 7.0 Compatibility", () => {
+  describe("Plugin Configuration", () => {
+    it("builds successfully with Vite 7.0 configuration format", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      // Test Vite 7.0 style configuration
+      const config = plugin.config({}, { command: "build", mode: "production" })
+      expect(config.build?.rollupOptions?.input).toBe("resources/js/app.ts")
+      expect(config.build?.manifest).toBe("manifest.json")
+    })
+    it("handles Vite 7.0 development server configuration", () => {
+      process.env.VITE_ALLOW_REMOTE = "1"
+      process.env.VITE_PORT = "5173"
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config({}, { command: "serve", mode: "development" })
+      expect(config.server?.host).toBe("0.0.0.0")
+      expect(config.server?.port).toBe(5173)
+      expect(config.server?.strictPort).toBe(true)
+    })
+    it("supports Vite 7.0 SSR configuration", () => {
+      const plugin = litestar({
+        input: "resources/js/app.ts",
+        ssr: "resources/js/ssr.ts",
+      })[0]
+      const ssrConfig = plugin.config({ build: { ssr: true } }, { command: "build", mode: "production" })
+      expect(ssrConfig.build?.rollupOptions?.input).toBe("resources/js/ssr.ts")
+      expect(ssrConfig.build?.manifest).toBe(false)
+    })
+    it("handles Vite 7.0 build optimizations", () => {
+      const plugin = litestar({
+        input: "resources/js/app.ts",
+        bundleDirectory: "dist",
+      })[0]
+      const config = plugin.config({}, { command: "build", mode: "production" })
+      expect(config.build?.outDir).toBe("dist")
+      expect(config.base).toBe("static/")
+    })
+  })
+  describe("Asset URL Handling", () => {
+    it("handles Vite 7.0 asset URL generation", () => {
+      const plugin = litestar({
+        input: "resources/js/app.ts",
+        assetUrl: "/vite-assets/",
+      })[0]
+      const config = plugin.config({}, { command: "build", mode: "production" })
+      expect(config.base).toBe("/vite-assets/")
+    })
+    it("supports CDN asset URLs in Vite 7.0", () => {
+      process.env.ASSET_URL = "https://cdn.example.com/assets/"
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config({}, { command: "build", mode: "production" })
+      expect(config.base).toBe("https://cdn.example.com/assets/")
+    })
+    it("handles environment-specific asset URLs", () => {
+      process.env.ASSET_URL = "https://staging-cdn.example.com/"
+      const plugin = litestar({
+        input: "resources/js/app.ts",
+        assetUrl: "/local-assets/",
+      })[0]
+      const prodConfig = plugin.config({}, { command: "build", mode: "production" })
+      const devConfig = plugin.config({}, { command: "serve", mode: "development" })
+      expect(prodConfig.base).toBe("https://staging-cdn.example.com/")
+      expect(devConfig.base).toBe("/local-assets/")
+    })
+  })
+  describe("Build Configuration", () => {
+    it("supports Vite 7.0 build target configuration", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      // Test that plugin preserves user build configuration
+      const userConfig = {
+        build: {
+          target: "es2022",
+          minify: "terser",
+        },
+      }
+      const config = plugin.config(userConfig, { command: "build", mode: "production" })
+      // Plugin should preserve user's build config while adding its own
+      expect(config.build?.rollupOptions?.input).toBe("resources/js/app.ts")
+      expect(config.build?.manifest).toBe("manifest.json")
+    })
+    it("handles Vite 7.0 code splitting configuration", () => {
+      const plugin = litestar(["resources/js/app.ts", "resources/js/admin.ts"])[0]
+      const config = plugin.config({}, { command: "build", mode: "production" })
+      expect(config.build?.rollupOptions?.input).toEqual(["resources/js/app.ts", "resources/js/admin.ts"])
+    })
+    it("supports Vite 7.0 chunk optimization", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config(
+        {
+          build: {
+            rollupOptions: {
+              output: {
+                manualChunks: {
+                  vendor: ["vue", "react"],
+                },
+              },
+            },
+          },
+        },
+        { command: "build", mode: "production" },
+      )
+      // Plugin should set its own configuration without overriding user chunk config
+      expect(config.build?.rollupOptions?.input).toBe("resources/js/app.ts")
+      expect(config.build?.manifest).toBe("manifest.json")
+    })
+  })
+  describe("Development Server Features", () => {
+    it("supports Vite 7.0 HMR configuration", () => {
+      const plugin = litestar({
+        input: "resources/js/app.ts",
+        refresh: true,
+      })
+      expect(plugin.length).toBe(2) // Main plugin + HMR plugin
+      const hmrPlugin = plugin[1]
+      expect(hmrPlugin.__litestar_plugin_config).toEqual({
+        paths: ["src/**", "resources/**", "assets/**"],
+      })
+    })
+    it("handles Vite 7.0 proxy configuration", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config(
+        {
+          server: {
+            proxy: {
+              "/api": "http://localhost:8000",
+            },
+          },
+        },
+        { command: "serve", mode: "development" },
+      )
+      // Plugin only sets server config when specific conditions are met
+      expect(config.server?.origin).toBe("__litestar_vite_placeholder__")
+      expect(config.base).toBe("static")
+    })
+    it("supports Vite 7.0 middleware configuration", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const middlewareFn = vi.fn()
+      const config = plugin.config(
+        {
+          server: {
+            middlewareMode: true,
+          },
+        },
+        { command: "serve", mode: "development" },
+      )
+      // Plugin only sets server config when specific conditions are met
+      expect(config.server?.origin).toBe("__litestar_vite_placeholder__")
+      expect(config.base).toBe("static")
+    })
+  })
+  describe("TypeScript Support", () => {
+    it("handles Vite 7.0 TypeScript configuration", () => {
+      const plugin = litestar("resources/ts/app.ts")[0]
+      const config = plugin.config({}, { command: "build", mode: "production" })
+      expect(config.build?.rollupOptions?.input).toBe("resources/ts/app.ts")
+    })
+    it("supports Vite 7.0 TypeScript path mapping", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config(
+        {
+          resolve: {
+            alias: {
+              "@": "/resources/js",
+              "@components": "/resources/js/components",
+            },
+          },
+        },
+        { command: "build", mode: "development" },
+      )
+      expect(config.resolve?.alias?.["@"]).toBe("/resources/js")
+      expect(config.resolve?.alias?.["@components"]).toBe("/resources/js/components")
+    })
+    it("preserves existing @ alias with Vite 7.0", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config(
+        {
+          resolve: {
+            alias: {
+              "@": "/custom/path",
+            },
+          },
+        },
+        { command: "build", mode: "development" },
+      )
+      expect(config.resolve?.alias?.["@"]).toBe("/custom/path")
+    })
+  })
+  describe("Plugin Integration", () => {
+    it("handles Vite 7.0 plugin API changes", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      // Test that the plugin conforms to Vite 7.0 plugin API
+      expect(plugin.name).toBe("litestar")
+      expect(typeof plugin.config).toBe("function")
+      expect(typeof plugin.configResolved).toBe("function")
+    })
+    it("supports Vite 7.0 plugin composition", () => {
+      const plugins = litestar({
+        input: "resources/js/app.ts",
+        refresh: ["resources/**", "templates/**"],
+      })
+      expect(plugins.length).toBe(2)
+      expect(plugins[0].name).toBe("litestar")
+    })
+    it("handles Vite 7.0 conditional plugin loading", () => {
+      const devPlugins = litestar({
+        input: "resources/js/app.ts",
+        refresh: true,
+      })
+      const prodPlugins = litestar({
+        input: "resources/js/app.ts",
+        refresh: false,
+      })
+      expect(devPlugins.length).toBe(2) // With HMR
+      expect(prodPlugins.length).toBe(1) // Without HMR
+    })
+  })
+  describe("Performance Optimizations", () => {
+    it("supports Vite 7.0 dependency pre-bundling", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config(
+        {
+          optimizeDeps: {
+            include: ["vue", "axios"],
+            exclude: ["@custom/module"],
+          },
+        },
+        { command: "serve", mode: "development" },
+      )
+      // Plugin doesn't override optimizeDeps, test what it actually sets
+      expect(config.base).toBe("static")
+      expect(config.server?.origin).toBe("__litestar_vite_placeholder__")
+    })
+    it("handles Vite 7.0 build caching", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config(
+        {
+          build: {
+            write: true,
+            emptyOutDir: true,
+          },
+        },
+        { command: "build", mode: "production" },
+      )
+      // Plugin sets its own build configuration
+      expect(config.build?.rollupOptions?.input).toBe("resources/js/app.ts")
+      expect(config.build?.manifest).toBe("manifest.json")
+    })
+    it("supports Vite 7.0 tree shaking optimizations", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config(
+        {
+          build: {
+            rollupOptions: {
+              treeshake: {
+                moduleSideEffects: false,
+              },
+            },
+          },
+        },
+        { command: "build", mode: "production" },
+      )
+      // Plugin sets its own build configuration
+      expect(config.build?.rollupOptions?.input).toBe("resources/js/app.ts")
+      expect(config.build?.manifest).toBe("manifest.json")
+      expect(config.base).toBe("static/")
+    })
+  })
+  describe("Error Handling", () => {
+    it("handles Vite 7.0 error overlay configuration", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config(
+        {
+          server: {
+            hmr: {
+              overlay: true,
+            },
+          },
+        },
+        { command: "serve", mode: "development" },
+      )
+      // Plugin only sets server config when specific conditions are met
+      expect(config.server?.origin).toBe("__litestar_vite_placeholder__")
+      expect(config.base).toBe("static")
+    })
+    it("supports Vite 7.0 build error handling", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config(
+        {
+          build: {
+            rollupOptions: {
+              onwarn: (warning, warn) => {
+                // Custom warning handler
+                warn(warning)
+              },
+            },
+          },
+        },
+        { command: "build", mode: "production" },
+      )
+      // Plugin sets its own build configuration
+      expect(config.build?.rollupOptions?.input).toBe("resources/js/app.ts")
+      expect(config.build?.manifest).toBe("manifest.json")
+    })
+  })
+  describe("Environment Support", () => {
+    it("handles Vite 7.0 environment variables", () => {
+      process.env.VITE_API_URL = "https://api.example.com"
+      process.env.VITE_APP_TITLE = "Test App"
+      const plugin = litestar("resources/js/app.ts")[0]
+      const config = plugin.config(
+        {
+          define: {
+            __APP_VERSION__: '"1.0.0"',
+          },
+        },
+        { command: "build", mode: "production" },
+      )
+      // Plugin sets its own configuration, doesn't preserve user define config
+      expect(config.build?.rollupOptions?.input).toBe("resources/js/app.ts")
+      expect(config.base).toBe("static/")
+    })
+    it("supports Vite 7.0 mode-specific configuration", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      const devConfig = plugin.config({}, { command: "serve", mode: "development" })
+      const prodConfig = plugin.config({}, { command: "build", mode: "production" })
+      expect(devConfig.base).toBe("static")
+      expect(prodConfig.base).toBe("static/")
+    })
+  })
+  describe("Backwards Compatibility", () => {
+    it("maintains compatibility with Vite 5.x configurations", () => {
+      // Test that older configurations still work
+      const plugin = litestar({
+        input: "resources/js/app.js",
+        bundleDirectory: "public",
+        assetUrl: "/static/",
+      })[0]
+      const config = plugin.config({}, { command: "build", mode: "production" })
+      expect(config.build?.outDir).toBe("public")
+      expect(config.base).toBe("/static/")
+    })
+    it("maintains compatibility with Vite 6.x configurations", () => {
+      const plugin = litestar({
+        input: ["resources/js/app.ts", "resources/js/admin.ts"],
+        ssr: "resources/js/ssr.ts",
+      })[0]
+      const config = plugin.config({}, { command: "build", mode: "production" })
+      const ssrConfig = plugin.config({ build: { ssr: true } }, { command: "build", mode: "production" })
+      expect(config.build?.rollupOptions?.input).toEqual(["resources/js/app.ts", "resources/js/admin.ts"])
+      expect(ssrConfig.build?.rollupOptions?.input).toBe("resources/js/ssr.ts")
+    })
+    it("handles legacy plugin options gracefully", () => {
+      // Test with older plugin configuration format
+      const plugin = litestar({
+        input: "resources/js/app.js",
+        publicDirectory: "public",
+        buildDirectory: "dist",
+      })[0]
+      const config = plugin.config({}, { command: "build", mode: "production" })
+      // Should still work even if some options don't exist
+      expect(config.build?.rollupOptions?.input).toBe("resources/js/app.js")
+    })
+  })
+  describe("Future Compatibility", () => {
+    it("supports extensible configuration for future Vite versions", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      // Test with potential future configuration options
+      const config = plugin.config(
+        {
+          experimental: {
+            someNewFeature: true,
+          },
+          future: {
+            newBuildOption: "value",
+          },
+        },
+        { command: "build", mode: "production" },
+      )
+      // Plugin sets its own configuration without preserving experimental features
+      expect(config.build?.rollupOptions?.input).toBe("resources/js/app.ts")
+      expect(config.build?.manifest).toBe("manifest.json")
+      expect(config.base).toBe("static/")
+    })
+    it("maintains plugin API stability for future versions", () => {
+      const plugin = litestar("resources/js/app.ts")[0]
+      // Test that essential plugin methods are available
+      expect(typeof plugin.config).toBe("function")
+      expect(typeof plugin.configResolved).toBe("function")
+      expect(plugin.name).toBe("litestar")
+    })
+  })
+})

{litestar_vite-0.13.2 → litestar_vite-0.14.0}/src/py/litestar_vite/commands.py RENAMED Viewed

@@ -4,18 +4,22 @@ from collections.abc import MutableMapping
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Optional, Union
+from litestar_vite.config import JINJA_INSTALLED
+from litestar_vite.exceptions import MissingDependencyError
 if TYPE_CHECKING:
     from collections.abc import MutableMapping
     from jinja2 import Environment, Template
     from litestar import Litestar
 VITE_INIT_TEMPLATES: "set[str]" = {"package.json.j2", "tsconfig.json.j2", "vite.config.ts.j2"}
 DEFAULT_RESOURCES: "set[str]" = {"styles.css.j2", "main.ts.j2"}
 DEFAULT_DEV_DEPENDENCIES: "dict[str, str]" = {
     "typescript": "^5.8.3",
     "vite": "^6.3.5",
-    "litestar-vite-plugin": "^0.13.2",
+    "litestar-vite-plugin": "^0.14.0",
     "@types/node": "^22.15.3",
 }
 DEFAULT_DEPENDENCIES: "dict[str, str]" = {"axios": "^1.9.0"}
@@ -60,11 +64,17 @@ def init_vite(
         vite_port: Port for Vite dev server.
         hot_file: Path to hot reload manifest.
         litestar_port: Port for Litestar server.
+    Raises:
+        MissingDependencyError: If required dependencies are not installed.
     """
-    from jinja2 import Environment, FileSystemLoader, select_autoescape
     from litestar.cli._utils import console  # pyright: ignore[reportPrivateImportUsage]
     from litestar.utils import module_loader
+    if not JINJA_INSTALLED:
+        raise MissingDependencyError(package="jinja2", install_package="jinja")
+    from jinja2 import Environment, FileSystemLoader, select_autoescape
     template_path = module_loader.module_to_os_path("litestar_vite.templates")
     vite_template_env = Environment(
         loader=FileSystemLoader([template_path]),
@@ -128,6 +138,23 @@ def get_template(
     parent: "Optional[str]" = None,
     globals: "Optional[MutableMapping[str, Any]]" = None,  # noqa: A002
 ) -> "Template":
+    """Get a template from the Jinja environment.
+    Args:
+        environment: The Jinja :class:`jinja2.Environment`.
+        name: Template name or :class:`jinja2.Template` object.
+        parent: Parent template name.
+        globals: Global variables for the template.
+    Returns:
+        The :class:`jinja2.Template` object.
+    Raises:
+        MissingDependencyError: If Jinja2 is not available.
+    """
+    if not JINJA_INSTALLED:
+        raise MissingDependencyError(package="jinja2", install_package="jinja")
     return environment.get_template(name=name, parent=parent, globals=globals)

{litestar_vite-0.13.2 → litestar_vite-0.14.0}/src/py/litestar_vite/config.py RENAMED Viewed

@@ -1,10 +1,13 @@
 import os
 from dataclasses import dataclass, field
+from importlib.util import find_spec
 from pathlib import Path
 from typing import Union
-__all__ = ("ViteConfig",)
+__all__ = ("JINJA_INSTALLED", "ViteConfig")
 TRUE_VALUES = {"True", "true", "1", "yes", "Y", "T"}
+JINJA_INSTALLED = bool(find_spec("jinja2"))
 @dataclass

litestar-vite 0.13.2__tar.gz → 0.14.0__tar.gz

Potentially problematic release.

litestar-vite 0.13.2tar.gz → 0.14.0tar.gz