From 5af707ea20e8106857750e1d6a0e43cf18679749 Mon Sep 17 00:00:00 2001
From: kabirgh <15871468+kabirgh@users.noreply.github.com>
Date: Sat, 17 Feb 2024 17:45:01 +0000
Subject: [PATCH] fix/feat(fast rebuild): re-render transclusions in normal and fastRebuild mode (#842)
---
quartz/components/renderPage.tsx | 26 +++++--------
quartz/plugins/emitters/contentPage.tsx | 49 +++++++++++++++++++++++-
2 files changed, 56 insertions(+), 19 deletions(-)
diff --git a/quartz/components/renderPage.tsx b/quartz/components/renderPage.tsx
index 33671d2..5394d6f 100644
--- a/quartz/components/renderPage.tsx
+++ b/quartz/components/renderPage.tsx
@@ -3,10 +3,9 @@
import HeaderConstructor from "./Header"
import BodyConstructor from "./Body"
import { JSResourceToScriptElement, StaticResources } from "../util/resources"
-import { FullSlug, RelativeURL, joinSegments, normalizeHastElement } from "../util/path"
+import { clone, FullSlug, RelativeURL, joinSegments, normalizeHastElement } from "../util/path"
import { visit } from "unist-util-visit"
import { Root, Element, ElementContent } from "hast"
-import { QuartzPluginData } from "../plugins/vfile"
import { GlobalConfiguration } from "../cfg"
import { i18n } from "../i18n"
@@ -52,18 +51,6 @@
}
}
-let pageIndex: Map<FullSlug, QuartzPluginData> | undefined = undefined
-function getOrComputeFileIndex(allFiles: QuartzPluginData[]): Map<FullSlug, QuartzPluginData> {
- if (!pageIndex) {
- pageIndex = new Map()
- for (const file of allFiles) {
- pageIndex.set(file.slug!, file)
- }
- }
-
- return pageIndex
-}
-
export function renderPage(
cfg: GlobalConfiguration,
slug: FullSlug,
@@ -71,14 +58,18 @@
components: RenderComponents,
pageResources: StaticResources,
): string {
+ // make a deep copy of the tree so we don't remove the transclusion references
+ // for the file cached in contentMap in build.ts
+ const root = clone(componentData.tree) as Root
+
// process transcludes in componentData
- visit(componentData.tree as Root, "element", (node, _index, _parent) => {
+ visit(root, "element", (node, _index, _parent) => {
if (node.tagName === "blockquote") {
const classNames = (node.properties?.className ?? []) as string[]
if (classNames.includes("transclude")) {
const inner = node.children[0] as Element
const transcludeTarget = inner.properties["data-slug"] as FullSlug
- const page = getOrComputeFileIndex(componentData.allFiles).get(transcludeTarget)
+ const page = componentData.allFiles.find((f) => f.slug === transcludeTarget)
if (!page) {
return
}
@@ -181,6 +172,9 @@
}
})
+ // set componentData.tree to the edited html that has transclusions rendered
+ componentData.tree = root
+
const {
head: Head,
header,
diff --git a/quartz/plugins/emitters/contentPage.tsx b/quartz/plugins/emitters/contentPage.tsx
index e531b36..904a8a8 100644
--- a/quartz/plugins/emitters/contentPage.tsx
+++ b/quartz/plugins/emitters/contentPage.tsx
@@ -1,16 +1,56 @@
+import path from "path"
+import { visit } from "unist-util-visit"
+import { Root } from "hast"
+import { VFile } from "vfile"
import { QuartzEmitterPlugin } from "../types"
import { QuartzComponentProps } from "../../components/types"
import HeaderConstructor from "../../components/Header"
import BodyConstructor from "../../components/Body"
import { pageResources, renderPage } from "../../components/renderPage"
import { FullPageLayout } from "../../cfg"
-import { FilePath, joinSegments, pathToRoot } from "../../util/path"
+import { Argv } from "../../util/ctx"
+import { FilePath, isRelativeURL, joinSegments, pathToRoot } from "../../util/path"
import { defaultContentPageLayout, sharedPageComponents } from "../../../quartz.layout"
import { Content } from "../../components"
import chalk from "chalk"
import { write } from "./helpers"
import DepGraph from "../../depgraph"
+// get all the dependencies for the markdown file
+// eg. images, scripts, stylesheets, transclusions
+const parseDependencies = (argv: Argv, hast: Root, file: VFile): string[] => {
+ const dependencies: string[] = []
+
+ visit(hast, "element", (elem): void => {
+ let ref: string | null = null
+
+ if (
+ ["script", "img", "audio", "video", "source", "iframe"].includes(elem.tagName) &&
+ elem?.properties?.src
+ ) {
+ ref = elem.properties.src.toString()
+ } else if (["a", "link"].includes(elem.tagName) && elem?.properties?.href) {
+ // transclusions will create a tags with relative hrefs
+ ref = elem.properties.href.toString()
+ }
+
+ // if it is a relative url, its a local file and we need to add
+ // it to the dependency graph. otherwise, ignore
+ if (ref === null || !isRelativeURL(ref)) {
+ return
+ }
+
+ let fp = path.join(file.data.filePath!, path.relative(argv.directory, ref)).replace(/\\/g, "/")
+ // markdown files have the .md extension stripped in hrefs, add it back here
+ if (!fp.split("/").pop()?.includes(".")) {
+ fp += ".md"
+ }
+ dependencies.push(fp)
+ })
+
+ return dependencies
+}
+
export const ContentPage: QuartzEmitterPlugin<Partial<FullPageLayout>> = (userOpts) => {
const opts: FullPageLayout = {
...sharedPageComponents,
@@ -29,13 +69,16 @@
return [Head, Header, Body, ...header, ...beforeBody, pageBody, ...left, ...right, Footer]
},
async getDependencyGraph(ctx, content, _resources) {
- // TODO handle transclusions
const graph = new DepGraph<FilePath>()
- for (const [_tree, file] of content) {
+ for (const [tree, file] of content) {
const sourcePath = file.data.filePath!
const slug = file.data.slug!
graph.addEdge(sourcePath, joinSegments(ctx.argv.output, slug + ".html") as FilePath)
+
+ parseDependencies(ctx.argv, tree as Root, file).forEach((dep) => {
+ graph.addEdge(dep as FilePath, sourcePath)
+ })
}
return graph
--
Gitblit v1.10.0