@transclude/core 0.4.0 → 0.5.0

package/bin/build.js

@@ -22,7 +22,7 @@ import { includeContext } from '../src/include.js';
 import { nodeLookup } from '../src/lookup.js';
 import { sitemap } from '../src/sitemap.js';
 import { etagOf, loadAssets, loadStatic } from '../src/static-cache.js';
-import { buildSprite, readIcons, refuseSpriteClash, SPRITE_PATH } from '../src/icons.js';
+import { buildSprite, readLibraries, refuseSpriteClash, spritePath } from '../src/icons.js';
 import { PRECACHE_PATH, precacheDocument, precacheList } from '../src/precache.js';
 import { cookiesOf } from '../src/cookies.js';
 import { pool } from '../src/pool.js';
@@ -356,20 +356,29 @@ function countFiles(dir) {
 // It is not counted as a public file, because the author did not write it.
 //
 // An icon named for a file the author can see is worth a stop: `buildSprite`
-// throws on a missing viewBox or two files claiming one name, and the build ends
-// there rather than shipping icons that render wrong.
+// throws on a missing viewBox, and the build ends there rather than shipping
+// icons that render wrong.
+//
+// One file per library. A downloaded icon set is a directory here, so the count
+// this reports is two numbers: an icon total says nothing about how much any one
+// page fetches, and the sheets are what a page fetches.
 
 const iconsSrc = config.iconsDir ? path.join(root, config.appDir, config.iconsDir) : null;
 let iconCount = 0;
+let libraryCount = 0;
 
 if (iconsSrc) {
-  const icons = readIcons(iconsSrc, root);
-  if (icons.length) {
-    refuseSpriteClash(publicSrc);
-    fs.mkdirSync(publicOut, { recursive: true });
-    fs.writeFileSync(path.join(publicOut, path.basename(SPRITE_PATH)), buildSprite(icons));
-    iconCount = icons.length;
+  const libraries = readLibraries(iconsSrc, root);
+  refuseSpriteClash(publicSrc, libraries);
+
+  if (libraries.length) fs.mkdirSync(publicOut, { recursive: true });
+
+  for (const { name, icons } of libraries) {
+    const file = path.join(publicOut, path.basename(spritePath(name)));
+    fs.writeFileSync(file, buildSprite(icons));
+    iconCount += icons.length;
   }
+  libraryCount = libraries.length;
 }
 
 // ---- assets, for runtimes with no filesystem ------------------------------
@@ -495,7 +504,12 @@ const summary = [
   `${dynamic.length} route${dynamic.length === 1 ? '' : 's'} left to the server`,
   `${assets.size} client entr${assets.size === 1 ? 'y' : 'ies'}`,
   ...(publicFiles ? [`${publicFiles} public file${publicFiles === 1 ? '' : 's'}`] : []),
-  ...(iconCount ? [`${iconCount} icon${iconCount === 1 ? '' : 's'}`] : []),
+  ...(iconCount
+    ? [
+        `${iconCount} icon${iconCount === 1 ? '' : 's'} in ` +
+          `${libraryCount} sheet${libraryCount === 1 ? '' : 's'}`,
+      ]
+    : []),
 ];
 console.log(`\n${summary.join(', ')}`);
 for (const url of prerendered) console.log(`  ${url}`);

package/bin/dev.js

@@ -7,7 +7,7 @@ import http from 'node:http';
 import path from 'node:path';
 import { getRequestListener } from '@hono/node-server';
 import { publicFiles as publicHandler } from '../src/public-files.js';
-import { buildSprite, readIcons, refuseSpriteClash, SPRITE_PATH } from '../src/icons.js';
+import { buildSprite, readLibraries, refuseSpriteClash } from '../src/icons.js';
 import { createServer as createViteServer } from 'vite';
 import {
   ACTION_METHODS,
@@ -66,18 +66,36 @@ const publicFiles =
 const iconsRoot = config.iconsDir ? path.join(root, config.appDir, config.iconsDir) : null;
 
 /**
- * The sprite the build writes, built per request instead.
+ * One library's sprite, built per request rather than read off disk.
  *
  * Reading a directory of small files on every request is what the rest of dev
  * already does, and it is what makes adding an icon show up on reload. A refusal
- * from `buildSprite` is returned as text rather than thrown, so a missing
- * viewBox reads the same here as the message that would stop the build.
+ * is returned as text rather than thrown, so a missing viewBox reads the same
+ * here as the message that would stop the build.
+ *
+ * A name no library answers to is a 404, not an empty sprite. `/lucdie.svg` is a
+ * typo, and a blank icon is a worse way to find that out than a missing file.
  */
-function sprite() {
+function sprite(name) {
   try {
-    const icons = readIcons(iconsRoot, root);
-    refuseSpriteClash(publicRoot);
-    return { status: 200, type: 'image/svg+xml; charset=utf-8', body: buildSprite(icons) };
+    const libraries = readLibraries(iconsRoot, root);
+    refuseSpriteClash(publicRoot, libraries);
+
+    const library = libraries.find((entry) => entry.name === name);
+    if (!library) {
+      const known = libraries.map((entry) => entry.name).join(', ') || 'none';
+      return {
+        status: 404,
+        type: 'text/plain; charset=utf-8',
+        body: `no icon library "${name}". There is: ${known}`,
+      };
+    }
+
+    return {
+      status: 200,
+      type: 'image/svg+xml; charset=utf-8',
+      body: buildSprite(library.icons),
+    };
   } catch (error) {
     return { status: 500, type: 'text/plain; charset=utf-8', body: error.message };
   }
@@ -284,8 +302,12 @@ async function buildApp() {
   // A public file at this URL is refused rather than raced, so registering after
   // `baseApp` costs nothing: the public handler can only fall through to here.
   if (iconsRoot) {
-    app.get(SPRITE_PATH, (c) => {
-      const { status, type, body } = sprite();
+    // Any `/name.svg` at the root, because a library is named by a directory the
+    // author made and dev has no list of them until it reads the disk. The public
+    // handler ran first, so an .svg the author wrote still wins.
+    app.get('/:file{[^/]+\\.svg}', (c) => {
+      const name = c.req.param('file').slice(0, -'.svg'.length);
+      const { status, type, body } = sprite(name);
       return c.body(body, status, { 'content-type': type });
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transclude/core",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "An HTML-first server framework. A page is an .html file, the directory tree is the route table, and any fragment of a page is a URL of its own. Runs on Node, Bun, Deno and workerd, and ships no client JavaScript by default.",
   "keywords": [
     "html",

package/skills/transclude/SKILL.md

@@ -37,8 +37,11 @@ app/
     api/_shared.js # not a route, the _ prefix says so
   elements/        # every custom element, one file each
     note-card.html # <note-card>, the name needs a dash
+    svg-icon.html  # scaffolded by npm create, yours to edit
   icons/           # one SVG file per icon, compiled to /icons.svg
     check.svg      # <use href="/icons.svg#check">
+    lucide/        # a subdirectory is a library: /lucide.svg
+      check.svg    # <use href="/lucide.svg#check">
   public/          # copied to the site root as-is
 transclude.config.js
 ```
@@ -168,8 +171,23 @@ shows. The file name is the id.
 <svg width="16" height="16"><use href="/icons.svg#check"></use></svg>
 ```
 
-Every icon file needs a `viewBox`, and two files cannot share a name. The build
-refuses either rather than shipping an icon that renders wrong.
+A subdirectory is a library of its own, served under its name. Put a downloaded
+icon set in whole and reference it by library and name:
+
+```html
+<svg width="16" height="16"><use href="/lucide.svg#check"></use></svg>
+```
+
+Every icon file needs a `viewBox`. A library is one flat directory, so a
+directory inside one is refused. Two libraries may each have a `check`.
+
+A new project has `app/elements/svg-icon.html`, which wraps the `<use>` and gets
+the two aria spellings right. It is the project's file, not the framework's.
+
+```html
+<svg-icon name="check"></svg-icon>
+<svg-icon library="lucide" name="check" label="Mark as done"></svg-icon>
+```
 
 Most apps wrap this in a light element so a page names an icon instead of a URL.
 See [references/elements.md](references/elements.md).

package/skills/transclude/references/elements.md

@@ -188,13 +188,15 @@ rest of them.
 
 ## An icon element
 
-The framework compiles `app/icons/` into one `/icons.svg` and ships no element
-for it. This is the one most apps write, and it is worth copying rather than
-inventing.
+The framework compiles `app/icons/` into one `/icons.svg` and defines no element
+for it. `npm create @transclude` writes this file into a new project, so it is
+already there and it belongs to the project. Reproduced here for a project that
+predates it, or one that deleted it.
 
 ```html
 <script properties>
   export default {
+    library: 'icons',
     name: '',
     label: '',
   };
@@ -211,10 +213,14 @@ inventing.
   }
 </style>
 
-<svg if="label" role="img" aria-label="${label}"><use href="/icons.svg#${name}"></use></svg>
-<svg else aria-hidden="true"><use href="/icons.svg#${name}"></use></svg>
+<svg if="label" role="img" aria-label="${label}"><use href="/${library}.svg#${name}"></use></svg>
+<svg else aria-hidden="true"><use href="/${library}.svg#${name}"></use></svg>
 ```
 
+`library` is the directory in `app/icons/`, and `icons` is the files loose at the
+top. `<svg-icon library="lucide" name="check">` draws
+`app/icons/lucide/check.svg`.
+
 `<svg-icon name="check">` is decorative and hidden from a screen reader, which is
 right when the icon sits beside its own label. `<svg-icon name="check"
 label="Mark as done">` is announced, which is what a control holding nothing but

package/skills/transclude/references/server.md

@@ -85,7 +85,7 @@ Source is JavaScript with JSDoc. Do not convert it to TypeScript.
 | `appDir` | `'app'` | Where the app lives, relative to the project root. |
 | `routesDir` | `'routes'` | Pages and endpoints. Relative to `appDir`. |
 | `elementsDir` | `'elements'` | Custom elements. Relative to `appDir`. |
-| `iconsDir` | `'icons'` | One SVG file per icon, compiled to `/icons.svg`. Relative to `appDir`. |
+| `iconsDir` | `'icons'` | One SVG file per icon, compiled to `/icons.svg`. A subdirectory is a library at `/<name>.svg`. Relative to `appDir`. |
 | `publicDir` | `'public'` | Copied to the site root as-is. Relative to `appDir`. |
 | `outDir` | `'dist'` | Where the build writes. |
 | `stylesheet` | — | One global stylesheet, relative to the project root. |

package/src/icons.js

@@ -1,18 +1,24 @@
-// A directory of SVG files, as one sprite.
+// A directory of SVG files, as one sprite. A directory of those, as several.
 //
 // An icon stays a file the author manages: `app/icons/check.svg` is a whole SVG
 // document they can open, edit and diff. What a browser wants is the other
 // shape, one file of `<symbol>`s, so `<use href="/icons.svg#check">` costs one
 // cached request however many icons a page shows.
 //
+// A subdirectory is a library, and it is the case people arrive with: an icon
+// set is downloaded as a folder of files, and the way to use it should be to put
+// the folder here. `app/icons/lucide/check.svg` is `/lucide.svg#check`, and
+// nothing was renamed to get there. Loose files at the top are the `icons`
+// library, which is why the default sheet keeps the name it had.
+//
 // Build-time only, like `public-files.js` and outside the portable core: the
 // sprite is bytes on disk by the time any server answers for it. `buildSprite`
 // takes contents rather than a directory anyway, so the half that decides what
 // the markup is can be tested without fixtures.
 //
-// The dev server and the build both call `readIcons` then `buildSprite`. They
-// used to be the same two lines written twice, which is how `/icons.svg` served
-// in production and 404'd in dev.
+// The dev server and the build both call `readLibraries` then `buildSprite`.
+// They used to be the same two lines written twice, which is how `/icons.svg`
+// served in production and 404'd in dev.
 
 import fs from 'node:fs';
 import path from 'node:path';
@@ -20,8 +26,23 @@ import { parse, serializeOuter } from 'parse5';
 
 const SVG_NS = 'http://www.w3.org/2000/svg';
 
-/** Where the sprite is served. Fixed, because `<use href>` is written by hand. */
-export const SPRITE_PATH = '/icons.svg';
+/**
+ * What loose files at the top of `app/icons/` are called.
+ *
+ * It is the name the one sheet already had, so a project that never makes a
+ * subdirectory sees the URL it always saw.
+ */
+export const DEFAULT_LIBRARY = 'icons';
+
+/**
+ * Where a library is served. At the site root, beside the author's public files,
+ * because `<use href>` is written by hand and `/lucide.svg` is what someone
+ * guesses.
+ *
+ * @param {string} library
+ * @returns {string}
+ */
+export const spritePath = (library) => `/${library}.svg`;
 
 /**
  * Root attributes that must not survive into a `<symbol>`.
@@ -122,53 +143,101 @@ export function buildSprite(icons) {
 }
 
 /**
- * Refuses a hand-written public file at the sprite's URL.
+ * Refuses a hand-written public file at a library's URL.
  *
- * Two things would answer for `/icons.svg`, and the two servers pick different
+ * Two things would answer for `/lucide.svg`, and the two servers pick different
  * winners: the build copies the public directory first and writes the sprite
  * over it, while dev asks the public handler first and never reaches the sprite.
  * Rather than pick one, neither runs until the author has.
  *
+ * Every library is checked, not just the default one. A library is named by a
+ * directory the author made, so the set of URLs this claims grows with their
+ * tree rather than being one name written down here.
+ *
  * @param {string|null} publicDir the author's public directory, not the copy
- * @throws when a file already sits at the sprite's URL
+ * @param {Array<{ name: string }>} libraries
+ * @throws when a file already sits at a library's URL
  */
-export function refuseSpriteClash(publicDir) {
+export function refuseSpriteClash(publicDir, libraries) {
   if (!publicDir) return;
 
-  const clash = path.join(publicDir, path.basename(SPRITE_PATH));
-  if (!fs.existsSync(clash)) return;
+  for (const { name } of libraries) {
+    const url = spritePath(name);
+    const clash = path.join(publicDir, path.basename(url));
+    if (!fs.existsSync(clash)) continue;
+
+    throw new Error(
+      `[transclude] ${clash} and the ${name} icons both answer for ${url}. ` +
+        `The sprite is built from the icons, so rename the public file or delete it.`,
+    );
+  }
+}
+
+/** The icon files directly inside `dir`, ignoring anything that is not an SVG. */
+function iconsIn(dir, root) {
+  const icons = [];
+
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    if (entry.isDirectory() || !entry.name.endsWith('.svg')) continue;
 
-  throw new Error(
-    `[transclude] ${clash} and the icons directory both answer for ${SPRITE_PATH}. ` +
-      `The sprite is built from the icons, so rename the public file or delete it.`,
-  );
+    const full = path.join(dir, entry.name);
+    icons.push({
+      id: path.basename(entry.name, '.svg'),
+      file: path.relative(root, full),
+      svg: fs.readFileSync(full, 'utf8'),
+    });
+  }
+  return icons;
 }
 
 /**
- * Every `.svg` under `dir`, ready for `buildSprite`.
+ * Every library under `dir`, each ready for `buildSprite`.
  *
- * Nested directories are read, and an icon is still named by its file alone, so
- * `ui/check.svg` and `nav/check.svg` collide. `buildSprite` says so by name.
- * Sorting is left to it, so one directory reads the same on any filesystem.
+ * Loose files at the top are the default library. Each subdirectory is a library
+ * of its own, named by the directory, which is what makes dropping a downloaded
+ * icon set in here the whole of using it.
+ *
+ * One level. A directory inside a library is refused rather than flattened or
+ * skipped: flattening would give two files one id, and skipping loses icons
+ * without saying so. Sorted, so a build reads the same on any filesystem.
  *
  * @param {string} dir
  * @param {string} [root] what the reported file paths are relative to
- * @returns {Array<{ id: string, file: string, svg: string }>} empty if `dir` is absent
+ * @returns {Array<{ name: string, icons: Array<{ id: string, file: string, svg: string }> }>}
+ *   empty if `dir` is absent, and a library with no icons in it is not one
+ * @throws when a library holds a directory
  */
-export function readIcons(dir, root = dir) {
+export function readLibraries(dir, root = dir) {
   if (!fs.existsSync(dir)) return [];
 
-  const icons = [];
+  const libraries = [];
+
+  const loose = iconsIn(dir, root);
+  if (loose.length) libraries.push({ name: DEFAULT_LIBRARY, icons: loose });
+
   for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    if (!entry.isDirectory()) continue;
+
     const full = path.join(dir, entry.name);
-    if (entry.isDirectory()) icons.push(...readIcons(full, root));
-    else if (entry.name.endsWith('.svg')) {
-      icons.push({
-        id: path.basename(entry.name, '.svg'),
-        file: path.relative(root, full),
-        svg: fs.readFileSync(full, 'utf8'),
-      });
-    }
+    refuseNesting(full, root);
+
+    const icons = iconsIn(full, root);
+    if (icons.length) libraries.push({ name: entry.name, icons });
+  }
+
+  return libraries.sort((a, b) => (a.name < b.name ? -1 : a.name > b.name ? 1 : 0));
+}
+
+/** A library is a flat directory. Anything deeper has no name to be served under. */
+function refuseNesting(dir, root) {
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    if (!entry.isDirectory()) continue;
+
+    const inner = path.relative(root, path.join(dir, entry.name));
+    throw new Error(
+      `[transclude] ${inner} is a directory inside a library, and a library is ` +
+        `one flat directory of icons. Move it up to be a library of its own, or ` +
+        `flatten it into the one it is in.`,
+    );
   }
-  return icons;
 }