@dogsbay/highlight 0.2.0-beta.123 → 0.2.0-beta.125

package/README.md

@@ -17,6 +17,35 @@ await highlighter.load(highlightInputs(tree));
 // pass it as RenderContext.highlighter
 ```
 
+## In a browser
+
+Bundle it with code splitting (`esbuild --splitting --format=esm`, or any
+bundler that keeps dynamic `import()`s apart) and each grammar becomes its own
+chunk, fetched the first time `load` names it. Nothing is loaded up front:
+`createHighlighter()` with no `langs` loads no grammar, so a page pays only
+for the languages it shows. Measured with esbuild 0.28, minified, gzipped:
+
+| Chunk | Minified | Gzipped |
+|---|---|---|
+| Core (Shiki, the JavaScript regex engine, both themes) | 215 KB | 67 KB |
+| javascript / typescript | 175 / 181 KB | 16.5 / 16.0 KB |
+| html / css | 58 / 49 KB | 11.6 / 11.9 KB |
+| python | 70 KB | 9.2 KB |
+| bash (shellscript) | 41 KB | 6.1 KB |
+| markdown | 59 KB | 5.7 KB |
+| yaml / json / xml | 10 / 3 / 5 KB | 2.3 / 0.8 / 1.2 KB |
+| every grammar | 2.2 MB | 247 KB |
+
+A host that renders as you type can call `load(highlightInputs(tree))` before
+each render: it returns at once when everything is loaded, and a block whose
+grammar is still on its way renders plain until the next render.
+`tests/browser-bundle.test.ts` bundles it this way, holds the core under 80 KB
+gzipped (it was 182 KB while it imported render-html's index, which carries
+the whole renderer; it now imports render-html's `lines` and `html` modules),
+and checks that a grammar arrives as its own chunk.
+
+## Grammars
+
 38 grammars, about 2.1 MB minified in all, each loaded when `load` (or the
 `langs` option; `langs: "all"` loads every one) first names one of its
 spellings: the grammar's name, its aliases (`sh`, `zsh`), or ours (`py`, `yml`,

package/dist/highlight.d.ts

@@ -1,6 +1,6 @@
-import { type Highlighter } from "@dogsbay/render-html";
-export { parseLineRanges } from "@dogsbay/render-html";
-export type { CodeOptions, Highlighter } from "@dogsbay/render-html";
+import { type Highlighter } from "@dogsbay/render-html/lines";
+export { parseLineRanges } from "@dogsbay/render-html/lines";
+export type { CodeOptions, Highlighter } from "@dogsbay/render-html/lines";
 /**
  * Characters of rendered blocks (and their keys) the highlighter keeps by
  * default, for library callers: 8M characters is 8–16 MB (a string with any

package/dist/highlight.js

@@ -30,9 +30,12 @@ import githubLight from "@shikijs/themes/github-light-default";
 import githubDark from "@shikijs/themes/github-dark-default";
 import { LAZY_EMBEDS, LAZY_VIA, LOADERS, SPELLINGS } from "./grammars.js";
 import { transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, transformerNotationWordHighlight, } from "@shikijs/transformers";
-import { esc, PLAIN, plainBlock } from "@dogsbay/render-html";
+// The narrow modules, not the package index: the index carries the whole
+// renderer (markdown-it, entities, …), over half the browser bundle otherwise
+import { esc } from "@dogsbay/render-html/html";
+import { PLAIN, plainBlock } from "@dogsbay/render-html/lines";
 import { stripUnprocessableMarkers } from "@dogsbay/render-html/code-markers";
-export { parseLineRanges } from "@dogsbay/render-html";
+export { parseLineRanges } from "@dogsbay/render-html/lines";
 /** Aliases the grammars do not declare themselves. */
 const ALIASES = {
     terminal: "bash",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dogsbay/highlight",
-  "version": "0.2.0-beta.123",
-  "description": "Syntax highlighting for @dogsbay/render-html: Shiki core with the JavaScript regex engine, both themes from one tokenization, a bounded cache. No WebAssembly; Worker-safe",
+  "version": "0.2.0-beta.125",
+  "description": "Syntax highlighting for @dogsbay/render-html: Shiki core with the JavaScript regex engine, both themes from one tokenization, a bounded cache. No WebAssembly; Worker- and browser-safe, one chunk per grammar when split",
   "type": "module",
   "main": "./dist/highlight.js",
   "types": "./dist/highlight.d.ts",
@@ -25,7 +25,7 @@
     "@shikijs/themes": "4.3.1",
     "@shikijs/transformers": "4.3.1",
     "shiki": "4.3.1",
-    "@dogsbay/render-html": "0.2.0-beta.123"
+    "@dogsbay/render-html": "0.2.0-beta.125"
   },
   "devDependencies": {
     "@types/node": "^22.20.1",