litestar-vite 0.1.21__py3-none-any.whl → 0.2.0__py3-none-any.whl

litestar_vite/loader.py

@@ -1,18 +1,15 @@
 from __future__ import annotations
 
 import json
+from functools import cached_property
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, ClassVar, TypeVar
+from textwrap import dedent
+from typing import TYPE_CHECKING, Any, ClassVar
 from urllib.parse import urljoin
 
-from litestar.cli._utils import console
-from litestar.template import TemplateEngineProtocol
-
 if TYPE_CHECKING:
     from litestar_vite.config import ViteConfig
 
-T = TypeVar("T", bound=TemplateEngineProtocol)
-
 
 class ViteAssetLoader:
     """Vite  manifest loader.
@@ -25,6 +22,7 @@ class ViteAssetLoader:
     def __init__(self, config: ViteConfig) -> None:
         self._config = config
         self._manifest: dict[str, Any] = {}
+        self._manifest_content: str = ""
         self._vite_base_path: str | None = None
 
     @classmethod
@@ -35,6 +33,12 @@ class ViteAssetLoader:
             cls._instance.parse_manifest()
         return cls._instance
 
+    @cached_property
+    def version_id(self) -> str:
+        if self._manifest_content != "":
+            return str(hash(self.manifest_content))
+        return "1.0"
+
     def parse_manifest(self) -> None:
         """Read and parse the Vite manifest file.
 
@@ -65,27 +69,27 @@ class ViteAssetLoader:
             RuntimeError: if cannot load the file or JSON in file is malformed.
         """
         if self._config.hot_reload and self._config.dev_mode:
-            if Path(
+            hot_file_path = Path(
                 f"{self._config.bundle_dir}/{self._config.hot_file}",
-            ).exists():
-                with Path(f"{self._config.bundle_dir}/{self._config.hot_file}").open() as hot_file:
+            )
+            if hot_file_path.exists():
+                with hot_file_path.open() as hot_file:
                     self._vite_base_path = hot_file.read()
 
         else:
+            manifest_path = Path(f"{self._config.bundle_dir}/{self._config.manifest_name}")
             try:
-                with Path(f"{self._config.bundle_dir}/{self._config.manifest_name}").open() as manifest_file:
-                    manifest_content = manifest_file.read()
-                    self._manifest = json.loads(manifest_content)
-            except FileNotFoundError:
-                console.print(
-                    f"[bold red]Cannot read Vite manifest file at {self._config.bundle_dir}/{self._config.manifest_name}. Did you forget to build your assets?",
-                )
-                self._manifest = {}
-            except Exception as exc:  # noqa: BLE001
+                if manifest_path.exists():
+                    with manifest_path.open() as manifest_file:
+                        self.manifest_content = manifest_file.read()
+                        self._manifest = json.loads(self.manifest_content)
+                else:
+                    self._manifest = {}
+            except Exception as exc:
                 msg = "There was an issue reading the Vite manifest file at  %s. Did you forget to build your assets?"
                 raise RuntimeError(
                     msg,
-                    Path(f"{self._config.bundle_dir}/{self._config.manifest_name}"),
+                    manifest_path,
                 ) from exc
 
     def generate_ws_client_tags(self) -> str:
@@ -112,7 +116,7 @@ class ViteAssetLoader:
             str: The script tag or an empty string.
         """
         if self._config.is_react and self._config.hot_reload and self._config.dev_mode:
-            return f"""
+            return dedent(f"""
                 <script type="module">
                 import RefreshRuntime from '{self._vite_server_url()}@react-refresh'
                 RefreshRuntime.injectIntoGlobalHook(window)
@@ -120,7 +124,7 @@ class ViteAssetLoader:
                 window.$RefreshSig$ = () => (type) => type
                 window.__vite_plugin_react_preamble_installed__=true
                 </script>
