litestar-vite 0.8.0__py3-none-any.whl → 0.8.1__py3-none-any.whl

litestar_vite/plugin.py

@@ -0,0 +1,136 @@
+from __future__ import annotations
+
+import os
+from contextlib import contextmanager
+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,  # 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 ViteTemplateConfig
+    from litestar_vite.template_engine import ViteTemplateEngine
+
+
+def set_environment(config: ViteConfig) -> None:
+    """Configure environment for easier integration"""
+    os.environ.setdefault("ASSET_URL", config.asset_url)
+    os.environ.setdefault("VITE_ALLOW_REMOTE", str(True))
+    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", f"http://localhost:{os.environ.get('LITESTAR_PORT',8000)}")
+    if config.dev_mode:
+        os.environ.setdefault("VITE_DEV_MODE", str(config.dev_mode))
+
+
+class VitePlugin(InitPluginProtocol, CLIPlugin):
+    """Vite plugin."""
+
+    __slots__ = ("_config",)
+
+    def __init__(self, config: ViteConfig | None = None) -> None:
+        """Initialize ``Vite``.
+
+        Args:
+            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)
+
+    def on_app_init(self, app_config: AppConfig) -> AppConfig:
+        """Configure application for use with Vite.
+
+        Args:
+            app_config: The :class:`AppConfig <.config.app.AppConfig>` instance.
+        """
+
+        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)]
+            if Path(self._config.public_dir).exists() and self._config.public_dir != self._config.bundle_dir:
+                static_dirs.append(Path(self._config.public_dir))
+            app_config.route_handlers.append(
+                create_static_files_router(
+                    directories=cast(  # type: ignore[arg-type]
+                        "list[Path]",
+                        static_dirs if self._config.dev_mode else [Path(self._config.bundle_dir)],
+                    ),
+                    path=self._config.asset_url,
+                    name="vite",
+                    html_mode=False,
+                    include_in_schema=False,
+                    opt={"exclude_from_auth": True},
+                ),
+            )
+        return app_config
+
+    @contextmanager
+    def server_lifespan(self, app: Litestar) -> Iterator[None]:
+        import threading
+
+        from litestar.cli._utils import console
+
+        from litestar_vite.commands import execute_command
+
+        if self._config.use_server_lifespan and self._config.dev_mode:
+            command_to_run = self._config.run_command if self._config.hot_reload else self._config.build_watch_command
+            if self.config.hot_reload:
+                console.rule("[yellow]Starting Vite process with HMR Enabled[/]", align="left")
+            else:
+                console.rule("[yellow]Starting Vite watch and build process[/]", align="left")
+            if self._config.set_environment:
+                set_environment(config=self._config)
+            vite_thread = threading.Thread(
+                name="vite",
+                target=execute_command,
+                args=[],
+                kwargs={"command_to_run": command_to_run, "cwd": self._config.root_dir},
+            )
+            try:
+                vite_thread.start()
+                yield
+            finally:
+                if vite_thread.is_alive():
+                    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

@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Mapping, TypeVar
+
+import markupsafe
+from litestar.contrib.jinja import JinjaTemplateEngine
+from litestar.template.base import TemplateEngineProtocol
+
+from litestar_vite.loader import ViteAssetLoader
+
+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["JinjaTemplate", Mapping[str, Any]])
+
+
+class ViteTemplateEngine(JinjaTemplateEngine):
+    """Jinja Template Engine with Vite Integration.
+
+    This class extends :class:`litestar.contrib.jinja.JinjaTemplateEngine` to provide Vite asset integration
+    and hot module reloading support.
+
+    Raises:
+        TemplateNotFoundException: If template is not found.
+    """
+
+    def __init__(
+        self,
+        directory: Path | list[Path] | None = None,
+        engine_instance: Environment | None = None,
+        config: ViteConfig | None = None,
+    ) -> None:
+        """Jinja2 based TemplateEngine.
+
+        Args:
+            directory: Direct path or list of directory paths from which to serve templates.
+            engine_instance: A jinja Environment instance.
+            config: Vite config
+        """
+        super().__init__(directory=directory, engine_instance=engine_instance)
+        if config is None:
+            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})  # pyright: ignore[reportCallIssue,reportUnknownMemberType,reportArgumentType]
+
+    def get_hmr_client(self) -> markupsafe.Markup:
+        """Generate the script tag for the Vite WS client for HMR.
+
+        Only used when hot module reloading is enabled, in production this method returns an empty string.
+
+        Returns:
+            markupsafe.Markup: The script tag or an empty string.
+        """
+        return markupsafe.Markup(
+            f"{self.asset_loader.generate_react_hmr_tags()}{self.asset_loader.generate_ws_client_tags()}",
+        )
+
+    def get_asset_tag(
+        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.
+
+        Generates all scripts tags for this file and all its dependencies
+        (JS and CSS) by reading the manifest file (for production only).
+        In development Vite imports all dependencies by itself.
+        Place this tag in <head> section of your page.
+
+        Args:
+            path: Path to a Vite asset to include.
+            scripts_attrs: Dictionary of attributes to add to script tags.
+            **_: Additional keyword arguments (ignored).
+
+        Returns:
+            markupsafe.Markup: HTML markup containing all required asset tags.
+        """
+        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

