@onedarnleyroad/vite-plugin-svg-sprite 2.0.0-beta.0 → 2.0.0-beta.1

package/README.md

@@ -82,28 +82,28 @@ Each SVG becomes a `<symbol>` with `id="svg-{filename}"`. For example, `arrow.sv
 
 ### With Vite manifest (recommended)
 
-With `build.manifest: true` enabled, each sprite is registered in `manifest.json` keyed by its logical name:
+With `build.manifest: true` enabled, each sprite is registered in `manifest.json` keyed by its `inputDir`-relative path:
 
 ```json
 {
-  "sprite.svg":       { "file": "assets/sprite-DAskUDYW.svg",       "src": "sprite.svg",       "isEntry": false },
-  "sprite-light.svg": { "file": "assets/sprite-light-xV7q1sYy.svg", "src": "sprite-light.svg", "isEntry": false }
+  "src/icons/sprite.svg":       { "file": "assets/sprite-DAskUDYW.svg",       "src": "src/icons/sprite.svg",       "isEntry": false },
+  "src/icons/sprite-light.svg": { "file": "assets/sprite-light-xV7q1sYy.svg", "src": "src/icons/sprite-light.svg", "isEntry": false }
 }
 ```
 
-With Craft CMS + [nystudio107/craft-vite](https://nystudio107.com/docs/vite/):
+With Craft CMS + [nystudio107/craft-vite](https://nystudio107.com/docs/vite/), use `craft.vite.asset()` — **not `entry()`**. The `asset()` helper is dev-server-aware; `entry()` always reads the manifest, so in dev it would serve stale built files:
 
 ```twig
 <svg aria-hidden="true">
-  <use href="{{ craft.vite.entry('sprite.svg') }}#svg-arrow"></use>
+  <use href="{{ craft.vite.asset('src/icons/sprite.svg') }}#svg-arrow"></use>
 </svg>
 
 <svg aria-hidden="true">
-  <use href="{{ craft.vite.entry('sprite-light.svg') }}#svg-sun"></use>
+  <use href="{{ craft.vite.asset('src/icons/sprite-light.svg') }}#svg-sun"></use>
 </svg>
 ```
 
-In dev mode, `craft.vite.entry('sprite.svg')` returns the raw path (`/sprite.svg`), which the plugin's dev middleware serves. In production it returns the hashed path from the manifest.
+In dev, `asset()` returns the Vite dev-server URL (e.g. `https://…:3000/src/icons/sprite.svg`), which the plugin's in-memory middleware serves. In production it returns the hashed URL from the manifest.
 
 ### Without manifest
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onedarnleyroad/vite-plugin-svg-sprite",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.1",
   "description": "Vite plugin that builds an SVG sprite sheet from a directory of SVG files",
   "type": "module",
   "exports": {

package/src/index.js

@@ -98,8 +98,9 @@ export default function svgSpritePlugin(options = {}) {
                 const source = buildSpriteSvg(group.dir, group.files)
                 const base = group.logicalName.replace(/\.svg$/, '')
                 const hashedFileName = join(outputDir, `${base}-${hashContent(source)}.svg`)
+                const key = join(inputDir, group.logicalName)
                 this.emitFile({ type: 'asset', fileName: hashedFileName, source })
-                emitted.push({ logicalName: group.logicalName, fileName: hashedFileName })
+                emitted.push({ key, fileName: hashedFileName })
             }
         },
 
@@ -114,10 +115,10 @@ export default function svgSpritePlugin(options = {}) {
 
             const manifest = JSON.parse(readFileSync(manifestPath, 'utf-8'))
 
-            for (const { logicalName, fileName } of emitted) {
-                manifest[logicalName] = {
+            for (const { key, fileName } of emitted) {
+                manifest[key] = {
                     file: fileName,
-                    src: logicalName,
+                    src: key,
                     isEntry: false,
                 }
             }
@@ -131,7 +132,8 @@ export default function svgSpritePlugin(options = {}) {
             const rebuild = () => {
                 sprites.clear()
                 for (const group of collectSpriteGroups(inputDir, prefix)) {
-                    sprites.set(group.logicalName, buildSpriteSvg(group.dir, group.files))
+                    const key = join(inputDir, group.logicalName)
+                    sprites.set(key, buildSpriteSvg(group.dir, group.files))
                 }
             }
             rebuild()