From 9c8fec06d2b58e4e3bbe280ddc665a99fcc4878c Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 09 Mar 2025 22:33:15 +0000
Subject: [PATCH] feat: support non-singleton search
---
quartz/processors/parse.ts | 230 ++++++++++++++++++++++++++++++++++++++++++++++-----------
1 files changed, 186 insertions(+), 44 deletions(-)
diff --git a/quartz/processors/parse.ts b/quartz/processors/parse.ts
index b7ccdd2..479313f 100644
--- a/quartz/processors/parse.ts
+++ b/quartz/processors/parse.ts
@@ -1,58 +1,200 @@
-import remarkParse from 'remark-parse'
-import remarkRehype from 'remark-rehype'
+import esbuild from "esbuild"
+import remarkParse from "remark-parse"
+import remarkRehype from "remark-rehype"
import { Processor, unified } from "unified"
-import { Root as MDRoot } from 'remark-parse/lib'
-import { Root as HTMLRoot } from 'hast'
-import { ProcessedContent } from '../plugins/vfile'
-import { PerfTimer } from '../perf'
-import { read } from 'to-vfile'
-import { slugify } from '../path'
-import path from 'path'
-import { QuartzTransformerPlugin } from '../plugins/types'
+import { Root as MDRoot } from "remark-parse/lib"
+import { Root as HTMLRoot } from "hast"
+import { MarkdownContent, ProcessedContent } from "../plugins/vfile"
+import { PerfTimer } from "../util/perf"
+import { read } from "to-vfile"
+import { FilePath, FullSlug, QUARTZ, slugifyFilePath } from "../util/path"
+import path from "path"
+import workerpool, { Promise as WorkerPromise } from "workerpool"
+import { QuartzLogger } from "../util/log"
+import { trace } from "../util/trace"
+import { BuildCtx } from "../util/ctx"
-export type QuartzProcessor = Processor<MDRoot, HTMLRoot, void>
-export function createProcessor(transformers: QuartzTransformerPlugin[]): any {
- // base Markdown -> MD AST
- let processor = unified().use(remarkParse)
+export type QuartzMdProcessor = Processor<MDRoot, MDRoot, MDRoot>
+export type QuartzHtmlProcessor = Processor<undefined, MDRoot, HTMLRoot>
- // MD AST -> MD AST transforms
- for (const plugin of transformers) {
- processor = processor.use(plugin.markdownPlugins())
- }
+export function createMdProcessor(ctx: BuildCtx): QuartzMdProcessor {
+ const transformers = ctx.cfg.plugins.transformers
- // MD AST -> HTML AST
- processor = processor.use(remarkRehype, { allowDangerousHtml: true })
-
-
- // HTML AST -> HTML AST transforms
- for (const plugin of transformers) {
- processor = processor.use(plugin.htmlPlugins())
- }
-
- return processor
+ return (
+ unified()
+ // base Markdown -> MD AST
+ .use(remarkParse)
+ // MD AST -> MD AST transforms
+ .use(
+ transformers.flatMap((plugin) => plugin.markdownPlugins?.(ctx) ?? []),
+ ) as unknown as QuartzMdProcessor
+ // ^ sadly the typing of `use` is not smart enough to infer the correct type from our plugin list
+ )
}
-export async function parseMarkdown(processor: QuartzProcessor, baseDir: string, fps: string[], verbose: boolean): Promise<ProcessedContent[]> {
- const perf = new PerfTimer()
- const res: ProcessedContent[] = []
- for (const fp of fps) {
- const file = await read(fp)
+export function createHtmlProcessor(ctx: BuildCtx): QuartzHtmlProcessor {
+ const transformers = ctx.cfg.plugins.transformers
+ return (
+ unified()
+ // MD AST -> HTML AST
+ .use(remarkRehype, { allowDangerousHtml: true })
+ // HTML AST -> HTML AST transforms
+ .use(transformers.flatMap((plugin) => plugin.htmlPlugins?.(ctx) ?? []))
+ )
+}
- // base data properties that plugins may use
- file.data.slug = slugify(path.relative(baseDir, file.path))
- file.data.filePath = fp
+function* chunks<T>(arr: T[], n: number) {
+ for (let i = 0; i < arr.length; i += n) {
+ yield arr.slice(i, i + n)
+ }
+}
- const ast = processor.parse(file)
- res.push([await processor.run(ast, file), file])
+async function transpileWorkerScript() {
+ // transpile worker script
+ const cacheFile = "./.quartz-cache/transpiled-worker.mjs"
+ const fp = "./quartz/worker.ts"
+ return esbuild.build({
+ entryPoints: [fp],
+ outfile: path.join(QUARTZ, cacheFile),
+ bundle: true,
+ keepNames: true,
+ platform: "node",
+ format: "esm",
+ packages: "external",
+ sourcemap: true,
+ sourcesContent: false,
+ plugins: [
+ {
+ name: "css-and-scripts-as-text",
+ setup(build) {
+ build.onLoad({ filter: /\.scss$/ }, (_) => ({
+ contents: "",
+ loader: "text",
+ }))
+ build.onLoad({ filter: /\.inline\.(ts|js)$/ }, (_) => ({
+ contents: "",
+ loader: "text",
+ }))
+ },
+ },
+ ],
+ })
+}
- if (verbose) {
- console.log(`[process] ${fp} -> ${file.data.slug}`)
+export function createFileParser(ctx: BuildCtx, fps: FilePath[]) {
+ const { argv, cfg } = ctx
+ return async (processor: QuartzMdProcessor) => {
+ const res: MarkdownContent[] = []
+ for (const fp of fps) {
+ try {
+ const perf = new PerfTimer()
+ const file = await read(fp)
+
+ // strip leading and trailing whitespace
+ file.value = file.value.toString().trim()
+
+ // Text -> Text transforms
+ for (const plugin of cfg.plugins.transformers.filter((p) => p.textTransform)) {
+ file.value = plugin.textTransform!(ctx, file.value.toString())
+ }
+
+ // base data properties that plugins may use
+ file.data.filePath = file.path as FilePath
+ file.data.relativePath = path.posix.relative(argv.directory, file.path) as FilePath
+ file.data.slug = slugifyFilePath(file.data.relativePath)
+
+ const ast = processor.parse(file)
+ const newAst = await processor.run(ast, file)
+ res.push([newAst, file])
+
+ if (argv.verbose) {
+ console.log(`[markdown] ${fp} -> ${file.data.slug} (${perf.timeSince()})`)
+ }
+ } catch (err) {
+ trace(`\nFailed to process markdown \`${fp}\``, err as Error)
+ }
}
+
+ return res
+ }
+}
+
+export function createMarkdownParser(ctx: BuildCtx, mdContent: MarkdownContent[]) {
+ return async (processor: QuartzHtmlProcessor) => {
+ const res: ProcessedContent[] = []
+ for (const [ast, file] of mdContent) {
+ try {
+ const perf = new PerfTimer()
+
+ const newAst = await processor.run(ast as MDRoot, file)
+ res.push([newAst, file])
+
+ if (ctx.argv.verbose) {
+ console.log(`[html] ${file.data.slug} (${perf.timeSince()})`)
+ }
+ } catch (err) {
+ trace(`\nFailed to process html \`${file.data.filePath}\``, err as Error)
+ }
+ }
+
+ return res
+ }
+}
+
+const clamp = (num: number, min: number, max: number) =>
+ Math.min(Math.max(Math.round(num), min), max)
+
+export async function parseMarkdown(ctx: BuildCtx, fps: FilePath[]): Promise<ProcessedContent[]> {
+ const { argv } = ctx
+ const perf = new PerfTimer()
+ const log = new QuartzLogger(argv.verbose)
+
+ // rough heuristics: 128 gives enough time for v8 to JIT and optimize parsing code paths
+ const CHUNK_SIZE = 128
+ const concurrency = ctx.argv.concurrency ?? clamp(fps.length / CHUNK_SIZE, 1, 4)
+
+ let res: ProcessedContent[] = []
+ log.start(`Parsing input files using ${concurrency} threads`)
+ if (concurrency === 1) {
+ try {
+ const mdRes = await createFileParser(ctx, fps)(createMdProcessor(ctx))
+ res = await createMarkdownParser(ctx, mdRes)(createHtmlProcessor(ctx))
+ } catch (error) {
+ log.end()
+ throw error
+ }
+ } else {
+ await transpileWorkerScript()
+ const pool = workerpool.pool("./quartz/bootstrap-worker.mjs", {
+ minWorkers: "max",
+ maxWorkers: concurrency,
+ workerType: "thread",
+ })
+ const errorHandler = (err: any) => {
+ console.error(`${err}`.replace(/^error:\s*/i, ""))
+ process.exit(1)
+ }
+
+ const mdPromises: WorkerPromise<[MarkdownContent[], FullSlug[]]>[] = []
+ for (const chunk of chunks(fps, CHUNK_SIZE)) {
+ mdPromises.push(pool.exec("parseMarkdown", [ctx.buildId, argv, chunk]))
+ }
+ const mdResults: [MarkdownContent[], FullSlug[]][] =
+ await WorkerPromise.all(mdPromises).catch(errorHandler)
+
+ const childPromises: WorkerPromise<ProcessedContent[]>[] = []
+ for (const [_, extraSlugs] of mdResults) {
+ ctx.allSlugs.push(...extraSlugs)
+ }
+ for (const [mdChunk, _] of mdResults) {
+ childPromises.push(pool.exec("processHtml", [ctx.buildId, argv, mdChunk, ctx.allSlugs]))
+ }
+ const results: ProcessedContent[][] = await WorkerPromise.all(childPromises).catch(errorHandler)
+
+ res = results.flat()
+ await pool.terminate()
}
- if (verbose) {
- console.log(`Parsed and transformed ${res.length} Markdown files in ${perf.timeSince()}`)
- }
-
+ log.end(`Parsed ${res.length} Markdown files in ${perf.timeSince()}`)
return res
}
--
Gitblit v1.10.0