@@ -0,0 +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>
+  {{ vite_hmr() }}
+  {{ vite('resources/main.ts') }}
+</body>
+
+</html>

litestar_vite/templates/main.ts.j2

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

litestar_vite/templates/package.json.j2

@@ -0,0 +1,11 @@
+{
+    "private": true,
+    "type": "module",
+    "scripts": {
+        "dev": "vite",
+        "watch": "vite build --watch",
+        "build": "vite build{% if enable_ssr %} && vite build --ssr{% endif %}"
+    },
+    "dependencies": {{ dependencies }},
+    "devDependencies": {{ dev_dependencies }}
+}

litestar_vite/templates/tsconfig.json.j2

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "module": "ES2020",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "jsx": "preserve",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+    "noEmit": true,
+    "composite": true,
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": "{{ resource_path }}",
+    "paths": {
+      "@/*": ["./*"]
+    },
+    "types": ["vite/client"]
+  },
+  "include": [
+    {% if include_react %}"{{ resource_path }}/**/*.tsx","{{ resource_path }}/**/*.jsx",{% endif %}{% if include_vue %} "{{ resource_path }}/**/*.vue",{% endif %}
+    "**/*.d.ts",
+    "{{ resource_path }}/**/*.js" ,
+    "{{ resource_path }}/**/*.ts" ,
+    "vite.config.ts"
+  ]
+}

litestar_vite/templates/vite.config.ts.j2

@@ -0,0 +1,38 @@
+import { defineConfig } from "vite";
+{% if include_vue %}import vue from "@vitejs/plugin-vue";{% endif %}
+{% if include_react %}import react from "@vitejs/plugin-react";{% endif %}
+import litestar from "litestar-vite-plugin";
+
+const ASSET_URL = process.env.ASSET_URL || "{{ asset_url }}";
+const VITE_PORT = process.env.VITE_PORT || "5173";
+const VITE_HOST = process.env.VITE_HOST || "localhost";
+export default defineConfig({
+  base: `${ASSET_URL}`,
+  {% if root_path and root_path != '.' %} root: "{{ root_path }}",{% endif %}
+  server: {
+    host: "0.0.0.0",
+    port: +`${VITE_PORT}`,
+    cors: true,
+    hmr: {
+      host: `${VITE_HOST}`,
+    },
+  },
+  plugins: [
+    {% if include_vue %}vue(),{% endif %}
+    {% if include_react %}react(),{% endif %}
+    litestar({
+      input: [
+        {% if entry_point %}"{{ entry_point | join('\", \"') }}"{% endif %}
+      ],
+      assetUrl: `${ASSET_URL}`,
+      bundleDirectory: "{{ bundle_path }}",
+      resourceDirectory: "{{ resource_path }}",
+      hotFile: "{{ hot_file }}"
+    }),
+  ],
+  resolve: {
+    alias: {
+      "@": "{{ resource_path }}"
+    },
+  },
+});