-                """
+                """)
         return ""
 
     def generate_asset_tags(self, path: str | list[str], scripts_attrs: dict[str, str] | None = None) -> str:
@@ -134,7 +138,9 @@ class ViteAssetLoader:
         if self._config.hot_reload and self._config.dev_mode:
             return "".join(
                 [
-                    self._script_tag(
+                    self._style_tag(self._vite_server_url(p))
+                    if p.endswith(".css")
+                    else self._script_tag(
                         self._vite_server_url(p),
                         {"type": "module", "async": "", "defer": ""},
                     )
@@ -143,7 +149,7 @@ class ViteAssetLoader:
             )
 
         if any(p for p in path if p not in self._manifest):
-            msg = "Cannot find %s in Vite manifest at %s.  Did you forget to build your assets?"
+            msg = "Cannot find %s in Vite manifest at %s.  Did you forget to build your assets after an update?"
             raise RuntimeError(
                 msg,
                 path,
@@ -151,30 +157,33 @@ class ViteAssetLoader:
             )
 
         tags: list[str] = []
-        for p in path:
-            manifest_entry: dict = self._manifest[p]
+        manifest_entry: dict[str, Any] = {}
+        manifest_entry.update({p: self._manifest[p] for p in path})
         if not scripts_attrs:
             scripts_attrs = {"type": "module", "async": "", "defer": ""}
-
-        # Add dependent CSS
-        if "css" in manifest_entry:
-            tags.extend(
-                self._style_tag(urljoin(self._config.asset_url, css_path)) for css_path in manifest_entry.get("css", {})
-            )
-        # Add dependent "vendor"
-        if "imports" in manifest_entry:
-            tags.extend(
-                self.generate_asset_tags(vendor_path, scripts_attrs=scripts_attrs)
-                for vendor_path in manifest_entry.get("imports", {})
-            )
-        # Add the script by itself
-        tags.append(
-            self._script_tag(
-                urljoin(self._config.asset_url, manifest_entry["file"]),
-                attrs=scripts_attrs,
-            ),
-        )
-
+        for manifest in manifest_entry.values():
+            if "css" in manifest:
+                tags.extend(
+                    self._style_tag(urljoin(self._config.asset_url, css_path)) for css_path in manifest.get("css", {})
+                )
+            # Add dependent "vendor"
+            if "imports" in manifest:
+                tags.extend(
+                    self.generate_asset_tags(vendor_path, scripts_attrs=scripts_attrs)
+                    for vendor_path in manifest.get("imports", {})
+                )
+            # Add the script by itself
+            if manifest.get("file").endswith(".css"):
+                tags.append(
+                    self._style_tag(urljoin(self._config.asset_url, manifest["file"])),
+                )
+            else:
+                tags.append(
+                    self._script_tag(
+                        urljoin(self._config.asset_url, manifest["file"]),
+                        attrs=scripts_attrs,
+                    ),
+                )
         return "".join(tags)
 
     def _vite_server_url(self, path: str | None = None) -> str:
@@ -194,7 +203,9 @@ class ViteAssetLoader:
 
     def _script_tag(self, src: str, attrs: dict[str, str] | None = None) -> str:
         """Generate an HTML script tag."""
-        attrs_str = " ".join([f'{key}="{value}"' for key, value in attrs.items()]) if attrs is not None else ""
+        if attrs is None:
+            attrs = {}
+        attrs_str = " ".join([f'{key}="{value}"' for key, value in attrs.items()])
         return f'<script {attrs_str} src="{src}"></script>'
 
     def _style_tag(self, href: str) -> str:

litestar_vite/plugin.py

@@ -6,14 +6,19 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Iterator, cast
 
 from litestar.plugins import CLIPlugin, InitPluginProtocol
-from litestar.static_files import create_static_files_router
+from litestar.static_files import (
+    create_static_files_router,  # pyright: ignore[reportUnknownVariableType]
+)
+
+from litestar_vite.config import ViteConfig
 
 if TYPE_CHECKING:
     from click import Group
     from litestar import Litestar
     from litestar.config.app import AppConfig
 
-    from litestar_vite.config import ViteConfig
+    from litestar_vite.config import ViteTemplateConfig
+    from litestar_vite.template_engine import ViteTemplateEngine
 
 
 def set_environment(config: ViteConfig) -> None:
@@ -23,6 +28,7 @@ def set_environment(config: ViteConfig) -> None:
     os.environ.setdefault("VITE_PORT", str(config.port))
     os.environ.setdefault("VITE_HOST", config.host)
     os.environ.setdefault("VITE_PROTOCOL", config.protocol)
+    os.environ.setdefault("APP_URL", "http://localhost:8000")
     if config.dev_mode:
         os.environ.setdefault("VITE_DEV_MODE", str(config.dev_mode))
 
@@ -32,23 +38,35 @@ class VitePlugin(InitPluginProtocol, CLIPlugin):
 
     __slots__ = ("_config",)
 
-    def __init__(self, config: ViteConfig) -> None:
+    def __init__(self, config: ViteConfig | None = None) -> None:
         """Initialize ``Vite``.
 
         Args:
-            config: configure and start Vite.
+            config: configuration to use for starting Vite.  The default configuration will be used if it is not provided.
         """
+        if config is None:
+            config = ViteConfig()
         self._config = config
 
     @property
     def config(self) -> ViteConfig:
         return self._config
 
+    @property
+    def template_config(self) -> ViteTemplateConfig[ViteTemplateEngine]:
+        from litestar_vite.config import ViteTemplateConfig
+        from litestar_vite.template_engine import ViteTemplateEngine
+
+        return ViteTemplateConfig[ViteTemplateEngine](
+            engine=ViteTemplateEngine,
+            config=self._config,
+            directory=self._config.template_dir,
+        )
+
     def on_cli_init(self, cli: Group) -> None:
         from litestar_vite.cli import vite_group
 
         cli.add_command(vite_group)
-        return super().on_cli_init(cli)
 
     def on_app_init(self, app_config: AppConfig) -> AppConfig:
         """Configure application for use with Vite.
@@ -57,14 +75,8 @@ class VitePlugin(InitPluginProtocol, CLIPlugin):
             app_config: The :class:`AppConfig <.config.app.AppConfig>` instance.
         """
 
-        from litestar_vite.config import ViteTemplateConfig
-        from litestar_vite.template_engine import ViteTemplateEngine
-
-        app_config.template_config = ViteTemplateConfig(  # type: ignore[assignment]
-            engine=ViteTemplateEngine,
-            config=self._config,
-            directory=self._config.template_dir,
-        )
+        if self._config.template_dir is not None:
+            app_config.template_config = self.template_config
 
         if self._config.set_static_folders:
             static_dirs = [Path(self._config.bundle_dir), Path(self._config.resource_dir)]
@@ -112,8 +124,13 @@ class VitePlugin(InitPluginProtocol, CLIPlugin):
                 yield
             finally:
                 if vite_thread.is_alive():
-                    vite_thread.join()
+                    vite_thread.join(timeout=5)
                 console.print("[yellow]Vite process stopped.[/]")
 
         else:
+            manifest_path = Path(f"{self._config.bundle_dir}/{self._config.manifest_name}")
+            if manifest_path.exists():
+                console.rule(f"[yellow]Serving assets using manifest at `{manifest_path!s}`.[/]", align="left")
+            else:
+                console.rule(f"[yellow]Serving assets without manifest at `{manifest_path!s}`.[/]", align="left")
             yield

litestar_vite/template_engine.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, TypeVar
+from typing import TYPE_CHECKING, Any, Mapping, TypeVar
 
 import markupsafe
 from litestar.contrib.jinja import JinjaTemplateEngine
@@ -12,10 +12,11 @@ if TYPE_CHECKING:
     from pathlib import Path
 
     from jinja2 import Environment
+    from jinja2 import Template as JinjaTemplate
 
     from litestar_vite.config import ViteConfig
 
-T = TypeVar("T", bound=TemplateEngineProtocol)
+T = TypeVar("T", bound=TemplateEngineProtocol["JinjaTemplate", Mapping[str, Any]])
 
 
 class ViteTemplateEngine(JinjaTemplateEngine):
@@ -39,9 +40,8 @@ class ViteTemplateEngine(JinjaTemplateEngine):
             msg = "Please configure the `ViteConfig` instance."
             raise ValueError(msg)
         self.config = config
-
         self.asset_loader = ViteAssetLoader.initialize_loader(config=self.config)
-        self.engine.globals.update({"vite_hmr": self.get_hmr_client, "vite": self.get_asset_tag})
+        self.engine.globals.update({"vite_hmr": self.get_hmr_client, "vite": self.get_asset_tag})  # pyright: ignore[reportCallIssue,reportArgumentType]
 
     def get_hmr_client(self) -> markupsafe.Markup:
         """Generate the script tag for the Vite WS client for HMR.
@@ -62,6 +62,7 @@ class ViteTemplateEngine(JinjaTemplateEngine):
         self,
         path: str | list[str],
         scripts_attrs: dict[str, str] | None = None,
+        **_: Any,
     ) -> markupsafe.Markup:
         """Generate all assets include tags for the file in argument.
 
@@ -75,6 +76,7 @@ class ViteTemplateEngine(JinjaTemplateEngine):
             context: The template context.
             path: Path to a Vite asset to include.
             scripts_attrs: script attributes
+            _: extra args to satisfy type checking
 
         Keyword Arguments:
             scripts_attrs {Optional[Dict[str, str]]}: Override attributes added to scripts tags. (default: {None})
@@ -82,4 +84,21 @@ class ViteTemplateEngine(JinjaTemplateEngine):
         Returns:
             str: All tags to import this asset in your HTML page.
         """
-        return markupsafe.Markup(self.asset_loader.generate_asset_tags(path, scripts_attrs=scripts_attrs))
+        if isinstance(path, str):
+            path = [path]
+        return markupsafe.Markup(
+            "".join([self.asset_loader.generate_asset_tags(p, scripts_attrs=scripts_attrs) for p in path]),
+        )
+
+    @classmethod
+    def from_environment(cls, config: ViteConfig, jinja_environment: Environment) -> ViteTemplateEngine:  # type: ignore[override]
+        """Create a JinjaTemplateEngine from an existing jinja Environment instance.
+
+        Args:
+            config: Vite config
+            jinja_environment (jinja2.environment.Environment): A jinja Environment instance.
+
+        Returns:
+            JinjaTemplateEngine instance
+        """
+        return cls(directory=None, config=config, engine_instance=jinja_environment)

litestar_vite/templates/index.html.j2

@@ -1,18 +1,16 @@
 <!DOCTYPE html>
 <html>
-  <head>
-    <meta charset="utf-8" />
-    <!--IE compatibility-->
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1.0, maximum-scale=1.0"
-    />
-  </head>
 
-  <body>
-    <div id="app"></div>
-    {{ vite_hmr() }}
-    {{ vite('resources/main.ts') }}
-  </body>
+<head>
+  <meta charset="utf-8" />
+  <!--IE compatibility-->
+  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
+</head>
+
+<body>
+  {{ vite_hmr() }}
+  {{ vite('resources/main.ts') }}
+</body>
+
 </html>

litestar_vite/templates/main.ts.j2

@@ -0,0 +1 @@
+import "./styles.css"

{litestar_vite-0.1.21.dist-info → litestar_vite-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: litestar-vite
-Version: 0.1.21
+Version: 0.2.0
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j
@@ -70,19 +70,9 @@ class WebController(Controller):
         return Template(template_name="index.html.j2")
 
 
-vite = VitePlugin(
-    config=ViteConfig(
-        bundle_dir=Path("./public"),
-        resource_dir=Path("./resources"),
-        template_dir=Path("./templates"),
-        # Should be False when in production
-        dev_mode=True,
-        hot_reload=True, # Websocket HMR asset reloading is enabled when true.
-    ),
-)
+vite = VitePlugin(config=ViteConfig(template_dir='templates/'))
 app = Litestar(plugins=[vite], route_handlers=[WebController])
 
-
 ```
 
 Create a template to serve the application in `./templates/index.html.h2`:

litestar_vite-0.2.0.dist-info/RECORD

@@ -0,0 +1,30 @@
+litestar_vite/__init__.py,sha256=QEZzbM6LXuSm52rzpzcw3OihR7xxoPCZ6jhWtZH2dZc,402
+litestar_vite/__metadata__.py,sha256=Eml1c9xezV-GSodmysksrT8jPWqE__x0ENO1wM5g6q0,319
+litestar_vite/cli.py,sha256=foXJ-xW1bvUEsT7nPo1hbN0FLaDzHWPG4zpmqN__rY0,10976
+litestar_vite/commands.py,sha256=sfTdFfMcDxnW3_tbmIIBjpHmNdQYKHjSguGxXNP8SVw,4440
+litestar_vite/config.py,sha256=Mg86uVtqDG-uVZd2YUZoJYNRIlBBbyJLl8iI-fO1zKo,7527
+litestar_vite/loader.py,sha256=USrzNDppXgXLvW5WCuIgKPuM6MlECNIssnkwb_p-E8s,8117
+litestar_vite/plugin.py,sha256=2rwlumH3CFozb_7NGOFwn20BMZ_4JTNHiWh0oyaN-gc,5131
+litestar_vite/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+litestar_vite/template_engine.py,sha256=ffC4KPtUUNkuC0tJ0bD1Bu7c8lE33vKP0US1fWUYnO8,3853
+litestar_vite/inertia/__init__.py,sha256=PMOon8tag-20riAkHH3U4VLk7NBwt9lHsOHHSKMQHJQ,695
+litestar_vite/inertia/_utils.py,sha256=IAsK4Nrjx2dr9z7rXBLHAu_FG8GvCpo_fpywY7RHwl0,1932
+litestar_vite/inertia/config.py,sha256=6cYR4m5oGsJnL_rH6Dt8bQJ804Oq6knj6qDsCVUqNsI,942
+litestar_vite/inertia/exception_handler.py,sha256=fXLfUtrooAORd7TWJGx8hDd6_0h_mI3w89CqJz5IMmE,4022
+litestar_vite/inertia/middleware.py,sha256=9ADCoCNdQNLDYhQ6ctY4Lo92E_EtgBPqIo2SdOJz9zU,1766
+litestar_vite/inertia/plugin.py,sha256=ebAG9XnDBahttuc7WIUgBd3o_Ys8MdPS273LPNs5H8A,2344
+litestar_vite/inertia/request.py,sha256=UReg7_ks6MGa2HbIpDsD2DochckbLA-c-k8Er2mHkVA,3509
+litestar_vite/inertia/response.py,sha256=31Hm838c7nJAkKe9joLj-c33UlZpWTFAgQefxLd5vn0,14379
+litestar_vite/inertia/routes.py,sha256=QksJm2RUfL-WbuhOieYnPXXWO5GYnPtmsYEm6Ef8Yeo,1782
+litestar_vite/inertia/types.py,sha256=tLp0pm1N__hcWC875khf6wH1nuFlKS9-VjDqgsRkXnw,702
+litestar_vite/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+litestar_vite/templates/index.html.j2,sha256=Xue1cTl6piEOZkW3UG68SnW80NeL9PxaOp-Xr23kpr4,322
+litestar_vite/templates/main.ts.j2,sha256=Nzr5m_hXMAjeDL_4yQNP3DMCf7Blh3dwg5m-67GJVbY,22
+litestar_vite/templates/package.json.j2,sha256=0JWgdTuaSZ25EmCltF_zbqDdpxfvCLeYuzBjXrziXNw,299
+litestar_vite/templates/styles.css.j2,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+litestar_vite/templates/tsconfig.json.j2,sha256=q1REIuVyXUHCy4Zi2kgTkmrhdT98vyY89k-WTrImOj8,843
+litestar_vite/templates/vite.config.ts.j2,sha256=FZ4OJaB8Kjby_nlx4_LCP8eCe1LRi8kW2GspCiVMfDY,1115
+litestar_vite-0.2.0.dist-info/METADATA,sha256=DGPtfcXb9Khk4EXmvwXCJAb2T992hzHkR3CLtIHAqG8,6180
+litestar_vite-0.2.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+litestar_vite-0.2.0.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
+litestar_vite-0.2.0.dist-info/RECORD,,

{litestar_vite-0.1.21.dist-info → litestar_vite-0.2.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.22.3
+Generator: hatchling 1.25.0
 Root-Is-Purelib: true
 Tag: py3-none-any

litestar_vite-0.1.21.dist-info/RECORD

@@ -1,19 +0,0 @@
-litestar_vite/__init__.py,sha256=9X3i67Q8DJN2lQYAMa9NSPTZGzHASGn8X8yeWJqBvWg,357
-litestar_vite/__metadata__.py,sha256=Eml1c9xezV-GSodmysksrT8jPWqE__x0ENO1wM5g6q0,319
-litestar_vite/cli.py,sha256=6SmKu_wdduotTsx1xbmQFooQqG8SZyHwIDvZrr3KMJI,9527
-litestar_vite/commands.py,sha256=_TrBJE12HbsdKFkjGLpu8b_WvkoDp5-VV0xvRkYjsjk,4107
-litestar_vite/config.py,sha256=L93F0CrghlNrAHlmTPqYtZxtZoLPf5kOJebqFxAlVOE,6824
-litestar_vite/loader.py,sha256=3BFvcsXdaTwyym6bHaGhTkNDFaAcdjQDUHRfuKHj2vM,7699
-litestar_vite/plugin.py,sha256=nNB62gqRXv6x1nxJNxZZPd67zOaw9XvGQxP_AxDyPbk,4230
-litestar_vite/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-litestar_vite/template_engine.py,sha256=UIxphAoAKrAcpAuV_CJmZgsN9GOFfqq0azQdId6yofg,2995
-litestar_vite/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-litestar_vite/templates/index.html.j2,sha256=GobZbXgrlFRf3sCoS-416iWfV8lBP_v3AXPQX_QVzZA,381
-litestar_vite/templates/main.css.j2,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-litestar_vite/templates/package.json.j2,sha256=0JWgdTuaSZ25EmCltF_zbqDdpxfvCLeYuzBjXrziXNw,299
-litestar_vite/templates/tsconfig.json.j2,sha256=q1REIuVyXUHCy4Zi2kgTkmrhdT98vyY89k-WTrImOj8,843
-litestar_vite/templates/vite.config.ts.j2,sha256=FZ4OJaB8Kjby_nlx4_LCP8eCe1LRi8kW2GspCiVMfDY,1115
-litestar_vite-0.1.21.dist-info/METADATA,sha256=iWyAfdMchcgSKoDC-MX6Oq6zJ5a3TBQ-kO-7ELzpBO8,6437
-litestar_vite-0.1.21.dist-info/WHEEL,sha256=bq9SyP5NxIRA9EpQgMCd-9RmPHWvbH-4lTDGwxgIR64,87
-litestar_vite-0.1.21.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
-litestar_vite-0.1.21.dist-info/RECORD,,