Skip to content

Add transformNotebook function to Vite Observable plugin #39

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 4 commits into from
Aug 7, 2025
Merged

Add transformNotebook function to Vite Observable plugin #39

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1a7d85f
Add transformNotebook function for vite plugin
rreusser Aug 7, 2025
4674aaa
Fix parameter name
rreusser Aug 7, 2025
6c31614
Remove structured clone
rreusser Aug 7, 2025
db9303a
Fix comment
rreusser Aug 7, 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 @@ -5,7 +5,7 @@ import {fileURLToPath} from "node:url";
import type {TemplateLiteral} from "acorn";
import {JSDOM} from "jsdom";
import type {PluginOption, IndexHtmlTransformContext} from "vite";
import type {Cell} from "../lib/notebook.js";
import type {Cell, Notebook} from "../lib/notebook.js";
import {deserialize} from "../lib/serialize.js";
import {Sourcemap} from "../javascript/sourcemap.js";
import {transpile} from "../javascript/transpile.js";
Expand All @@ -25,14 +25,17 @@ export interface ObservableOptions {
template?: string;
/** A function which performs a per-page transformation of the template HTML. */
transformTemplate?: (template: string, context: IndexHtmlTransformContext) => string | Promise<string>;
/** A function which transforms the parsed notebook. */
transformNotebook?: (notebook: Notebook, context: IndexHtmlTransformContext) => Notebook | Promise<Notebook>;
}

export function observable({
window = new JSDOM().window,
parser = new window.DOMParser(),
serializer = new window.XMLSerializer(),
template = fileURLToPath(import.meta.resolve("../templates/default.html")),
transformTemplate = undefined
transformTemplate = undefined,
transformNotebook = undefined
}: ObservableOptions = {}): PluginOption {
return {
name: "observable",
Expand All @@ -47,7 +50,10 @@ export function observable({
transformIndexHtml: {
order: "pre",
async handler(input, context) {
const notebook = deserialize(input, {parser});
let notebook = deserialize(input, {parser});
if (transformNotebook !== undefined) {
notebook = await transformNotebook(notebook, context);
}
let tsource = await readFile(template, "utf-8");
if (transformTemplate !== undefined) {
tsource = await transformTemplate(tsource, context);
Expand Down