{litestar_vite-0.8.0.dist-info → litestar_vite-0.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: litestar-vite
-Version: 0.8.0
+Version: 0.8.1
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j

litestar_vite-0.8.1.dist-info/RECORD

@@ -0,0 +1,30 @@
+litestar_vite/__init__.py,sha256=S2zgWHas3O16FhXukd1j3tGCMP9skj7Rp-BvMQA7sd8,402
+litestar_vite/__metadata__.py,sha256=_Wo-vNQuj5co9J4FwJAB2rRafbFo8ztTHrXmEPrYrV8,514
+litestar_vite/cli.py,sha256=foXJ-xW1bvUEsT7nPo1hbN0FLaDzHWPG4zpmqN__rY0,10976
+litestar_vite/commands.py,sha256=mqbgCzN0eRLAKfPFxMzpgwfzFrYv8kManl_uY4cEkqE,4961
+litestar_vite/config.py,sha256=CN5XpRObgAd7nZd4rhF-a_07M_s2FFUsImq-iZjc8RU,7685
+litestar_vite/loader.py,sha256=gK0RlenM-enNV_pS-jEwW9hanAmq053m2P75rfQuGCg,8227
+litestar_vite/plugin.py,sha256=p4VPKYdWw5qIYZ1OwfdMRcwM_Q-vfoDEmIbu3IyF7oI,5166
+litestar_vite/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+litestar_vite/template_engine.py,sha256=lFFJsD-sgf3LIaFDoD1NysRUg49WV-ELE53SHiBDeeA,3837
+litestar_vite/inertia/__init__.py,sha256=Fab61KXbBnyub2Nx-2AHYv2U6QiYUIrqhEZia_f9xik,863
+litestar_vite/inertia/_utils.py,sha256=ijO9Lgka7ZPIAHkby9szbTGoSg0nDShC2bqWT9cDxi0,1956
+litestar_vite/inertia/config.py,sha256=0Je9SLg0acv0eRvudk3aJLj5k1DjPxULoVOwAfpjnUc,1232
+litestar_vite/inertia/exception_handler.py,sha256=0FiW8jVib0xT453BzMPOeJa7bRwnxkOUdJ91kiFHPIo,5308
+litestar_vite/inertia/middleware.py,sha256=NEDcAoT7GMWA9hEGvANZ3MG5_p3MmZX57RF95T71les,1716
+litestar_vite/inertia/plugin.py,sha256=OgXmmvjl7KWlt4KEkYhS3mU2EY4iYN9JtJ20S3Qlht8,2349
+litestar_vite/inertia/request.py,sha256=Ogt_ikauWrsgKafaip7IL1YhbybwjdBAQ0PQS7cImoQ,3848
+litestar_vite/inertia/response.py,sha256=Au7jQnqjY3wJAHNmiwteCZxKTKGCpnkjMTSzBVRwkXs,15927
+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.8.1.dist-info/METADATA,sha256=Ylm0LhfvoJgcOjM7pmYbeGRgEbt2sZqzIKzA2j9ManY,6022
+litestar_vite-0.8.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+litestar_vite-0.8.1.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
+litestar_vite-0.8.1.dist-info/RECORD,,

litestar_vite-0.8.0.dist-info/RECORD

@@ -1,4 +0,0 @@
-litestar_vite-0.8.0.dist-info/METADATA,sha256=7e0Rva5F72k6HPx_TLg7zhAfNTkHZJVPIz56Gkq1kJ0,6022
-litestar_vite-0.8.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-litestar_vite-0.8.0.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
-litestar_vite-0.8.0.dist-info/RECORD,,