PyPI - litestar-vite - Versions diffs - 0.1.7__tar.gz → 0.1.9__tar.gz - Mend

litestar-vite 0.1.7tar.gz → 0.1.9tar.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 (71) hide show

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: litestar-vite
-Version: 0.1.7
+Version: 0.1.9
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j
@@ -55,7 +55,7 @@ from __future__ import annotations
 from pathlib import Path
-from litestar import Controller, get
+from litestar import Controller, get, Litestar
 from litestar.response import Template
 from litestar.status_codes import HTTP_200_OK
 from litestar_vite import ViteConfig, VitePlugin
@@ -73,9 +73,8 @@ class WebController(Controller):
 vite = VitePlugin(
     config=ViteConfig(
         bundle_dir=Path("./public"),
-        resources_dir=Path("./resources"),
-        assets_dir=Path("./resources/assets"),
-        templates_dir=Path("./templates"),
+        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.
@@ -83,6 +82,7 @@ vite = VitePlugin(
 )
 app = Litestar(plugins=[vite], route_handlers=[WebController])
 ```
 Create a template to serve the application in `./templates/index.html.h2`:
@@ -102,12 +102,16 @@ Create a template to serve the application in `./templates/index.html.h2`:
   <body class="font-sans leading-none text-gray-700 antialiased">
     <div id="app"></div>
-    {{ vite_hmr() }} {{ vite('main.ts') }}
+    {{ vite_hmr() }} {{ vite('resources/main.ts') }}
   </body>
 </html>
 ```
-Initialize the Vite configuration.
+### Template initialization (Optional)
+This is a command to help initialize Vite for your project. This is generally only needed a single time. You may also manually configure Vite and skip this step.
+to initialize a Vite configuration:
 ```shell
 ❯ litestar assets init
@@ -135,10 +139,12 @@ INFO - 2023-12-11 12:33:41,456 - root - commands - Writing tsconfig.json
         └── assets
 ```
-### Development
+### Install Javascript/Typescript Packages
 Install the packages required for development:
+**Note** This is equivalent to the the `npm install` by default. This command is configurable.
 ```shell
 ❯ litestar assets install
 Using Litestar app from app:app
@@ -154,6 +160,8 @@ added 25 packages, and audited 26 packages in 1s
 found 0 vulnerabilities
 ```
+### Development
 To automatically start and stop the Vite instance with the Litestar application, you can enable the `use_server_lifespan` hooks in the `ViteConfig`.
 Alternately, to start the development server manually, you can run the following
@@ -173,7 +181,7 @@ vite v5.0.7 building for production...
 ```
-**Note** This is equivalent to the the `npm run dev` command by default.
+**Note** This is equivalent to the the `npm run dev` command when `hot_reload` is enabled. Otherwise it is equivalent to `npm run build --watch`. This command is configurable.
 ### Building for Production

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/README.md RENAMED Viewed

@@ -18,7 +18,7 @@ from __future__ import annotations
 from pathlib import Path
-from litestar import Controller, get
+from litestar import Controller, get, Litestar
 from litestar.response import Template
 from litestar.status_codes import HTTP_200_OK
 from litestar_vite import ViteConfig, VitePlugin
@@ -36,9 +36,8 @@ class WebController(Controller):
 vite = VitePlugin(
     config=ViteConfig(
         bundle_dir=Path("./public"),
-        resources_dir=Path("./resources"),
-        assets_dir=Path("./resources/assets"),
-        templates_dir=Path("./templates"),
+        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.
@@ -46,6 +45,7 @@ vite = VitePlugin(
 )
 app = Litestar(plugins=[vite], route_handlers=[WebController])
 ```
 Create a template to serve the application in `./templates/index.html.h2`:
@@ -65,12 +65,16 @@ Create a template to serve the application in `./templates/index.html.h2`:
   <body class="font-sans leading-none text-gray-700 antialiased">
     <div id="app"></div>
-    {{ vite_hmr() }} {{ vite('main.ts') }}
+    {{ vite_hmr() }} {{ vite('resources/main.ts') }}
   </body>
 </html>
 ```
-Initialize the Vite configuration.
+### Template initialization (Optional)
+This is a command to help initialize Vite for your project. This is generally only needed a single time. You may also manually configure Vite and skip this step.
+to initialize a Vite configuration:
 ```shell
 ❯ litestar assets init
@@ -98,10 +102,12 @@ INFO - 2023-12-11 12:33:41,456 - root - commands - Writing tsconfig.json
         └── assets
 ```
-### Development
+### Install Javascript/Typescript Packages
 Install the packages required for development:
+**Note** This is equivalent to the the `npm install` by default. This command is configurable.
 ```shell
 ❯ litestar assets install
 Using Litestar app from app:app
@@ -117,6 +123,8 @@ added 25 packages, and audited 26 packages in 1s
 found 0 vulnerabilities
 ```
+### Development
 To automatically start and stop the Vite instance with the Litestar application, you can enable the `use_server_lifespan` hooks in the `ViteConfig`.
 Alternately, to start the development server manually, you can run the following
@@ -136,7 +144,7 @@ vite v5.0.7 building for production...
 ```
-**Note** This is equivalent to the the `npm run dev` command by default.
+**Note** This is equivalent to the the `npm run dev` command when `hot_reload` is enabled. Otherwise it is equivalent to `npm run build --watch`. This command is configurable.
 ### Building for Production

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/examples/htmx/app.py RENAMED Viewed

@@ -12,8 +12,7 @@ vite = VitePlugin(
     config=ViteConfig(
         bundle_dir=Path(here / "web" / "public"),
         resource_dir=Path(here / "web" / "resources"),
-        assets_dir=Path(here / "web" / "resources" / "assets"),
-        templates_dir=Path(here / "web" / "templates"),
+        template_dir=Path(here / "web" / "templates"),
         hot_reload=True,
     ),
 )

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/examples/react/app.py RENAMED Viewed

@@ -12,8 +12,7 @@ vite = VitePlugin(
     config=ViteConfig(
         bundle_dir=Path(here / "web" / "public"),
         resource_dir=Path(here / "web" / "resources"),
-        assets_dir=Path(here / "web" / "resources" / "assets"),
-        templates_dir=Path(here / "web" / "templates"),
+        template_dir=Path(here / "web" / "templates"),
         hot_reload=True,
     ),
 )

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/examples/vue/app.py RENAMED Viewed

@@ -13,8 +13,7 @@ vite = VitePlugin(
     config=ViteConfig(
         bundle_dir=Path(here / "web" / "public"),
         resource_dir=Path(here / "web" / "resources"),
-        assets_dir=Path(here / "web" / "resources" / "assets"),
-        templates_dir=Path(here / "web" / "templates"),
+        template_dir=Path(here / "web" / "templates"),
         hot_reload=True,
         port=3006,
     ),

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/litestar_vite/cli.py RENAMED Viewed

@@ -38,13 +38,6 @@ def vite_group() -> None:
     default=None,
     required=False,
 )
-@option(
-    "--asset-path",
-    type=ClickPath(dir_okay=True, file_okay=False, path_type=Path),
-    help="The path to your Javascript/Typescript source and associated assets.  If this were a standalone Vue or React app, this would point to your `src/` folder.",
-    default=None,
-    required=False,
-)
 @option("--asset-url", type=str, help="Base url to serve assets from.", default=None, required=False)
 @option(
     "--vite-port",
@@ -78,7 +71,6 @@ def vite_init(
     vite_port: int | None,
     enable_ssr: bool | None,
     asset_url: str | None,
-    asset_path: Path | None,
     bundle_path: Path | None,
     resource_path: Path | None,
     overwrite: bool,
@@ -103,15 +95,14 @@ def vite_init(
     config = plugin._config  # noqa: SLF001
     console.rule("[yellow]Initializing Vite[/]", align="left")
-    resource_path = resource_path or config.resource_dir
-    asset_path = asset_path or config.assets_dir
-    bundle_path = bundle_path or config.bundle_dir
+    resource_path = Path(resource_path or config.resource_dir)
+    bundle_path = Path(bundle_path or config.bundle_dir)
     enable_ssr = enable_ssr or config.ssr_enabled
     asset_url = asset_url or config.asset_url
     vite_port = vite_port or config.port
     hot_file = Path(bundle_path / config.hot_file)
     root_path = resource_path.parent
-    if any(output_path.exists() for output_path in (asset_path, bundle_path, resource_path)) and not any(
+    if any(output_path.exists() for output_path in (bundle_path, resource_path)) and not any(
         [overwrite, no_prompt],
     ):
         confirm_overwrite = Confirm.ask(
@@ -120,7 +111,7 @@ def vite_init(
         if not confirm_overwrite:
             console.print("Skipping Vite initialization")
             sys.exit(2)
-    for output_path in (asset_path, bundle_path, resource_path):
+    for output_path in (bundle_path, resource_path):
         output_path.mkdir(parents=True, exist_ok=True)
     enable_ssr = (
         True
@@ -138,7 +129,6 @@ def vite_init(
         vite_port=vite_port,
         asset_url=asset_url,
         resource_path=resource_path,
-        asset_path=asset_path,
         bundle_path=bundle_path,
         hot_file=hot_file,
         litestar_port=env.port or 8000,
@@ -163,7 +153,7 @@ def vite_install(app: Litestar, verbose: bool) -> None:
         app.debug = True
     console.rule("[yellow]Starting Vite package installation process[/]", align="left")
     plugin = app.plugins.get(VitePlugin)
-    run_vite(" ".join(plugin._config.install_command))  # noqa: SLF001
+    run_vite(" ".join(plugin._config.install_command), app)  # noqa: SLF001
 @vite_group.command(  # type: ignore # noqa: PGH003
@@ -184,7 +174,7 @@ def vite_build(app: Litestar, verbose: bool) -> None:
         app.debug = True
     console.rule("[yellow]Starting Vite build process[/]", align="left")
     plugin = app.plugins.get(VitePlugin)
-    run_vite(" ".join(plugin._config.build_command))  # noqa: SLF001
+    run_vite(" ".join(plugin._config.build_command), app)  # noqa: SLF001
 @vite_group.command(  # type: ignore # noqa: PGH003
@@ -212,4 +202,4 @@ def vite_serve(app: Litestar, verbose: bool) -> None:
     command_to_run = (
         plugin._config.run_command if plugin._config.hot_reload else plugin._config.build_watch_command  # noqa: SLF001
     )
-    run_vite(" ".join(command_to_run))
+    run_vite(" ".join(command_to_run), app)

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/litestar_vite/commands.py RENAMED Viewed

@@ -4,10 +4,12 @@ import contextlib
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, MutableMapping
+from anyio import create_task_group
 from jinja2 import select_autoescape
 from litestar.serialization import encode_json
 if TYPE_CHECKING:
+    from anyio.abc import Process
     from jinja2 import Environment, Template
     from litestar import Litestar
@@ -40,7 +42,6 @@ def init_vite(
     app: Litestar,
     root_path: Path,
     resource_path: Path,
-    asset_path: Path,
     asset_url: str,
     bundle_path: Path,
     enable_ssr: bool,
@@ -75,10 +76,9 @@ def init_vite(
                     entry_point=entry_point,
                     enable_ssr=enable_ssr,
                     asset_url=asset_url,
-                    root_path=str(root_path.relative_to(Path.cwd())),
+                    root_path=str(root_path),
                     resource_path=str(resource_path.relative_to(root_path)),
                     bundle_path=str(bundle_path.relative_to(root_path)),
-                    asset_path=str(asset_path.relative_to(root_path)),
                     hot_file=str(hot_file.relative_to(root_path)),
                     vite_port=str(vite_port),
                     litestar_port=litestar_port,
@@ -97,22 +97,31 @@ def get_template(
     return environment.get_template(name=name, parent=parent, globals=globals)
-def run_vite(command_to_run: str) -> None:
+def run_vite(command_to_run: str, app: Litestar) -> None:
     """Run Vite in a subprocess."""
     import anyio
     with contextlib.suppress(KeyboardInterrupt):
-        anyio.run(_run_vite, command_to_run)
+        anyio.run(_run_vite, command_to_run, app)
-async def _run_vite(command_to_run: str) -> None:
+async def _run_vite(command_to_run: str, app: Litestar) -> None:
     """Run Vite in a subprocess."""
     from anyio import open_process
     from anyio.streams.text import TextReceiveStream
-    from litestar.cli._utils import console
-    async with await open_process(command_to_run) as vite_process:
-        async for text in TextReceiveStream(vite_process.stdout):  # type: ignore[arg-type]
-            console.print(text)
+    logger = app.get_logger("vite")
+    async def read_stdout(vite_process: Process) -> None:
+        async for stdout in TextReceiveStream(vite_process.stdout):  # type: ignore[arg-type]
+            logger.info(stdout.replace("\n", ""))
+    async def read_stderr(vite_process: Process) -> None:
+        async for stdout in TextReceiveStream(vite_process.stderr):  # type: ignore[arg-type]
+            logger.warning(stdout.replace("\n", ""))
+    async with await open_process(command_to_run) as vite_process, create_task_group() as tg:
+        tg.start_soon(read_stdout, vite_process)
+        tg.start_soon(read_stderr, vite_process)

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/litestar_vite/config.py RENAMED Viewed

@@ -1,8 +1,10 @@
 from __future__ import annotations
+import os
 from dataclasses import dataclass, field
 from functools import cached_property
 from inspect import isclass
+from pathlib import Path
 from typing import TYPE_CHECKING, Generic, TypeVar, cast
 from litestar.exceptions import ImproperlyConfiguredException
@@ -13,7 +15,6 @@ __all__ = ["ViteConfig", "ViteTemplateConfig"]
 if TYPE_CHECKING:
     from collections.abc import Callable
-    from pathlib import Path
     from litestar.types import PathType
@@ -31,24 +32,17 @@ class ViteConfig:
     'plugins' key.
     """
-    bundle_dir: Path
+    bundle_dir: Path | str = field(default="public")
     """Location of the compiled assets from  Vite.
     The manifest file will also be found here.
     """
-    resource_dir: Path
+    resource_dir: Path | str = field(default="resources")
     """The directory where all typescript/javascript source are written.
     In a standalone Vue or React application, this would be equivalent to the ``./src`` directory.
     """
-    assets_dir: Path
-    """These are the assets that Vite will serve when developing.
-    This should include any images, CSS, or other media referenced.
-    These will be included in the bundle directory on build.
-    """
-    templates_dir: Path
+    template_dir: Path | str = field(default="templates")
     """Location of the Jinja2 template file.
     """
     manifest_name: str = ".vite/manifest.json"
@@ -62,9 +56,9 @@ class ViteConfig:
     """Enable HMR for Vite development server."""
     ssr_enabled: bool = False
     """Enable SSR."""
-    ssr_output_dir: Path | None = None
+    ssr_output_dir: Path | str | None = None
     """SSR Output path"""
-    root_dir: Path | None = None
+    root_dir: Path | str | None = None
     """The is the base path to your application.
    In a standalone Vue or React application, this would be equivalent to the ``./src`` directory.
@@ -85,7 +79,7 @@ class ViteConfig:
     """Default port to use for Vite server."""
     run_command: list[str] = field(default_factory=lambda: ["npm", "run", "dev"])
     """Default command to use for running Vite."""
-    build_watch_command: list[str] = field(default_factory=lambda: ["npm", "run", "build", "--watch"])
+    build_watch_command: list[str] = field(default_factory=lambda: ["npm", "run", "watch"])
     """Default command to use for dev building with Vite."""
     build_command: list[str] = field(default_factory=lambda: ["npm", "run", "build"])
     """Default command to use for building with Vite."""
@@ -96,6 +90,22 @@ class ViteConfig:
     dev_mode: bool = False
     """When True, Vite will run with HMR or watch build"""
+    def __post_init__(self) -> None:
+        """Ensure that directory is set if engine is a class."""
+        if self.root_dir is not None and isinstance(self.root_dir, str):
+            self.root_dir = Path(self.root_dir)
+        if isinstance(self.resource_dir, str):
+            self.resource_dir = Path(self.resource_dir)
+        if isinstance(self.ssr_output_dir, str):
+            self.ssr_output_dir = Path(self.ssr_output_dir)
+        os.environ.setdefault("LITESTAR_ASSET_URL", self.asset_url)
+        os.environ.setdefault("LITESTAR_VITE_ALLOW_REMOTE", str(True))
+        os.environ.setdefault("VITE_PORT", str(self.port))
+        os.environ.setdefault("VITE_HOST", self.host)
+        os.environ.setdefault("VITE_PROTOCOL", self.protocol)
+        if self.dev_mode:
+            os.environ.setdefault("VITE_DEV_MODE", str(self.dev_mode))
 @dataclass
 class ViteTemplateConfig(Generic[T]):

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/litestar_vite/loader.py RENAMED Viewed

@@ -64,22 +64,22 @@ class ViteAssetLoader:
             RuntimeError: if cannot load the file or JSON in file is malformed.
         """
         if self._config.hot_reload:
-            if _hot_file_found := Path(
-                self._config.bundle_dir / self._config.hot_file,
+            if Path(
+                f"{self._config.bundle_dir}/{self._config.hot_file}",
             ).exists():
-                with Path(self._config.bundle_dir / self._config.hot_file).open() as hot_file:
+                with Path(f"{self._config.bundle_dir}/{self._config.manifest_name}").open() as hot_file:
                     self._vite_base_path = hot_file.read()
         else:
-            with Path(self._config.bundle_dir / self._config.manifest_name).open() as manifest_file:
+            with Path(f"{self._config.bundle_dir}/{self._config.manifest_name}").open() as manifest_file:
                 manifest_content = manifest_file.read()
             try:
                 self._manifest = json.loads(manifest_content)
             except Exception as exc:  # noqa: BLE001
-                msg = "Cannot read Vite manifest file at %s"
+                msg = "Cannot read Vite manifest file at %s. Did you forget to build your assets?"
                 raise RuntimeError(
                     msg,
-                    Path(self._config.bundle_dir / self._config.manifest_name),
+                    Path(f"{self._config.bundle_dir}/{self._config.manifest_name}"),
                 ) from exc
     def generate_ws_client_tags(self) -> str:
@@ -138,11 +138,11 @@ class ViteAssetLoader:
             )
         if any(p for p in path if p not in self._manifest):
-            msg = "Cannot find %s in Vite manifest at %s"
+            msg = "Cannot find %s in Vite manifest at %s.  Did you forget to build your assets?"
             raise RuntimeError(
                 msg,
                 path,
-                Path(self._config.bundle_dir / self._config.manifest_name),
+                Path(f"{self._config.bundle_dir}/{self._config.manifest_name}"),
             )
         tags: list[str] = []

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/litestar_vite/plugin.py RENAMED Viewed

@@ -45,7 +45,7 @@ class VitePlugin(InitPluginProtocol, CLIPlugin):
         app_config.template_config = ViteTemplateConfig(  # type: ignore[assignment]
             engine=ViteTemplateEngine,
             config=self._config,
-            directory=self._config.templates_dir,
+            directory=self._config.template_dir,
         )
         return app_config
@@ -60,7 +60,7 @@ class VitePlugin(InitPluginProtocol, CLIPlugin):
             vite_process = multiprocessing.Process(
                 target=run_vite,
-                args=[command_to_run],
+                args=[command_to_run, app],
             )
             try:
                 vite_process.start()

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/litestar_vite/templates/init/index.html.j2 RENAMED Viewed

@@ -13,6 +13,6 @@
   <body class="font-sans leading-none text-gray-700 antialiased">
     <div id="app"></div>
     {{ vite_hmr() }}
-    {{ vite('main.ts') }}
+    {{ vite('resources/main.ts') }}
   </body>
 </html>

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/litestar_vite/templates/init/package.json.j2 RENAMED Viewed

@@ -3,6 +3,7 @@
     "type": "module",
     "scripts": {
         "dev": "vite",
+        "watch": "vite build --watch",
         "build": "vite build{% if enable_ssr %} && vite build --ssr{% endif %}"
     },
     "dependencies": {{ dependencies }},

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/litestar_vite/templates/init/vite.config.ts.j2 RENAMED Viewed

@@ -3,8 +3,18 @@ import { defineConfig } from "vite";
 {% if include_react %}import vue from "@vitejs/plugin-react";{% endif %}
 import litestar from "litestar-vite-plugin";
+const ASSET_URL =
+  process.env.LITESTAR_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}`,
   root: "{{ root_path }}",
+  server: {
+    host: `${VITE_HOST}`,
+    port: +`${VITE_PORT}`,
+    cors: true,
+  },
   plugins: [
     {% if include_vue %}vue(),{% endif %}
     {% if include_react %}react(),{% endif %}
@@ -12,8 +22,7 @@ export default defineConfig({
       input: [
         {% if entry_point %}"{{ entry_point | join(', \"') }}"{% endif %}
       ],
-      assetUrl: "{{ asset_url }}",
-      assetDirectory: "{{ asset_path }}",
+      assetUrl: `${ASSET_URL}`,
       bundleDirectory: "{{ bundle_path }}",
       resourceDirectory: "{{ resource_path }}",
       hotFile: "{{ hot_file }}"

{litestar_vite-0.1.7 → litestar_vite-0.1.9}/pyproject.toml RENAMED Viewed

@@ -33,7 +33,7 @@ license = {text = "MIT"}
 name = "litestar-vite"
 readme = "README.md"
 requires-python = ">=3.8"
-version = "0.1.7"
+version = "0.1.9"
 [project.urls]
 Changelog = "https://cofin.github.io/litestar-vite/latest/changelog"