refactor static and asset emission to be actual emitter plugins

quartz/processors/emit.ts

@@ -1,6 +1,5 @@
 import path from "path"
 import fs from "fs"
-import { GlobalConfiguration, QuartzConfig } from "../cfg"
 import { PerfTimer } from "../perf"
 import {
   ComponentResources,
@@ -10,8 +9,7 @@ import {
 } from "../plugins"
 import { EmitCallback } from "../plugins/types"
 import { ProcessedContent } from "../plugins/vfile"
-import { FilePath, QUARTZ, slugifyFilePath } from "../path"
-import { globbyStream } from "globby"
+import { FilePath } from "../path"
 
 // @ts-ignore
 import spaRouterScript from "../components/scripts/spa.inline"
@@ -24,13 +22,15 @@ import { StaticResources } from "../resources"
 import { QuartzLogger } from "../log"
 import { googleFontHref } from "../theme"
 import { trace } from "../trace"
+import { BuildCtx } from "../ctx"
 
 function addGlobalPageResources(
-  cfg: GlobalConfiguration,
-  reloadScript: boolean,
+  ctx: BuildCtx,
   staticResources: StaticResources,
   componentResources: ComponentResources,
 ) {
+  const cfg = ctx.cfg.configuration
+  const reloadScript = ctx.argv.serve
   staticResources.css.push(googleFontHref(cfg.theme))
 
   // popovers
@@ -85,19 +85,17 @@ function addGlobalPageResources(
 }
 
 export async function emitContent(
-  contentFolder: string,
-  output: string,
-  cfg: QuartzConfig,
+  ctx: BuildCtx,
   content: ProcessedContent[],
-  reloadScript: boolean,
-  verbose: boolean,
 ) {
+  const { argv, cfg }= ctx
+  const contentFolder = argv.directory
   const perf = new PerfTimer()
-  const log = new QuartzLogger(verbose)
+  const log = new QuartzLogger(ctx.argv.verbose)
 
   log.start(`Emitting output files`)
   const emit: EmitCallback = async ({ slug, ext, content }) => {
-    const pathToPage = path.join(output, slug + ext) as FilePath
+    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)
@@ -113,11 +111,11 @@ export async function emitContent(
   // 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, reloadScript, staticResources, componentResources)
+  addGlobalPageResources(ctx, staticResources, componentResources)
 
   let emittedFiles = 0
   const emittedResources = await emitComponentResources(cfg.configuration, componentResources, emit)
-  if (verbose) {
+  if (argv.verbose) {
     for (const file of emittedResources) {
       emittedFiles += 1
       console.log(`[emit:Resources] ${file}`)
@@ -128,15 +126,14 @@ export async function emitContent(
   for (const emitter of cfg.plugins.emitters) {
     try {
       const emitted = await emitter.emit(
-        contentFolder,
-        cfg.configuration,
+        ctx,
         content,
         staticResources,
         emit,
       )
       emittedFiles += emitted.length
 
-      if (verbose) {
+      if (ctx.argv.verbose) {
         for (const file of emitted) {
           console.log(`[emit:${emitter.name}] ${file}`)
         }
@@ -147,31 +144,5 @@ export async function emitContent(
     }
   }
 
-  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(output, "assets")
-  for await (const rawFp of globbyStream("**", {
-    ignore: ["**/*.md"],
-    cwd: contentFolder,
-  })) {
-    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] ${path.join("assets", name)}`)
-    }
-  }
-
-  log.end(`Emitted ${emittedFiles} files to \`${output}\` in ${perf.timeSince()}`)
+  log.end(`Emitted ${emittedFiles} files to \`${argv.output}\` in ${perf.timeSince()}`)
 }

quartz/processors/filter.ts

@@ -1,18 +1,18 @@
+import { BuildCtx } from "../ctx"
 import { PerfTimer } from "../perf"
 import { QuartzFilterPluginInstance } from "../plugins/types"
 import { ProcessedContent } from "../plugins/vfile"
 
 export function filterContent(
-  plugins: QuartzFilterPluginInstance[],
+  { cfg, argv }: BuildCtx,
   content: ProcessedContent[],
-  verbose: boolean,
 ): ProcessedContent[] {
   const perf = new PerfTimer()
   const initialLength = content.length
-  for (const plugin of plugins) {
+  for (const plugin of cfg.plugins.filters) {
     const updatedContent = content.filter(plugin.shouldPublish)
 
-    if (verbose) {
+    if (argv.verbose) {
       const diff = content.filter((x) => !updatedContent.includes(x))
       for (const file of diff) {
         console.log(`[filter:${plugin.name}] ${file[1].data.slug}`)

quartz/processors/parse.ts

@@ -14,6 +14,7 @@ import workerpool, { Promise as WorkerPromise } from "workerpool"
 import { QuartzTransformerPluginInstance } from "../plugins/types"
 import { QuartzLogger } from "../log"
 import { trace } from "../trace"
+import { BuildCtx } from "../ctx"
 
 export type QuartzProcessor = Processor<MDRoot, HTMLRoot, void>
 export function createProcessor(transformers: QuartzTransformerPluginInstance[]): QuartzProcessor {
@@ -72,13 +73,7 @@ async function transpileWorkerScript() {
   })
 }
 
-export function createFileParser(
-  transformers: QuartzTransformerPluginInstance[],
-  baseDir: string,
-  fps: FilePath[],
-  allSlugs: ServerSlug[],
-  verbose: boolean,
-) {
+export function createFileParser({ argv, cfg }: BuildCtx, fps: FilePath[], allSlugs: ServerSlug[]) {
   return async (processor: QuartzProcessor) => {
     const res: ProcessedContent[] = []
     for (const fp of fps) {
@@ -89,12 +84,12 @@ export function createFileParser(
         file.value = file.value.toString().trim()
 
         // Text -> Text transforms
-        for (const plugin of transformers.filter((p) => p.textTransform)) {
+        for (const plugin of cfg.plugins.transformers.filter((p) => p.textTransform)) {
           file.value = plugin.textTransform!(file.value)
         }
 
         // base data properties that plugins may use
-        file.data.slug = slugifyFilePath(path.relative(baseDir, file.path) as FilePath)
+        file.data.slug = slugifyFilePath(path.relative(argv.directory, file.path) as FilePath)
         file.data.allSlugs = allSlugs
         file.data.filePath = fp
 
@@ -102,7 +97,7 @@ export function createFileParser(
         const newAst = await processor.run(ast, file)
         res.push([newAst, file])
 
-        if (verbose) {
+        if (argv.verbose) {
           console.log(`[process] ${fp} -> ${file.data.slug}`)
         }
       } catch (err) {
@@ -115,29 +110,25 @@ export function createFileParser(
   }
 }
 
-export async function parseMarkdown(
-  transformers: QuartzTransformerPluginInstance[],
-  baseDir: string,
-  fps: FilePath[],
-  verbose: boolean,
-): Promise<ProcessedContent[]> {
+export async function parseMarkdown(ctx: BuildCtx, fps: FilePath[]): Promise<ProcessedContent[]> {
+  const { argv, cfg } = ctx
   const perf = new PerfTimer()
-  const log = new QuartzLogger(verbose)
+  const log = new QuartzLogger(argv.verbose)
 
   const CHUNK_SIZE = 128
   let concurrency = fps.length < CHUNK_SIZE ? 1 : os.availableParallelism()
 
   // get all slugs ahead of time as each thread needs a copy
   const allSlugs = fps.map((fp) =>
-    slugifyFilePath(path.relative(baseDir, path.resolve(fp)) as FilePath),
+    slugifyFilePath(path.relative(argv.directory, path.resolve(fp)) as FilePath),
   )
 
   let res: ProcessedContent[] = []
   log.start(`Parsing input files using ${concurrency} threads`)
   if (concurrency === 1) {
     try {
-      const processor = createProcessor(transformers)
-      const parse = createFileParser(transformers, baseDir, fps, allSlugs, verbose)
+      const processor = createProcessor(cfg.plugins.transformers)
+      const parse = createFileParser(ctx, fps, allSlugs)
       res = await parse(processor)
     } catch (error) {
       log.end()
@@ -153,7 +144,7 @@ export async function parseMarkdown(
 
     const childPromises: WorkerPromise<ProcessedContent[]>[] = []
     for (const chunk of chunks(fps, CHUNK_SIZE)) {
-      childPromises.push(pool.exec("parseFiles", [baseDir, chunk, allSlugs, verbose]))
+      childPromises.push(pool.exec("parseFiles", [argv, chunk, allSlugs]))
     }
 
     const results: ProcessedContent[][] = await WorkerPromise.all(childPromises)