From 3ac6b42e16dca5a44ed3fec2c0314f1dbbc2322b Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 16 Jul 2023 06:02:12 +0000
Subject: [PATCH] finish path refactoring, add sourcemap + better trace support
---
quartz/processors/emit.ts | 135 ++++++++++++++++++++++++++++++++++++--------
1 files changed, 110 insertions(+), 25 deletions(-)
diff --git a/quartz/processors/emit.ts b/quartz/processors/emit.ts
index e6e734e..0276ad4 100644
--- a/quartz/processors/emit.ts
+++ b/quartz/processors/emit.ts
@@ -1,61 +1,146 @@
import path from "path"
import fs from "fs"
-import { QuartzConfig } from "../cfg"
+import { GlobalConfiguration, 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 { FilePath, QUARTZ, slugifyFilePath } from "../path"
import { globbyStream } from "globby"
+import chalk from "chalk"
-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"
+
+function addGlobalPageResources(cfg: GlobalConfiguration, staticResources: StaticResources, componentResources: ComponentResources) {
+ 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)`
+ )
+ }
+}
+
+export async function emitContent(contentFolder: string, output: string, cfg: QuartzConfig, content: ProcessedContent[], verbose: boolean) {
const perf = new PerfTimer()
+ const log = new QuartzLogger(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(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(cfg.configuration, staticResources, componentResources)
+
+ // emit in one go
+ const emittedResources = await emitComponentResources(cfg.configuration, componentResources, emit)
+ if (verbose) {
+ for (const file of emittedResources) {
+ console.log(`[emit:Resources] ${file}`)
+ }
+ }
+
+ // emitter plugins
let emittedFiles = 0
for (const emitter of cfg.plugins.emitters) {
- const emitted = await emitter.emit(content, staticResources, emit)
- emittedFiles += emitted.length
+ try {
+ const emitted = await emitter.emit(contentFolder, cfg.configuration, content, staticResources, emit)
+ emittedFiles += emitted.length
- if (verbose) {
- for (const file of emitted) {
- console.log(`[emit:${emitter.name}] ${file}`)
+ if (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)
+ process.exit(1)
}
}
const staticPath = path.join(QUARTZ, "static")
await fs.promises.cp(staticPath, path.join(output, "static"), { recursive: true })
+ if (verbose) {
+ console.log(`[emit:Static] ${path.join("static", "**")}`)
+ }
// 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 assetsPath = path.join(output, "assets")
+ for await (const rawFp of globbyStream("**", {
+ ignore: ["**/*.md"],
+ cwd: contentFolder,
})) {
- 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)
+ const fp = rawFp as FilePath
+ const ext = path.extname(fp)
+ const src = path.join(contentFolder, fp) as FilePath
+ const name = slugifyFilePath(fp as FilePath) + ext as FilePath
+ const dest = path.join(assetsPath, name) as FilePath
+ const dir = path.dirname(dest) as FilePath
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}`)
+ console.log(`[emit:Assets] ${path.join("assets", name)}`)
}
}
- if (verbose) {
- console.log(`[emit:Static] ${path.join(output, "static", "**")}`)
- console.log(`Emitted ${emittedFiles} files to \`${output}\` in ${perf.timeSince()}`)
- }
+ log.success(`Emitted ${emittedFiles} files to \`${output}\` in ${perf.timeSince()}`)
}
--
Gitblit v1.10.0