litestar-vite 0.1.20__py3-none-any.whl → 0.1.22__py3-none-any.whl

litestar_vite/cli.py

@@ -144,6 +144,8 @@ def vite_init(
             console.print("Skipping Vite initialization")
             sys.exit(2)
     for output_path in (bundle_path, resource_path, root_path):
+        if output_path.exists():
+            console.print(f" * Creating {output_path!s}")
         output_path.mkdir(parents=True, exist_ok=True)
 
     enable_ssr = (

litestar_vite/commands.py

@@ -5,16 +5,12 @@ import subprocess
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, MutableMapping
 
-from jinja2 import select_autoescape
-from litestar.serialization import encode_json
-
 if TYPE_CHECKING:
     from jinja2 import Environment, Template
     from litestar import Litestar
 
-VITE_INIT_TEMPLATES_PATH = f"{Path(__file__).parent}/templates"
 VITE_INIT_TEMPLATES: set[str] = {"package.json.j2", "tsconfig.json.j2", "vite.config.ts.j2"}
-DEFAULT_RESOURCES: set[str] = {"styles.css", "main.ts"}
+DEFAULT_RESOURCES: set[str] = {"styles.css.j2", "main.ts.j2"}
 DEFAULT_DEV_DEPENDENCIES: dict[str, str] = {
     "typescript": "^5.3.3",
     "vite": "^5.0.6",
@@ -33,6 +29,8 @@ def to_json(value: Any) -> str:
     Returns:
         JSON string.
     """
+    from litestar.serialization import encode_json
+
     return encode_json(value).decode("utf-8")
 
 
@@ -49,12 +47,13 @@ def init_vite(
     litestar_port: int,
 ) -> None:
     """Initialize a new vite project."""
-    from jinja2 import Environment, FileSystemLoader
+    from jinja2 import Environment, FileSystemLoader, select_autoescape
     from litestar.cli._utils import console
+    from litestar.utils import module_loader
 
-    entry_point: list[str] = []
+    template_path = module_loader.module_to_os_path("litestar_vite.templates")
     vite_template_env = Environment(
-        loader=FileSystemLoader([VITE_INIT_TEMPLATES_PATH]),
+        loader=FileSystemLoader([template_path]),
         autoescape=select_autoescape(),
     )
 
@@ -66,25 +65,23 @@ def init_vite(
         template_name: get_template(environment=vite_template_env, name=template_name)
         for template_name in enabled_templates
     }
-    entry_point = [
-        str(Path(resource_path / resource_name).relative_to(Path.cwd().absolute()))
-        for resource_name in enabled_resources
-    ]
     for template_name, template in templates.items():
         target_file_name = template_name.removesuffix(".j2")
         with Path(target_file_name).open(mode="w") as file:
-            console.print(f" * Writing {target_file_name} to {Path(target_file_name).absolute()}")
+            console.print(f" * Writing {target_file_name} to {Path(target_file_name)!s}")
 
             file.write(
                 template.render(
-                    entry_point=entry_point,
+                    entry_point=[
+                        f"{resource_path!s}/{resource_name.removesuffix('.j2')}" for resource_name in enabled_resources
+                    ],
                     enable_ssr=enable_ssr,
                     asset_url=asset_url,
-                    root_path=str(root_path.relative_to(Path.cwd().absolute())),
+                    root_path=root_path,
                     resource_path=str(resource_path.relative_to(root_path)),
                     public_path=str(public_path.relative_to(root_path)),
                     bundle_path=str(bundle_path.relative_to(root_path)),
-                    hot_file=str(hot_file.relative_to(Path.cwd().absolute())),
+                    hot_file=str(hot_file.relative_to(root_path)),
                     vite_port=str(vite_port),
                     litestar_port=litestar_port,
                     dependencies=to_json(dependencies),
@@ -93,8 +90,11 @@ def init_vite(
             )
 
     for resource_name in enabled_resources:
-        with Path(resource_path / resource_name).open(mode="w") as file:
-            console.print(f" * Writing {resource_name} to {Path(resource_path / resource_name).absolute()}")
+        template = get_template(environment=vite_template_env, name=resource_name)
+        target_file_name = f"{resource_path}/{resource_name.removesuffix('.j2')}"
+        with Path(target_file_name).open(mode="w") as file:
+            console.print(f" * Writing {resource_name.removesuffix('.j2')} to {Path(target_file_name)!s}")
+            file.write(template.render())
     console.print("[yellow]Vite initialization completed.[/]")
 
 

litestar_vite/config.py

@@ -18,9 +18,8 @@ if TYPE_CHECKING:
 
     from litestar.types import PathType
 
-    from litestar_vite.template_engine import ViteTemplateEngine
 
-T = TypeVar("T", bound=TemplateEngineProtocol)
+EngineType = TypeVar("EngineType", bound=TemplateEngineProtocol)
 
 
 @dataclass
@@ -127,7 +126,7 @@ class ViteConfig:
 
 
 @dataclass
-class ViteTemplateConfig(Generic[T]):
+class ViteTemplateConfig(Generic[EngineType]):
     """Configuration for Templating.
 
     To enable templating, pass an instance of this class to the
@@ -135,27 +134,30 @@ class ViteTemplateConfig(Generic[T]):
     'template_config' key.
     """
 
-    engine: type[ViteTemplateEngine]
-    """A template engine adhering to the :class:`TemplateEngineProtocol
-    <litestar.template.base.TemplateEngineProtocol>`."""
     config: ViteConfig
     """A a config for the vite engine`."""
-    directory: PathType | None = field(default=None)
+    engine: type[EngineType] | EngineType | None = field(default=None)
+    """A template engine adhering to the :class:`TemplateEngineProtocol
+    <litestar.template.base.TemplateEngineProtocol>`."""
+    directory: PathType | list[PathType] | None = field(default=None)
     """A directory or list of directories from which to serve templates."""
-    engine_callback: Callable[[T], None] | None = field(default=None)
+    engine_callback: Callable[[EngineType], None] | None = field(default=None)
     """A callback function that allows modifying the instantiated templating
     protocol."""
 
+    instance: EngineType | None = field(default=None)
+    """An instance of the templating protocol."""
+
     def __post_init__(self) -> None:
         """Ensure that directory is set if engine is a class."""
         if isclass(self.engine) and not self.directory:
             msg = "directory is a required kwarg when passing a template engine class"
             raise ImproperlyConfiguredException(msg)
 
-    def to_engine(self) -> T:
+    def to_engine(self) -> EngineType:
         """Instantiate the template engine."""
         template_engine = cast(
-            "T",
+            "EngineType",
             self.engine(directory=self.directory, config=self.config) if isclass(self.engine) else self.engine,
         )
         if callable(self.engine_callback):
@@ -163,6 +165,6 @@ class ViteTemplateConfig(Generic[T]):
         return template_engine
 
     @cached_property
-    def engine_instance(self) -> T:
+    def engine_instance(self) -> EngineType:
         """Return the template engine instance."""
         return self.to_engine()

litestar_vite/loader.py

@@ -5,7 +5,6 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Any, ClassVar, TypeVar
 from urllib.parse import urljoin
 
-from litestar.cli._utils import console
 from litestar.template import TemplateEngineProtocol
 
 if TYPE_CHECKING:
@@ -65,27 +64,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 = {}
+                if manifest_path.exists():
+                    with manifest_path.open() as manifest_file:
+                        manifest_content = manifest_file.read()
+                        self._manifest = json.loads(manifest_content)
+                else:
+                    self._manifest = {}
             except Exception as exc:  # noqa: BLE001
                 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:

litestar_vite/plugin.py

@@ -8,13 +8,13 @@ from typing import TYPE_CHECKING, Iterator, cast
 from litestar.plugins import CLIPlugin, InitPluginProtocol
 from litestar.static_files import create_static_files_router
 
+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
-
 
 def set_environment(config: ViteConfig) -> None:
     """Configure environment for easier integration"""
@@ -32,12 +32,14 @@ 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
@@ -60,11 +62,12 @@ class VitePlugin(InitPluginProtocol, CLIPlugin):
         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 = ViteTemplateConfig[ViteTemplateEngine](  # type: ignore[assignment]
+                engine=ViteTemplateEngine,
+                config=self._config,
+                directory=self._config.template_dir,
+            )
 
         if self._config.set_static_folders:
             static_dirs = [Path(self._config.bundle_dir), Path(self._config.resource_dir)]
@@ -116,4 +119,9 @@ class VitePlugin(InitPluginProtocol, CLIPlugin):
                 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/templates/main.ts.j2

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

{litestar_vite-0.1.20.dist-info → litestar_vite-0.1.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: litestar-vite
-Version: 0.1.20
+Version: 0.1.22
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j
@@ -30,7 +30,7 @@ Classifier: Topic :: Database :: Database Engines/Servers
 Classifier: Topic :: Software Development
 Classifier: Typing :: Typed
 Requires-Python: >=3.8
-Requires-Dist: litestar[cli,jinja]>=2.4.0
+Requires-Dist: litestar[jinja]>=2.4.0
 Provides-Extra: nodeenv
 Requires-Dist: nodeenv; extra == 'nodeenv'
 Description-Content-Type: text/markdown

litestar_vite-0.1.22.dist-info/RECORD

@@ -0,0 +1,20 @@
+litestar_vite/__init__.py,sha256=9X3i67Q8DJN2lQYAMa9NSPTZGzHASGn8X8yeWJqBvWg,357
+litestar_vite/__metadata__.py,sha256=Eml1c9xezV-GSodmysksrT8jPWqE__x0ENO1wM5g6q0,319
+litestar_vite/cli.py,sha256=BsYvMPcE8rFZGO8xnEwEXtrXhILgizN3JDVO_KH_FE8,9618
+litestar_vite/commands.py,sha256=S2oY1z1IMFPG58qD5FzDF4hjZvoKycj3Hl9XeSw3_hM,4236
+litestar_vite/config.py,sha256=uBbdV0INcChMOoGzVf60baovtuwkUkqkbVhwTFFw804,6978
+litestar_vite/loader.py,sha256=cxDwrViZJR2F7H6OTkZLwQhG0uw9VadUh-vxc91tJZs,7481
+litestar_vite/plugin.py,sha256=pw9ianec85DdXWnBFvhcZp7Ag4lu-3MIVP8mFzOFOg8,4843
+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.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.1.22.dist-info/METADATA,sha256=aSQ7qnkNkw39YYPUf2vaNRqjowtw2ub6IzmfT_ZohNs,6437
+litestar_vite-0.1.22.dist-info/WHEEL,sha256=bq9SyP5NxIRA9EpQgMCd-9RmPHWvbH-4lTDGwxgIR64,87
+litestar_vite-0.1.22.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
+litestar_vite-0.1.22.dist-info/RECORD,,

{litestar_vite-0.1.20.dist-info → litestar_vite-0.1.22.dist-info}/WHEEL

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

litestar_vite-0.1.20.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=jLwnIenDUzyGYmufdsRn3weU1q08vuI4obQx-sUOxzg,4121
-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.20.dist-info/METADATA,sha256=k-JRBSUUxCrReb8BQQCJwfRUPeFyZIf6OjsHdoJE3QI,6441
-litestar_vite-0.1.20.dist-info/WHEEL,sha256=LL0B1KxSLwaTWceo7tT-0aDLd-qq9dmbnsnk1DnXlg8,87
-litestar_vite-0.1.20.dist-info/licenses/LICENSE,sha256=HeTiEfEgvroUXZe_xAmYHxtTBgw--mbXyZLsWDYabHc,1069
-litestar_vite-0.1.20.dist-info/RECORD,,