From dc62aeb213aa68051aaaf3ddc2f25be4e4d6d466 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Fri, 02 Feb 2024 07:55:40 +0000
Subject: [PATCH] pkg: bump to 4.2.0
---
quartz/build.ts | 242 ++++++++++++++++++++++++++++-------------------
1 files changed, 143 insertions(+), 99 deletions(-)
diff --git a/quartz/build.ts b/quartz/build.ts
index 9bd1e67..1f90301 100644
--- a/quartz/build.ts
+++ b/quartz/build.ts
@@ -1,29 +1,43 @@
-import "source-map-support/register.js"
+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, isGitIgnored } from "globby"
+import { GlobbyFilterFunction, 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 "./path"
+import { FilePath, FullSlug, joinSegments, slugifyFilePath } from "./util/path"
import chokidar from "chokidar"
import { ProcessedContent } from "./plugins/vfile"
-import WebSocket, { WebSocketServer } from "ws"
-import { Argv, BuildCtx } from "./ctx"
+import { Argv, BuildCtx } from "./util/ctx"
+import { glob, toPosixPath } from "./util/glob"
+import { trace } from "./util/trace"
+import { options } from "./util/sourcemap"
+import { Mutex } from "async-mutex"
-async function buildQuartz(argv: Argv, version: string) {
+type BuildData = {
+ ctx: BuildCtx
+ ignored: GlobbyFilterFunction
+ mut: Mutex
+ initialSlugs: FullSlug[]
+ // TODO merge contentMap and trackedAssets
+ contentMap: Map<FilePath, ProcessedContent>
+ trackedAssets: Set<FilePath>
+ toRebuild: Set<FilePath>
+ toRemove: Set<FilePath>
+ lastBuildMs: number
+}
+
+async function buildQuartz(argv: Argv, mut: Mutex, clientRefresh: () => void) {
const ctx: BuildCtx = {
argv,
cfg,
allSlugs: [],
}
- console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
const perf = new PerfTimer()
const output = argv.output
@@ -37,98 +51,57 @@
console.log(` Emitters: ${pluginNames("emitters").join(", ")}`)
}
+ const release = await mut.acquire()
perf.addEvent("clean")
await rimraf(output)
console.log(`Cleaned output directory \`${output}\` in ${perf.timeSince("clean")}`)
perf.addEvent("glob")
- const fps = (
- await globby("**/*.md", {
- cwd: argv.directory,
- ignore: cfg.configuration.ignorePatterns,
- gitignore: true,
- })
- ).map((fp) => fp.split(path.sep).join(path.posix.sep))
+ const allFiles = await glob("**/*.*", argv.directory, cfg.configuration.ignorePatterns)
+ const fps = allFiles.filter((fp) => fp.endsWith(".md")).sort()
console.log(
`Found ${fps.length} input files from \`${argv.directory}\` in ${perf.timeSince("glob")}`,
)
const filePaths = fps.map((fp) => joinSegments(argv.directory, fp) as FilePath)
- ctx.allSlugs = fps.map((fp) => slugifyFilePath(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()}`))
+ release()
if (argv.serve) {
- await startServing(ctx, parsedFiles)
+ return startServing(ctx, mut, parsedFiles, clientRefresh)
}
}
-async function startServing(ctx: BuildCtx, initialContent: ProcessedContent[]) {
+// setup watcher for rebuilds
+async function startServing(
+ ctx: BuildCtx,
+ mut: Mutex,
+ initialContent: ProcessedContent[],
+ clientRefresh: () => void,
+) {
const { argv } = ctx
- const wss = new WebSocketServer({ port: 3001 })
- const connections: WebSocket[] = []
- wss.on("connection", (ws) => connections.push(ws))
- 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)
}
- let timeoutId: ReturnType<typeof setTimeout> | null = null
- let toRebuild: Set<FilePath> = new Set()
- let toRemove: Set<FilePath> = new Set()
- async function rebuild(fp: string, action: "add" | "change" | "delete") {
- fp = fp.split(path.sep).join(path.posix.sep)
- if (!ignored(fp)) {
- const filePath = joinSegments(argv.directory, fp) as FilePath
- if (action === "add" || action === "change") {
- toRebuild.add(filePath)
- } else if (action === "delete") {
- toRemove.add(filePath)
- }
-
- if (timeoutId) {
- clearTimeout(timeoutId)
- }
-
- timeoutId = setTimeout(async () => {
- const perf = new PerfTimer()
- console.log(chalk.yellow("Detected change, rebuilding..."))
- try {
- const filesToRebuild = [...toRebuild].filter((fp) => !toRemove.has(fp))
-
- ctx.allSlugs = [...new Set([...contentMap.keys(), ...toRebuild])]
- .filter((fp) => !toRemove.has(fp))
- .map((fp) => slugifyFilePath(path.relative(argv.directory, fp) as FilePath))
-
- 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...`))
- }
- connections.forEach((conn) => conn.send("rebuild"))
- toRebuild.clear()
- toRemove.clear()
- }, 250)
- }
+ const buildData: BuildData = {
+ ctx,
+ mut,
+ contentMap,
+ ignored: await isGitIgnored(),
+ initialSlugs: ctx.allSlugs,
+ toRebuild: new Set<FilePath>(),
+ toRemove: new Set<FilePath>(),
+ trackedAssets: new Set<FilePath>(),
+ lastBuildMs: 0,
}
const watcher = chokidar.watch(".", {
@@ -138,34 +111,105 @@
})
watcher
- .on("add", (fp) => rebuild(fp, "add"))
- .on("change", (fp) => rebuild(fp, "change"))
- .on("unlink", (fp) => rebuild(fp, "delete"))
+ .on("add", (fp) => rebuildFromEntrypoint(fp, "add", clientRefresh, buildData))
+ .on("change", (fp) => rebuildFromEntrypoint(fp, "change", clientRefresh, buildData))
+ .on("unlink", (fp) => rebuildFromEntrypoint(fp, "delete", clientRefresh, buildData))
- const server = http.createServer(async (req, res) => {
- await serveHandler(req, res, {
- public: argv.output,
- directoryListing: false,
- })
- const status = res.statusCode
- const statusString =
- status >= 200 && status < 300
- ? chalk.green(`[${status}]`)
- : status >= 300 && status < 400
- ? chalk.yellow(`[${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 async () => {
+ await watcher.close()
+ }
}
-export default async (argv: Argv, version: string) => {
+async function rebuildFromEntrypoint(
+ fp: string,
+ action: "add" | "change" | "delete",
+ clientRefresh: () => void,
+ buildData: BuildData, // note: this function mutates buildData
+) {
+ const { ctx, ignored, mut, initialSlugs, contentMap, toRebuild, toRemove, trackedAssets } =
+ buildData
+
+ const { argv } = ctx
+
+ // 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)
+ }
+
+ const buildStart = new Date().getTime()
+ buildData.lastBuildMs = buildStart
+ const release = await mut.acquire()
+
+ // there's another build after us, release and let them do it
+ if (buildData.lastBuildMs > buildStart) {
+ release()
+ return
+ }
+
+ const perf = new PerfTimer()
+ console.log(chalk.yellow("Detected change, rebuilding..."))
try {
- await buildQuartz(argv, version)
- } catch {
- console.log(chalk.red("\nExiting Quartz due to a fatal error"))
- process.exit(1)
+ 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)
+ }
+
+ const parsedFiles = [...contentMap.values()]
+ const filteredContent = filterContent(ctx, parsedFiles)
+
+ // 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 emitContent(ctx, filteredContent)
+ console.log(chalk.green(`Done rebuilding in ${perf.timeSince()}`))
+ } catch (err) {
+ console.log(chalk.yellow(`Rebuild failed. Waiting on a change to fix the error...`))
+ if (argv.verbose) {
+ console.log(chalk.red(err))
+ }
+ }
+
+ release()
+ clientRefresh()
+ toRebuild.clear()
+ toRemove.clear()
+}
+
+export default async (argv: Argv, mut: Mutex, clientRefresh: () => void) => {
+ try {
+ return await buildQuartz(argv, mut, clientRefresh)
+ } catch (err) {
+ trace("\nExiting Quartz due to a fatal error", err as Error)
}
}
--
Gitblit v1.10.0