From 8fd75ffbfda30edd5a134a1fbf9b81ac3cebb2ff Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 24 Jul 2023 00:42:00 +0000
Subject: [PATCH] support attachments folder
---
quartz/processors/emit.ts | 154 ++++++++++++++++++++++++++++++++++++++------------
1 files changed, 116 insertions(+), 38 deletions(-)
diff --git a/quartz/processors/emit.ts b/quartz/processors/emit.ts
index e6e734e..ea7fda9 100644
--- a/quartz/processors/emit.ts
+++ b/quartz/processors/emit.ts
@@ -1,61 +1,139 @@
import path from "path"
import fs from "fs"
-import { QuartzConfig } from "../cfg"
import { PerfTimer } from "../perf"
-import { getStaticResourcesFromPlugins } from "../plugins"
+import {
+ ComponentResources,
+ emitComponentResources,
+ getComponentResources,
+ getStaticResourcesFromPlugins,
+} from "../plugins"
import { EmitCallback } from "../plugins/types"
import { ProcessedContent } from "../plugins/vfile"
-import { QUARTZ, slugify } from "../path"
-import { globbyStream } from "globby"
+import { FilePath } from "../path"
-export async function emitContent(output: string, cfg: QuartzConfig, content: ProcessedContent[], verbose: boolean) {
+// @ts-ignore
+import spaRouterScript from "../components/scripts/spa.inline"
+// @ts-ignore
+import plausibleScript from "../components/scripts/plausible.inline"
+// @ts-ignore
+import popoverScript from "../components/scripts/popover.inline"
+import popoverStyle from "../components/styles/popover.scss"
+import { StaticResources } from "../resources"
+import { QuartzLogger } from "../log"
+import { googleFontHref } from "../theme"
+import { trace } from "../trace"
+import { BuildCtx } from "../ctx"
+
+function addGlobalPageResources(
+ ctx: BuildCtx,
+ staticResources: StaticResources,
+ componentResources: ComponentResources,
+) {
+ const cfg = ctx.cfg.configuration
+ const reloadScript = ctx.argv.serve
+ staticResources.css.push(googleFontHref(cfg.theme))
+
+ // popovers
+ if (cfg.enablePopovers) {
+ componentResources.afterDOMLoaded.push(popoverScript)
+ componentResources.css.push(popoverStyle)
+ }
+
+ if (cfg.analytics?.provider === "google") {
+ const tagId = cfg.analytics.tagId
+ staticResources.js.push({
+ src: `https://www.googletagmanager.com/gtag/js?id=${tagId}`,
+ contentType: "external",
+ loadTime: "afterDOMReady",
+ })
+ componentResources.afterDOMLoaded.push(`
+ window.dataLayer = window.dataLayer || [];
+ function gtag() { dataLayer.push(arguments); }
+ gtag(\`js\`, new Date());
+ gtag(\`config\`, \`${tagId}\`, { send_page_view: false });
+
+ document.addEventListener(\`nav\`, () => {
+ gtag(\`event\`, \`page_view\`, {
+ page_title: document.title,
+ page_location: location.href,
+ });
+ });`)
+ } else if (cfg.analytics?.provider === "plausible") {
+ componentResources.afterDOMLoaded.push(plausibleScript)
+ }
+
+ // spa
+ if (cfg.enableSPA) {
+ componentResources.afterDOMLoaded.push(spaRouterScript)
+ } else {
+ componentResources.afterDOMLoaded.push(`
+ window.spaNavigate = (url, _) => window.location.assign(url)
+ const event = new CustomEvent("nav", { detail: { slug: document.body.dataset.slug } })
+ document.dispatchEvent(event)`)
+ }
+
+ if (reloadScript) {
+ staticResources.js.push({
+ loadTime: "afterDOMReady",
+ contentType: "inline",
+ script: `
+ const socket = new WebSocket('ws://localhost:3001')
+ socket.addEventListener('message', () => document.location.reload())
+ `,
+ })
+ }
+}
+
+export async function emitContent(ctx: BuildCtx, content: ProcessedContent[]) {
+ const { argv, cfg } = ctx
const perf = new PerfTimer()
+ const log = new QuartzLogger(ctx.argv.verbose)
-
- const staticResources = getStaticResourcesFromPlugins(cfg.plugins)
+ log.start(`Emitting output files`)
const emit: EmitCallback = async ({ slug, ext, content }) => {
- const pathToPage = path.join(output, slug + ext)
+ const pathToPage = path.join(argv.output, slug + ext) as FilePath
const dir = path.dirname(pathToPage)
await fs.promises.mkdir(dir, { recursive: true })
await fs.promises.writeFile(pathToPage, content)
return pathToPage
}
+ // initialize from plugins
+ const staticResources = getStaticResourcesFromPlugins(cfg.plugins)
+
+ // component specific scripts and styles
+ const componentResources = getComponentResources(cfg.plugins)
+
+ // important that this goes *after* component scripts
+ // as the "nav" event gets triggered here and we should make sure
+ // that everyone else had the chance to register a listener for it
+ addGlobalPageResources(ctx, staticResources, componentResources)
+
let emittedFiles = 0
+ const emittedResources = await emitComponentResources(cfg.configuration, componentResources, emit)
+ if (argv.verbose) {
+ for (const file of emittedResources) {
+ emittedFiles += 1
+ console.log(`[emit:Resources] ${file}`)
+ }
+ }
+
+ // emitter plugins
for (const emitter of cfg.plugins.emitters) {
- const emitted = await emitter.emit(content, staticResources, emit)
- emittedFiles += emitted.length
+ try {
+ const emitted = await emitter.emit(ctx, content, staticResources, emit)
+ emittedFiles += emitted.length
- if (verbose) {
- for (const file of emitted) {
- console.log(`[emit:${emitter.name}] ${file}`)
+ if (ctx.argv.verbose) {
+ for (const file of emitted) {
+ console.log(`[emit:${emitter.name}] ${file}`)
+ }
}
+ } catch (err) {
+ trace(`Failed to emit from plugin \`${emitter.name}\``, err as Error)
+ throw err
}
}
- const staticPath = path.join(QUARTZ, "static")
- await fs.promises.cp(staticPath, path.join(output, "static"), { recursive: true })
-
- // glob all non MD/MDX/HTML files in content folder and copy it over
- const assetsPath = path.join("public", "assets")
- for await (const fp of globbyStream("**", {
- ignore: ["**/*.{md,mdx,html}"],
- cwd: "./content",
- })) {
- const ext = path.extname(fp as string)
- const src = path.join("content", fp as string)
- const dest = path.join(assetsPath, slugify(fp as string) + ext)
- const dir = path.dirname(dest)
- await fs.promises.mkdir(dir, { recursive: true }) // ensure dir exists
- await fs.promises.copyFile(src, dest)
- emittedFiles += 1
- if (verbose) {
- console.log(`[emit:Assets] ${dest}`)
- }
- }
-
- if (verbose) {
- console.log(`[emit:Static] ${path.join(output, "static", "**")}`)
- console.log(`Emitted ${emittedFiles} files to \`${output}\` in ${perf.timeSince()}`)
- }
+ log.end(`Emitted ${emittedFiles} files to \`${argv.output}\` in ${perf.timeSince()}`)
}
--
Gitblit v1.10.0