Skip to content

Add transformTemplate() function to vite plugin #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 6, 2025
Merged

Add transformTemplate() function to vite plugin #30

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
77cb05b
Add template transform function to vite plugin
rreusser Aug 3, 2025
aa42fb1
Clean up transformTemplate arguments
rreusser Aug 5, 2025
78f2ce1
Add additional context parameters
rreusser Aug 5, 2025
bdbf434
Update src/vite/observable.ts
rreusser Aug 6, 2025
f5f6eb7
Update src/vite/observable.ts
rreusser Aug 6, 2025
2a7bc1d
Clean up transformTemplate params
rreusser Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/vite/observable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {dirname, join, resolve} from "node:path";
import {fileURLToPath} from "node:url";
import type {TemplateLiteral} from "acorn";
import {JSDOM} from "jsdom";
import type {PluginOption} from "vite";
import type {PluginOption, IndexHtmlTransformContext} from "vite";
import type {Cell} from "../lib/notebook.js";
import {deserialize} from "../lib/serialize.js";
import {Sourcemap} from "../javascript/sourcemap.js";
Expand All @@ -23,13 +23,16 @@ export interface ObservableOptions {
serializer?: XMLSerializer;
/** The path to the page template; defaults to the default template. */
template?: string;
/** A function which performs a per-page transformation of the template HTML. */
transformTemplate?: (template: string, context: IndexHtmlTransformContext) => string | Promise<string>;
}

export function observable({
window = new JSDOM().window,
parser = new window.DOMParser(),
serializer = new window.XMLSerializer(),
template = fileURLToPath(import.meta.resolve("../templates/default.html"))
template = fileURLToPath(import.meta.resolve("../templates/default.html")),
transformTemplate = undefined
}: ObservableOptions = {}): PluginOption {
return {
name: "observable",
Expand All @@ -45,7 +48,10 @@ export function observable({
order: "pre",
async handler(input, context) {
const notebook = deserialize(input, {parser});
const tsource = await readFile(template, "utf-8");
let tsource = await readFile(template, "utf-8");
if (transformTemplate !== undefined) {
tsource = await transformTemplate(tsource, context);
}
const document = parser.parseFromString(tsource, "text/html");
const statics = new Set<Cell>();
const assets = new Set<string>();
Expand Down