From e47c29d2fd4eae06c511c914e2a5fcb057b44d7b Mon Sep 17 00:00:00 2001
From: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date: Mon, 19 Aug 2024 21:14:29 +0000
Subject: [PATCH] chore(deps): bump rehype-katex from 7.0.0 to 7.0.1 (#1356)
---
quartz/build.ts | 231 ++++++++++++++++++++++++++++++++++++++++++++++++++++++---
1 files changed, 218 insertions(+), 13 deletions(-)
diff --git a/quartz/build.ts b/quartz/build.ts
index 1f90301..342a27c 100644
--- a/quartz/build.ts
+++ b/quartz/build.ts
@@ -17,6 +17,10 @@
import { trace } from "./util/trace"
import { options } from "./util/sourcemap"
import { Mutex } from "async-mutex"
+import DepGraph from "./depgraph"
+import { getStaticResourcesFromPlugins } from "./plugins"
+
+type Dependencies = Record<string, DepGraph<FilePath> | null>
type BuildData = {
ctx: BuildCtx
@@ -29,10 +33,18 @@
toRebuild: Set<FilePath>
toRemove: Set<FilePath>
lastBuildMs: number
+ dependencies: Dependencies
+}
+
+type FileEvent = "add" | "change" | "delete"
+
+function newBuildId() {
+ return new Date().toISOString()
}
async function buildQuartz(argv: Argv, mut: Mutex, clientRefresh: () => void) {
const ctx: BuildCtx = {
+ buildId: newBuildId(),
argv,
cfg,
allSlugs: [],
@@ -53,7 +65,7 @@
const release = await mut.acquire()
perf.addEvent("clean")
- await rimraf(output)
+ await rimraf(path.join(output, "*"), { glob: true })
console.log(`Cleaned output directory \`${output}\` in ${perf.timeSince("clean")}`)
perf.addEvent("glob")
@@ -68,12 +80,24 @@
const parsedFiles = await parseMarkdown(ctx, filePaths)
const filteredContent = filterContent(ctx, parsedFiles)
+
+ const dependencies: Record<string, DepGraph<FilePath> | null> = {}
+
+ // Only build dependency graphs if we're doing a fast rebuild
+ if (argv.fastRebuild) {
+ const staticResources = getStaticResourcesFromPlugins(ctx)
+ for (const emitter of cfg.plugins.emitters) {
+ dependencies[emitter.name] =
+ (await emitter.getDependencyGraph?.(ctx, filteredContent, staticResources)) ?? null
+ }
+ }
+
await emitContent(ctx, filteredContent)
console.log(chalk.green(`Done processing ${fps.length} files in ${perf.timeSince()}`))
release()
if (argv.serve) {
- return startServing(ctx, mut, parsedFiles, clientRefresh)
+ return startServing(ctx, mut, parsedFiles, clientRefresh, dependencies)
}
}
@@ -83,9 +107,11 @@
mut: Mutex,
initialContent: ProcessedContent[],
clientRefresh: () => void,
+ dependencies: Dependencies, // emitter name: dep graph
) {
const { argv } = ctx
+ // cache file parse results
const contentMap = new Map<FilePath, ProcessedContent>()
for (const content of initialContent) {
const [_tree, vfile] = content
@@ -95,6 +121,7 @@
const buildData: BuildData = {
ctx,
mut,
+ dependencies,
contentMap,
ignored: await isGitIgnored(),
initialSlugs: ctx.allSlugs,
@@ -110,19 +137,194 @@
ignoreInitial: true,
})
+ const buildFromEntry = argv.fastRebuild ? partialRebuildFromEntrypoint : rebuildFromEntrypoint
watcher
- .on("add", (fp) => rebuildFromEntrypoint(fp, "add", clientRefresh, buildData))
- .on("change", (fp) => rebuildFromEntrypoint(fp, "change", clientRefresh, buildData))
- .on("unlink", (fp) => rebuildFromEntrypoint(fp, "delete", clientRefresh, buildData))
+ .on("add", (fp) => buildFromEntry(fp, "add", clientRefresh, buildData))
+ .on("change", (fp) => buildFromEntry(fp, "change", clientRefresh, buildData))
+ .on("unlink", (fp) => buildFromEntry(fp, "delete", clientRefresh, buildData))
return async () => {
await watcher.close()
}
}
+async function partialRebuildFromEntrypoint(
+ filepath: string,
+ action: FileEvent,
+ clientRefresh: () => void,
+ buildData: BuildData, // note: this function mutates buildData
+) {
+ const { ctx, ignored, dependencies, contentMap, mut, toRemove } = buildData
+ const { argv, cfg } = ctx
+
+ // don't do anything for gitignored files
+ if (ignored(filepath)) {
+ return
+ }
+
+ const buildStart = new Date().getTime()
+ buildData.lastBuildMs = buildStart
+ const release = await mut.acquire()
+ if (buildData.lastBuildMs > buildStart) {
+ release()
+ return
+ }
+
+ const perf = new PerfTimer()
+ console.log(chalk.yellow("Detected change, rebuilding..."))
+ ctx.buildId = newBuildId()
+
+ // UPDATE DEP GRAPH
+ const fp = joinSegments(argv.directory, toPosixPath(filepath)) as FilePath
+
+ const staticResources = getStaticResourcesFromPlugins(ctx)
+ let processedFiles: ProcessedContent[] = []
+
+ switch (action) {
+ case "add":
+ // add to cache when new file is added
+ processedFiles = await parseMarkdown(ctx, [fp])
+ processedFiles.forEach(([tree, vfile]) => contentMap.set(vfile.data.filePath!, [tree, vfile]))
+
+ // update the dep graph by asking all emitters whether they depend on this file
+ for (const emitter of cfg.plugins.emitters) {
+ const emitterGraph =
+ (await emitter.getDependencyGraph?.(ctx, processedFiles, staticResources)) ?? null
+
+ if (emitterGraph) {
+ const existingGraph = dependencies[emitter.name]
+ if (existingGraph !== null) {
+ existingGraph.mergeGraph(emitterGraph)
+ } else {
+ // might be the first time we're adding a mardown file
+ dependencies[emitter.name] = emitterGraph
+ }
+ }
+ }
+ break
+ case "change":
+ // invalidate cache when file is changed
+ processedFiles = await parseMarkdown(ctx, [fp])
+ processedFiles.forEach(([tree, vfile]) => contentMap.set(vfile.data.filePath!, [tree, vfile]))
+
+ // only content files can have added/removed dependencies because of transclusions
+ if (path.extname(fp) === ".md") {
+ for (const emitter of cfg.plugins.emitters) {
+ // get new dependencies from all emitters for this file
+ const emitterGraph =
+ (await emitter.getDependencyGraph?.(ctx, processedFiles, staticResources)) ?? null
+
+ // only update the graph if the emitter plugin uses the changed file
+ // eg. Assets plugin ignores md files, so we skip updating the graph
+ if (emitterGraph?.hasNode(fp)) {
+ // merge the new dependencies into the dep graph
+ dependencies[emitter.name]?.updateIncomingEdgesForNode(emitterGraph, fp)
+ }
+ }
+ }
+ break
+ case "delete":
+ toRemove.add(fp)
+ break
+ }
+
+ if (argv.verbose) {
+ console.log(`Updated dependency graphs in ${perf.timeSince()}`)
+ }
+
+ // EMIT
+ perf.addEvent("rebuild")
+ let emittedFiles = 0
+
+ for (const emitter of cfg.plugins.emitters) {
+ const depGraph = dependencies[emitter.name]
+
+ // emitter hasn't defined a dependency graph. call it with all processed files
+ if (depGraph === null) {
+ if (argv.verbose) {
+ console.log(
+ `Emitter ${emitter.name} doesn't define a dependency graph. Calling it with all files...`,
+ )
+ }
+
+ const files = [...contentMap.values()].filter(
+ ([_node, vfile]) => !toRemove.has(vfile.data.filePath!),
+ )
+
+ const emittedFps = await emitter.emit(ctx, files, staticResources)
+
+ if (ctx.argv.verbose) {
+ for (const file of emittedFps) {
+ console.log(`[emit:${emitter.name}] ${file}`)
+ }
+ }
+
+ emittedFiles += emittedFps.length
+ continue
+ }
+
+ // only call the emitter if it uses this file
+ if (depGraph.hasNode(fp)) {
+ // re-emit using all files that are needed for the downstream of this file
+ // eg. for ContentIndex, the dep graph could be:
+ // a.md --> contentIndex.json
+ // b.md ------^
+ //
+ // if a.md changes, we need to re-emit contentIndex.json,
+ // and supply [a.md, b.md] to the emitter
+ const upstreams = [...depGraph.getLeafNodeAncestors(fp)] as FilePath[]
+
+ const upstreamContent = upstreams
+ // filter out non-markdown files
+ .filter((file) => contentMap.has(file))
+ // if file was deleted, don't give it to the emitter
+ .filter((file) => !toRemove.has(file))
+ .map((file) => contentMap.get(file)!)
+
+ const emittedFps = await emitter.emit(ctx, upstreamContent, staticResources)
+
+ if (ctx.argv.verbose) {
+ for (const file of emittedFps) {
+ console.log(`[emit:${emitter.name}] ${file}`)
+ }
+ }
+
+ emittedFiles += emittedFps.length
+ }
+ }
+
+ console.log(`Emitted ${emittedFiles} files to \`${argv.output}\` in ${perf.timeSince("rebuild")}`)
+
+ // CLEANUP
+ const destinationsToDelete = new Set<FilePath>()
+ for (const file of toRemove) {
+ // remove from cache
+ contentMap.delete(file)
+ Object.values(dependencies).forEach((depGraph) => {
+ // remove the node from dependency graphs
+ depGraph?.removeNode(file)
+ // remove any orphan nodes. eg if a.md is deleted, a.html is orphaned and should be removed
+ const orphanNodes = depGraph?.removeOrphanNodes()
+ orphanNodes?.forEach((node) => {
+ // only delete files that are in the output directory
+ if (node.startsWith(argv.output)) {
+ destinationsToDelete.add(node)
+ }
+ })
+ })
+ }
+ await rimraf([...destinationsToDelete])
+
+ console.log(chalk.green(`Done rebuilding in ${perf.timeSince()}`))
+
+ toRemove.clear()
+ release()
+ clientRefresh()
+}
+
async function rebuildFromEntrypoint(
fp: string,
- action: "add" | "change" | "delete",
+ action: FileEvent,
clientRefresh: () => void,
buildData: BuildData, // note: this function mutates buildData
) {
@@ -167,14 +369,10 @@
const perf = new PerfTimer()
console.log(chalk.yellow("Detected change, rebuilding..."))
+ ctx.buildId = newBuildId()
+
try {
const filesToRebuild = [...toRebuild].filter((fp) => !toRemove.has(fp))
-
- const trackedSlugs = [...new Set([...contentMap.keys(), ...toRebuild, ...trackedAssets])]
- .filter((fp) => !toRemove.has(fp))
- .map((fp) => slugifyFilePath(path.posix.relative(argv.directory, fp) as FilePath))
-
- ctx.allSlugs = [...new Set([...initialSlugs, ...trackedSlugs])]
const parsedContent = await parseMarkdown(ctx, filesToRebuild)
for (const content of parsedContent) {
const [_tree, vfile] = content
@@ -188,9 +386,16 @@
const parsedFiles = [...contentMap.values()]
const filteredContent = filterContent(ctx, parsedFiles)
+ // re-update slugs
+ const trackedSlugs = [...new Set([...contentMap.keys(), ...toRebuild, ...trackedAssets])]
+ .filter((fp) => !toRemove.has(fp))
+ .map((fp) => slugifyFilePath(path.posix.relative(argv.directory, fp) as FilePath))
+
+ ctx.allSlugs = [...new Set([...initialSlugs, ...trackedSlugs])]
+
// TODO: we can probably traverse the link graph to figure out what's safe to delete here
// instead of just deleting everything
- await rimraf(argv.output)
+ await rimraf(path.join(argv.output, ".*"), { glob: true })
await emitContent(ctx, filteredContent)
console.log(chalk.green(`Done rebuilding in ${perf.timeSince()}`))
} catch (err) {
--
Gitblit v1.10.0