From 0998bc355e6425e6b2bdf3d2da7124aa7b63b2a2 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Thu, 17 Aug 2023 08:58:11 +0000
Subject: [PATCH] fix rebuild debouncing
---
quartz/build.ts | 187 +++++++++++++++++++++++++++++++++++-----------
1 files changed, 143 insertions(+), 44 deletions(-)
diff --git a/quartz/build.ts b/quartz/build.ts
index 36e3210..b5b1f9e 100644
--- a/quartz/build.ts
+++ b/quartz/build.ts
@@ -1,69 +1,168 @@
+import sourceMapSupport from "source-map-support"
+sourceMapSupport.install(options)
import path from "path"
-import { PerfTimer } from "./perf"
+import { PerfTimer } from "./util/perf"
import { rimraf } from "rimraf"
-import { globby } from "globby"
+import { isGitIgnored } from "globby"
import chalk from "chalk"
-import http from "http"
-import serveHandler from "serve-handler"
import { parseMarkdown } from "./processors/parse"
import { filterContent } from "./processors/filter"
import { emitContent } from "./processors/emit"
import cfg from "../quartz.config"
+import { FilePath, joinSegments, slugifyFilePath } from "./util/path"
+import chokidar from "chokidar"
+import { ProcessedContent } from "./plugins/vfile"
+import { Argv, BuildCtx } from "./util/ctx"
+import { glob, toPosixPath } from "./util/glob"
+import { trace } from "./util/trace"
+import { options } from "./util/sourcemap"
-interface Argv {
- directory: string
- verbose: boolean
- output: string
- serve: boolean
- port: number
-}
+async function buildQuartz(argv: Argv, clientRefresh: () => void) {
+ const ctx: BuildCtx = {
+ argv,
+ cfg,
+ allSlugs: [],
+ }
-export default async function buildQuartz(argv: Argv, version: string) {
- console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
const perf = new PerfTimer()
const output = argv.output
const pluginCount = Object.values(cfg.plugins).flat().length
- const pluginNames = (key: 'transformers' | 'filters' | 'emitters') => cfg.plugins[key].map(plugin => plugin.name)
+ const pluginNames = (key: "transformers" | "filters" | "emitters") =>
+ cfg.plugins[key].map((plugin) => plugin.name)
if (argv.verbose) {
console.log(`Loaded ${pluginCount} plugins`)
- console.log(` Transformers: ${pluginNames('transformers').join(", ")}`)
- console.log(` Filters: ${pluginNames('filters').join(", ")}`)
- console.log(` Emitters: ${pluginNames('emitters').join(", ")}`)
+ console.log(` Transformers: ${pluginNames("transformers").join(", ")}`)
+ console.log(` Filters: ${pluginNames("filters").join(", ")}`)
+ console.log(` Emitters: ${pluginNames("emitters").join(", ")}`)
}
- // clean
- perf.addEvent('clean')
+ perf.addEvent("clean")
await rimraf(output)
- console.log(`Cleaned output directory \`${output}\` in ${perf.timeSince('clean')}`)
+ console.log(`Cleaned output directory \`${output}\` in ${perf.timeSince("clean")}`)
- // glob
- perf.addEvent('glob')
- const fps = await globby('**/*.md', {
- cwd: argv.directory,
- ignore: cfg.configuration.ignorePatterns,
- gitignore: true,
- })
- console.log(`Found ${fps.length} input files from \`${argv.directory}\` in ${perf.timeSince('glob')}`)
+ perf.addEvent("glob")
+ const allFiles = await glob("**/*.*", argv.directory, cfg.configuration.ignorePatterns)
+ const fps = allFiles.filter((fp) => fp.endsWith(".md"))
+ console.log(
+ `Found ${fps.length} input files from \`${argv.directory}\` in ${perf.timeSince("glob")}`,
+ )
- const filePaths = fps.map(fp => `${argv.directory}${path.sep}${fp}`)
- const parsedFiles = await parseMarkdown(cfg.plugins.transformers, argv.directory, filePaths, argv.verbose)
- const filteredContent = filterContent(cfg.plugins.filters, parsedFiles, argv.verbose)
- await emitContent(argv.directory, output, cfg, filteredContent, argv.verbose)
+ const filePaths = fps.map((fp) => joinSegments(argv.directory, fp) as FilePath)
+ ctx.allSlugs = allFiles.map((fp) => slugifyFilePath(fp as FilePath))
+
+ const parsedFiles = await parseMarkdown(ctx, filePaths)
+ const filteredContent = filterContent(ctx, parsedFiles)
+ await emitContent(ctx, filteredContent)
console.log(chalk.green(`Done processing ${fps.length} files in ${perf.timeSince()}`))
if (argv.serve) {
- const server = http.createServer(async (req, res) => {
- await serveHandler(req, res, {
- public: output,
- directoryListing: false,
- })
- const status = res.statusCode
- const statusString = status === 200 ? chalk.green(`[${status}]`) : chalk.red(`[${status}]`)
- console.log(statusString + chalk.grey(` ${req.url}`))
- })
- server.listen(argv.port)
- console.log(chalk.cyan(`Started a Quartz server listening at http://localhost:${argv.port}`))
- console.log('hint: exit with ctrl+c')
+ return startServing(ctx, parsedFiles, clientRefresh)
+ }
+}
+
+// setup watcher for rebuilds
+async function startServing(
+ ctx: BuildCtx,
+ initialContent: ProcessedContent[],
+ clientRefresh: () => void,
+) {
+ const { argv } = ctx
+
+ const ignored = await isGitIgnored()
+ const contentMap = new Map<FilePath, ProcessedContent>()
+ for (const content of initialContent) {
+ const [_tree, vfile] = content
+ contentMap.set(vfile.data.filePath!, content)
+ }
+
+ const initialSlugs = ctx.allSlugs
+ let timeoutIds: Set<ReturnType<typeof setTimeout>> = new Set()
+ let toRebuild: Set<FilePath> = new Set()
+ let toRemove: Set<FilePath> = new Set()
+ let trackedAssets: Set<FilePath> = new Set()
+ async function rebuild(fp: string, action: "add" | "change" | "delete") {
+ // don't do anything for gitignored files
+ if (ignored(fp)) {
+ return
+ }
+
+ // dont bother rebuilding for non-content files, just track and refresh
+ fp = toPosixPath(fp)
+ const filePath = joinSegments(argv.directory, fp) as FilePath
+ if (path.extname(fp) !== ".md") {
+ if (action === "add" || action === "change") {
+ trackedAssets.add(filePath)
+ } else if (action === "delete") {
+ trackedAssets.delete(filePath)
+ }
+ clientRefresh()
+ return
+ }
+
+ if (action === "add" || action === "change") {
+ toRebuild.add(filePath)
+ } else if (action === "delete") {
+ toRemove.add(filePath)
+ }
+
+ timeoutIds.forEach((id) => clearTimeout(id))
+
+ // debounce rebuilds every 250ms
+ timeoutIds.add(
+ setTimeout(async () => {
+ const perf = new PerfTimer()
+ console.log(chalk.yellow("Detected change, rebuilding..."))
+ 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
+ contentMap.set(vfile.data.filePath!, content)
+ }
+
+ for (const fp of toRemove) {
+ contentMap.delete(fp)
+ }
+
+ await rimraf(argv.output)
+ const parsedFiles = [...contentMap.values()]
+ const filteredContent = filterContent(ctx, parsedFiles)
+ await emitContent(ctx, filteredContent)
+ console.log(chalk.green(`Done rebuilding in ${perf.timeSince()}`))
+ } catch {
+ console.log(chalk.yellow(`Rebuild failed. Waiting on a change to fix the error...`))
+ }
+
+ clientRefresh()
+ toRebuild.clear()
+ toRemove.clear()
+ }, 250),
+ )
+ }
+
+ const watcher = chokidar.watch(".", {
+ persistent: true,
+ cwd: argv.directory,
+ ignoreInitial: true,
+ })
+
+ watcher
+ .on("add", (fp) => rebuild(fp, "add"))
+ .on("change", (fp) => rebuild(fp, "change"))
+ .on("unlink", (fp) => rebuild(fp, "delete"))
+}
+
+export default async (argv: Argv, clientRefresh: () => void) => {
+ try {
+ return await buildQuartz(argv, clientRefresh)
+ } catch (err) {
+ trace("\nExiting Quartz due to a fatal error", err as Error)
}
}
--
Gitblit v1.10.0