roadmap/quartz/processors/parse.ts

162 lines
4.9 KiB
TypeScript
Raw Normal View History

2023-07-23 00:27:41 +00:00
import esbuild from "esbuild"
import remarkParse from "remark-parse"
import remarkRehype from "remark-rehype"
2023-05-30 15:02:20 +00:00
import { Processor, unified } from "unified"
2023-07-23 00:27:41 +00:00
import { Root as MDRoot } from "remark-parse/lib"
import { Root as HTMLRoot } from "hast"
import { ProcessedContent } from "../plugins/vfile"
import { PerfTimer } from "../util/perf"
2023-07-23 00:27:41 +00:00
import { read } from "to-vfile"
import { FilePath, QUARTZ, slugifyFilePath } from "../util/path"
2023-07-23 00:27:41 +00:00
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"
2023-05-30 15:02:20 +00:00
export type QuartzProcessor = Processor<MDRoot, HTMLRoot, void>
2023-07-24 07:04:01 +00:00
export function createProcessor(ctx: BuildCtx): QuartzProcessor {
const transformers = ctx.cfg.plugins.transformers
2023-05-30 15:02:20 +00:00
// base Markdown -> MD AST
let processor = unified().use(remarkParse)
// MD AST -> MD AST transforms
2023-07-23 00:27:41 +00:00
for (const plugin of transformers.filter((p) => p.markdownPlugins)) {
2023-07-24 07:04:01 +00:00
processor = processor.use(plugin.markdownPlugins!(ctx))
2023-05-30 15:02:20 +00:00
}
// MD AST -> HTML AST
processor = processor.use(remarkRehype, { allowDangerousHtml: true })
// HTML AST -> HTML AST transforms
2023-07-23 00:27:41 +00:00
for (const plugin of transformers.filter((p) => p.htmlPlugins)) {
2023-07-24 07:04:01 +00:00
processor = processor.use(plugin.htmlPlugins!(ctx))
2023-05-30 15:02:20 +00:00
}
return processor
}
2023-06-04 16:35:45 +00:00
function* chunks<T>(arr: T[], n: number) {
for (let i = 0; i < arr.length; i += n) {
yield arr.slice(i, i + n)
}
}
2023-06-04 17:37:43 +00:00
async function transpileWorkerScript() {
2023-06-04 16:35:45 +00:00
// transpile worker script
const cacheFile = "./.quartz-cache/transpiled-worker.mjs"
const fp = "./quartz/worker.ts"
2023-06-04 17:37:43 +00:00
return esbuild.build({
2023-06-04 16:35:45 +00:00
entryPoints: [fp],
outfile: path.join(QUARTZ, cacheFile),
2023-06-04 16:35:45 +00:00
bundle: true,
keepNames: true,
platform: "node",
format: "esm",
packages: "external",
sourcemap: true,
sourcesContent: false,
2023-06-04 16:35:45 +00:00
plugins: [
{
2023-07-23 00:27:41 +00:00
name: "css-and-scripts-as-text",
2023-06-04 16:35:45 +00:00
setup(build) {
build.onLoad({ filter: /\.scss$/ }, (_) => ({
2023-07-23 00:27:41 +00:00
contents: "",
loader: "text",
2023-06-04 16:35:45 +00:00
}))
build.onLoad({ filter: /\.inline\.(ts|js)$/ }, (_) => ({
2023-07-23 00:27:41 +00:00
contents: "",
loader: "text",
2023-06-04 16:35:45 +00:00
}))
2023-07-23 00:27:41 +00:00
},
},
],
2023-06-04 16:35:45 +00:00
})
}
2023-07-24 07:04:01 +00:00
export function createFileParser(ctx: BuildCtx, fps: FilePath[]) {
const { argv, cfg } = ctx
2023-06-04 17:37:43 +00:00
return async (processor: QuartzProcessor) => {
const res: ProcessedContent[] = []
for (const fp of fps) {
try {
const perf = new PerfTimer()
2023-06-04 17:37:43 +00:00
const file = await read(fp)
2023-07-07 02:18:18 +00:00
// 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)) {
2023-07-24 07:04:01 +00:00
file.value = plugin.textTransform!(ctx, file.value)
}
2023-06-04 17:37:43 +00:00
// base data properties that plugins may use
2023-08-03 06:04:26 +00:00
file.data.slug = slugifyFilePath(path.posix.relative(argv.directory, file.path) as FilePath)
2023-06-04 17:37:43 +00:00
file.data.filePath = fp
const ast = processor.parse(file)
const newAst = await processor.run(ast, file)
res.push([newAst, file])
if (argv.verbose) {
console.log(`[process] ${fp} -> ${file.data.slug} (${perf.timeSince()})`)
2023-06-04 17:37:43 +00:00
}
} catch (err) {
trace(`\nFailed to process \`${fp}\``, err as Error)
2023-06-04 17:37:43 +00:00
}
}
return res
}
}
2023-08-09 16:18:44 +00:00
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[]> {
2023-07-24 07:04:01 +00:00
const { argv } = ctx
2023-05-30 15:02:20 +00:00
const perf = new PerfTimer()
const log = new QuartzLogger(argv.verbose)
2023-06-04 16:35:45 +00:00
// rough heuristics: 128 gives enough time for v8 to JIT and optimize parsing code paths
2023-06-04 16:35:45 +00:00
const CHUNK_SIZE = 128
const concurrency = ctx.argv.concurrency ?? clamp(fps.length / CHUNK_SIZE, 1, 4)
2023-06-04 17:37:43 +00:00
2023-07-10 02:32:24 +00:00
let res: ProcessedContent[] = []
2023-06-04 17:37:43 +00:00
log.start(`Parsing input files using ${concurrency} threads`)
2023-06-04 16:35:45 +00:00
if (concurrency === 1) {
2023-07-23 18:49:26 +00:00
try {
2023-07-24 07:04:01 +00:00
const processor = createProcessor(ctx)
const parse = createFileParser(ctx, fps)
2023-07-23 18:49:26 +00:00
res = await parse(processor)
} catch (error) {
log.end()
throw error
}
2023-06-04 16:35:45 +00:00
} else {
2023-06-04 17:37:43 +00:00
await transpileWorkerScript()
2023-07-23 00:27:41 +00:00
const pool = workerpool.pool("./quartz/bootstrap-worker.mjs", {
minWorkers: "max",
maxWorkers: concurrency,
workerType: "thread",
})
2023-05-30 15:02:20 +00:00
2023-06-04 16:35:45 +00:00
const childPromises: WorkerPromise<ProcessedContent[]>[] = []
for (const chunk of chunks(fps, CHUNK_SIZE)) {
2023-07-24 07:04:01 +00:00
childPromises.push(pool.exec("parseFiles", [argv, chunk, ctx.allSlugs]))
2023-05-30 15:02:20 +00:00
}
2023-06-04 17:37:43 +00:00
const results: ProcessedContent[][] = await WorkerPromise.all(childPromises).catch((err) => {
const errString = err.toString().slice("Error:".length)
console.error(errString)
process.exit(1)
})
2023-06-04 17:37:43 +00:00
res = results.flat()
2023-06-04 16:35:45 +00:00
await pool.terminate()
2023-05-30 15:02:20 +00:00
}
2023-07-23 18:49:26 +00:00
log.end(`Parsed ${res.length} Markdown files in ${perf.timeSince()}`)
2023-05-30 15:02:20 +00:00
return res
}