From a7372079817fb1a1e69b2632405d759f9c5e913d Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 16 Mar 2025 21:17:31 +0000
Subject: [PATCH] perf: incremental rebuild (--fastRebuild v2 but default) (#1841)
---
quartz/plugins/emitters/contentPage.tsx | 133 ++++++++++++++++++-------------------------
1 files changed, 56 insertions(+), 77 deletions(-)
diff --git a/quartz/plugins/emitters/contentPage.tsx b/quartz/plugins/emitters/contentPage.tsx
index f833930..d3f54e9 100644
--- a/quartz/plugins/emitters/contentPage.tsx
+++ b/quartz/plugins/emitters/contentPage.tsx
@@ -1,54 +1,48 @@
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 { Argv } from "../../util/ctx"
-import { FilePath, isRelativeURL, joinSegments, pathToRoot } from "../../util/path"
+import { 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"
+import { BuildCtx } from "../../util/ctx"
+import { Node } from "unist"
+import { StaticResources } from "../../util/resources"
+import { QuartzPluginData } from "../vfile"
-// 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[] = []
+async function processContent(
+ ctx: BuildCtx,
+ tree: Node,
+ fileData: QuartzPluginData,
+ allFiles: QuartzPluginData[],
+ opts: FullPageLayout,
+ resources: StaticResources,
+) {
+ const slug = fileData.slug!
+ const cfg = ctx.cfg.configuration
+ const externalResources = pageResources(pathToRoot(slug), resources)
+ const componentData: QuartzComponentProps = {
+ ctx,
+ fileData,
+ externalResources,
+ cfg,
+ children: [],
+ tree,
+ allFiles,
+ }
- 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)
+ const content = renderPage(cfg, slug, componentData, opts, externalResources)
+ return write({
+ ctx,
+ content,
+ slug,
+ ext: ".html",
})
-
- return dependencies
}
export const ContentPage: QuartzEmitterPlugin<Partial<FullPageLayout>> = (userOpts) => {
@@ -79,57 +73,22 @@
Footer,
]
},
- async getDependencyGraph(ctx, content, _resources) {
- const graph = new DepGraph<FilePath>()
-
- 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
- },
async *emit(ctx, content, resources) {
- const cfg = ctx.cfg.configuration
const allFiles = content.map((c) => c[1].data)
-
let containsIndex = false
+
for (const [tree, file] of content) {
const slug = file.data.slug!
if (slug === "index") {
containsIndex = true
}
- if (file.data.slug?.endsWith("/index")) {
- continue
- }
-
- const externalResources = pageResources(pathToRoot(slug), file.data, resources)
- const componentData: QuartzComponentProps = {
- ctx,
- fileData: file.data,
- externalResources,
- cfg,
- children: [],
- tree,
- allFiles,
- }
-
- const content = renderPage(cfg, slug, componentData, opts, externalResources)
- yield write({
- ctx,
- content,
- slug,
- ext: ".html",
- })
+ // only process home page, non-tag pages, and non-index pages
+ if (slug.endsWith("/index") || slug.startsWith("tags/")) continue
+ yield processContent(ctx, tree, file.data, allFiles, opts, resources)
}
- if (!containsIndex && !ctx.argv.fastRebuild) {
+ if (!containsIndex) {
console.log(
chalk.yellow(
`\nWarning: you seem to be missing an \`index.md\` home page file at the root of your \`${ctx.argv.directory}\` folder (\`${path.join(ctx.argv.directory, "index.md")} does not exist\`). This may cause errors when deploying.`,
@@ -137,5 +96,25 @@
)
}
},
+ async *partialEmit(ctx, content, resources, changeEvents) {
+ const allFiles = content.map((c) => c[1].data)
+
+ // find all slugs that changed or were added
+ const changedSlugs = new Set<string>()
+ for (const changeEvent of changeEvents) {
+ if (!changeEvent.file) continue
+ if (changeEvent.type === "add" || changeEvent.type === "change") {
+ changedSlugs.add(changeEvent.file.data.slug!)
+ }
+ }
+
+ for (const [tree, file] of content) {
+ const slug = file.data.slug!
+ if (!changedSlugs.has(slug)) continue
+ if (slug.endsWith("/index") || slug.startsWith("tags/")) continue
+
+ yield processContent(ctx, tree, file.data, allFiles, opts, resources)
+ }
+ },
}
}
--
Gitblit v1.10.0