Merge pull request #160 from akx/named-assets

Support named assets

Author: MrBin99

README.md

@@ -170,6 +170,10 @@ This will add a `<script>` tag including your JS/TS script :
 - The path must be relative to your `root` key inside your ViteJS config file.
 - The path must be a key inside your manifest file `manifest.json` file
   generated by ViteJS.
+  - Alternatively, the path can be an asset name (e.g. `"name": "foo"` in your manifest).
+    If you set up multiple entrypoints (`build.rollupOptions.input`) in your Vite config,
+    e.g. by following [the Multi-Page App](https://vite.dev/guide/build.html#multi-page-app)
+    docs, this would be the key in the entrypoint object.
 - In general, this path does not require a `/` at the beginning
   (follow your `manifest.json` file).
 

django_vite/core/asset_loader.py

@@ -61,6 +61,7 @@ class ManifestEntry(NamedTuple):
     """
 
     file: str
+    name: Optional[str] = None
     src: Optional[str] = None
     isEntry: Optional[bool] = False
     isDynamicEntry: Optional[bool] = False
@@ -185,6 +186,8 @@ def _parse_manifest(self) -> ParsedManifestOutput:
                 }
                 manifest_entry = ManifestEntry(**filtered_manifest_entry_data)
                 entries[path] = manifest_entry
+                if manifest_entry.name:
+                    entries[manifest_entry.name] = manifest_entry
                 if self.legacy_polyfills_motif in path:
                     legacy_polyfills_entry = manifest_entry
 

tests/data/named_assets/dist/assets/one-90jdqqZN.js

@@ -0,0 +1 @@
+globalThis.sayOne=()=>"one";

tests/data/named_assets/dist/manifest.json

@@ -0,0 +1,8 @@
+{
+  "one.js": {
+    "file": "assets/one-90jdqqZN.js",
+    "name": "one",
+    "src": "one.js",
+    "isEntry": true
+  }
+}

tests/data/named_assets/one.js

@@ -0,0 +1 @@
+globalThis.sayOne = () => 'one';

tests/data/named_assets/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "named_assets",
+  "description": "Example that generates a manifest with named assets",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "devDependencies": {
+    "vite": "^6.2.0"
+  }
+}

tests/data/named_assets/vite.config.js

@@ -0,0 +1,12 @@
+import path from 'node:path';
+
+export default {
+  build: {
+    manifest: 'manifest.json',
+    rollupOptions: {
+      input: {
+        'one': path.resolve('./one.js'),
+      },
+    },
+  },
+};

tests/tests/test_asset_loader.py

@@ -156,3 +156,33 @@ def test_parse_manifest_during_dev_mode(dev_mode_true):
 def test_load_dynamic_import_manifest(patch_settings):
     warnings = check_loader_instance()
     assert len(warnings) == 0
+
+
+@pytest.mark.parametrize(
+    "patch_settings",
+    [
+        {
+            "DJANGO_VITE": {
+                "default": {
+                    "dev_mode": False,
+                    "manifest_path": Path(settings.STATIC_ROOT).parent
+                    / "named_assets"
+                    / "dist"
+                    / "manifest.json",
+                },
+            },
+        },
+    ],
+    indirect=True,
+)
+def test_named_assets(patch_settings):
+    """
+    Test that assets can be loaded via name.
+    """
+    warnings = check_loader_instance()
+    assert len(warnings) == 0
+    loader = DjangoViteAssetLoader.instance()
+    by_name = loader.generate_vite_asset("one")
+    by_src = loader.generate_vite_asset("one.js")
+    assert "<script" in by_name
+    assert by_src == by_name