Jacky Zhao
2023-06-12 352075ae81a3304a7bfa2512ef69b1cdacb26c12
refactor plugins to be functions instead of classes
20 files modified
379 ■■■■■ changed files
package-lock.json 19 ●●●●● patch | view | raw | blame | history
package.json 4 ●●● patch | view | raw | blame | history
quartz.config.ts 22 ●●●● patch | view | raw | blame | history
quartz/components/TableOfContents.tsx 11 ●●●● patch | view | raw | blame | history
quartz/components/types.ts 3 ●●●● patch | view | raw | blame | history
quartz/plugins/emitters/contentPage.tsx 26 ●●●● patch | view | raw | blame | history
quartz/plugins/filters/draft.ts 9 ●●●●● patch | view | raw | blame | history
quartz/plugins/filters/explicit.ts 9 ●●●●● patch | view | raw | blame | history
quartz/plugins/transformers/description.ts 24 ●●●●● patch | view | raw | blame | history
quartz/plugins/transformers/frontmatter.ts 24 ●●●●● patch | view | raw | blame | history
quartz/plugins/transformers/gfm.ts 31 ●●●● patch | view | raw | blame | history
quartz/plugins/transformers/lastmod.ts 27 ●●●●● patch | view | raw | blame | history
quartz/plugins/transformers/latex.ts 20 ●●●●● patch | view | raw | blame | history
quartz/plugins/transformers/links.ts 26 ●●●●● patch | view | raw | blame | history
quartz/plugins/transformers/ofm.ts 28 ●●●●● patch | view | raw | blame | history
quartz/plugins/transformers/syntax.ts 15 ●●●●● patch | view | raw | blame | history
quartz/plugins/transformers/toc.ts 30 ●●●●● patch | view | raw | blame | history
quartz/plugins/types.ts 41 ●●●●● patch | view | raw | blame | history
quartz/processors/filter.ts 4 ●●●● patch | view | raw | blame | history
quartz/processors/parse.ts 6 ●●●● patch | view | raw | blame | history
package-lock.json
@@ -14,7 +14,6 @@
        "chalk": "^4.1.2",
        "cli-spinner": "^0.2.10",
        "esbuild-sass-plugin": "^2.9.0",
        "flamethrower-router": "^0.0.0-meme.12",
        "github-slugger": "^2.0.0",
        "globby": "^13.1.4",
        "gray-matter": "^4.0.3",
@@ -22,9 +21,12 @@
        "hast-util-to-string": "^2.0.0",
        "is-absolute-url": "^4.0.1",
        "mdast-util-find-and-replace": "^2.2.2",
        "mdast-util-to-string": "^3.2.0",
        "micromorph": "^0.4.5",
        "preact": "^10.14.1",
        "preact-render-to-string": "^6.0.3",
        "pretty-time": "^1.1.0",
        "reading-time": "^1.5.0",
        "rehype-autolink-headings": "^6.1.1",
        "rehype-katex": "^6.0.3",
        "rehype-pretty-code": "^0.9.6",
@@ -1523,11 +1525,6 @@
        "node": ">=8"
      }
    },
    "node_modules/flamethrower-router": {
      "version": "0.0.0-meme.12",
      "resolved": "https://registry.npmjs.org/flamethrower-router/-/flamethrower-router-0.0.0-meme.12.tgz",
      "integrity": "sha512-PWcNrjzItwk61RTk/SbbKJNcAgl6qCXH8xkZjGjUGV/dgKAnURci+k+Yk8emubUQWTdAd1kSqujy0VRjoeEgxg=="
    },
    "node_modules/foreground-child": {
      "version": "3.1.1",
      "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz",
@@ -3006,6 +3003,11 @@
        "node": ">=8.6"
      }
    },
    "node_modules/micromorph": {
      "version": "0.4.5",
      "resolved": "https://registry.npmjs.org/micromorph/-/micromorph-0.4.5.tgz",
      "integrity": "sha512-Erasr0xiDvDeEhh7B/k7RFTwwfaAX10D7BMorNpokkwDh6XsRLYWDPaWF1m5JQeMSkGdqlEtQ8s68NcdDWuGgw=="
    },
    "node_modules/mime-db": {
      "version": "1.33.0",
      "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.33.0.tgz",
@@ -3268,6 +3270,11 @@
        "node": ">=8.10.0"
      }
    },
    "node_modules/reading-time": {
      "version": "1.5.0",
      "resolved": "https://registry.npmjs.org/reading-time/-/reading-time-1.5.0.tgz",
      "integrity": "sha512-onYyVhBNr4CmAxFsKS7bz+uTLRakypIe4R+5A824vBSkQy/hB3fZepoVEf8OVAxzLvK+H/jm9TzpI3ETSm64Kg=="
    },
    "node_modules/rehype-autolink-headings": {
      "version": "6.1.1",
      "resolved": "https://registry.npmjs.org/rehype-autolink-headings/-/rehype-autolink-headings-6.1.1.tgz",
package.json
@@ -30,7 +30,6 @@
    "chalk": "^4.1.2",
    "cli-spinner": "^0.2.10",
    "esbuild-sass-plugin": "^2.9.0",
    "flamethrower-router": "^0.0.0-meme.12",
    "github-slugger": "^2.0.0",
    "globby": "^13.1.4",
    "gray-matter": "^4.0.3",
@@ -38,9 +37,12 @@
    "hast-util-to-string": "^2.0.0",
    "is-absolute-url": "^4.0.1",
    "mdast-util-find-and-replace": "^2.2.2",
    "mdast-util-to-string": "^3.2.0",
    "micromorph": "^0.4.5",
    "preact": "^10.14.1",
    "preact-render-to-string": "^6.0.3",
    "pretty-time": "^1.1.0",
    "reading-time": "^1.5.0",
    "rehype-autolink-headings": "^6.1.1",
    "rehype-katex": "^6.0.3",
    "rehype-pretty-code": "^0.9.6",
quartz.config.ts
@@ -39,23 +39,23 @@
  },
  plugins: {
    transformers: [
      new Plugin.FrontMatter(),
      new Plugin.Description(),
      new Plugin.TableOfContents({ showByDefault: true }),
      new Plugin.CreatedModifiedDate({
      Plugin.FrontMatter(),
      Plugin.Description(),
      Plugin.TableOfContents({ showByDefault: true }),
      Plugin.CreatedModifiedDate({
        priority: ['frontmatter', 'filesystem'] // you can add 'git' here for last modified from Git but this makes the build slower
      }),
      new Plugin.GitHubFlavoredMarkdown(),
      new Plugin.ObsidianFlavoredMarkdown(),
      new Plugin.ResolveLinks(),
      new Plugin.SyntaxHighlighting(),
      new Plugin.Katex(),
      Plugin.GitHubFlavoredMarkdown(),
      Plugin.ObsidianFlavoredMarkdown(),
      Plugin.ResolveLinks(),
      Plugin.SyntaxHighlighting(),
      Plugin.Katex(),
    ],
    filters: [
      new Plugin.RemoveDrafts()
      Plugin.RemoveDrafts()
    ],
    emitters: [
      new Plugin.ContentPage({
      Plugin.ContentPage({
        head: Component.Head,
        header: [Component.PageTitle, Component.Spacer, Component.Darkmode],
        body: [Component.ArticleTitle, Component.ReadingTime, Component.TableOfContents, Component.Content]
quartz/components/TableOfContents.tsx
@@ -1,24 +1,19 @@
import { QuartzComponentProps } from "./types"
import style from "./styles/toc.scss"
export default function TableOfContents({ fileData, position }: QuartzComponentProps) {
export default function TableOfContents({ fileData }: QuartzComponentProps) {
  if (!fileData.toc) {
    return null
  }
  if (position === 'body') {
    // TODO: animate this
    return <details className="toc" open>
  return <details class="toc" open>
      <summary><h3>Table of Contents</h3></summary>
      <ul>
        {fileData.toc.map(tocEntry => <li key={tocEntry.slug} className={`depth-${tocEntry.depth}`}>
      {fileData.toc.map(tocEntry => <li key={tocEntry.slug} class={`depth-${tocEntry.depth}`}>
          <a href={`#${tocEntry.slug}`}>{tocEntry.text}</a>
        </li>)}
      </ul>
    </details>
  } else if (position === 'sidebar') {
    // TODO
  }
}
TableOfContents.css = style
quartz/components/types.ts
@@ -10,7 +10,6 @@
  cfg: GlobalConfiguration
  children: QuartzComponent[] | JSX.Element[]
  tree: Node<QuartzPluginData>
  position?: 'sidebar' | 'header' | 'body'
}
export type QuartzComponent = ComponentType<QuartzComponentProps> & {
@@ -18,3 +17,5 @@
  beforeDOMLoaded?: string,
  afterDOMLoaded?: string,
}
export type QuartzComponentConstructor<Options extends object> = (opts: Options) => QuartzComponent
quartz/plugins/emitters/contentPage.tsx
@@ -15,23 +15,20 @@
  body: QuartzComponent[]
}
export class ContentPage extends QuartzEmitterPlugin {
  name = "ContentPage"
  opts: Options
  constructor(opts: Options) {
    super()
    this.opts = opts
export const ContentPage: QuartzEmitterPlugin<Options> = (opts) => {
  if (!opts) {
    throw new Error("ContentPage must be initialized with options specifiying the components to use")
  }
  getQuartzComponents(): QuartzComponent[] {
    return [this.opts.head, Header, ...this.opts.header, ...this.opts.body]
  }
  return {
    name: "ContentPage",
    getQuartzComponents() {
      return [opts.head, Header, ...opts.header, ...opts.body]
    },
  async emit(cfg: GlobalConfiguration, content: ProcessedContent[], resources: StaticResources, emit: EmitCallback): Promise<string[]> {
    const fps: string[] = []
    const { head: Head, header, body } = this.opts
      const { head: Head, header, body } = opts
    for (const [tree, file] of content) {
      const baseDir = resolveToRoot(file.data.slug!)
      const pageResources: StaticResources = {
@@ -56,10 +53,10 @@
        <body>
          <div id="quartz-root" class="page">
            <Header {...componentData} >
              {header.map(HeaderComponent => <HeaderComponent {...componentData} position="header" />)}
                {header.map(HeaderComponent => <HeaderComponent {...componentData} />)}
            </Header>
            <Body {...componentData}>
              {body.map(BodyComponent => <BodyComponent {...componentData } position="body" />)}
                {body.map(BodyComponent => <BodyComponent {...componentData} />)}
            </Body>
          </div>
        </body>
@@ -78,3 +75,4 @@
    return fps
  }
}
}
quartz/plugins/filters/draft.ts
@@ -1,10 +1,9 @@
import { QuartzFilterPlugin } from "../types"
import { ProcessedContent } from "../vfile"
export class RemoveDrafts extends QuartzFilterPlugin {
  name = "RemoveDrafts"
  shouldPublish([_tree, vfile]: ProcessedContent): boolean {
export const RemoveDrafts: QuartzFilterPlugin<{}> = () => ({
  name: "RemoveDrafts",
  shouldPublish([_tree, vfile]) {
    const draftFlag: boolean = vfile.data?.frontmatter?.draft ?? false
    return !draftFlag
  }
}
})
quartz/plugins/filters/explicit.ts
@@ -1,10 +1,9 @@
import { QuartzFilterPlugin } from "../types"
import { ProcessedContent } from "../vfile"
export class ExplicitPublish extends QuartzFilterPlugin {
  name = "ExplicitPublish"
  shouldPublish([_tree, vfile]: ProcessedContent): boolean {
export const ExplicitPublish: QuartzFilterPlugin = () => ({
  name: "ExplicitPublish",
  shouldPublish([_tree, vfile]) {
    const publishFlag: boolean = vfile.data?.frontmatter?.publish ?? false
    return publishFlag
  }
}
})
quartz/plugins/transformers/description.ts
@@ -1,4 +1,3 @@
import { PluggableList } from "unified"
import { Root as HTMLRoot } from 'hast'
import { toString } from "hast-util-to-string"
import { QuartzTransformerPlugin } from "../types"
@@ -11,20 +10,14 @@
  descriptionLength: 150
}
export class Description extends QuartzTransformerPlugin {
  name = "Description"
  opts: Options
  constructor(opts?: Partial<Options>) {
    super()
    this.opts = { ...defaultOptions, ...opts }
  }
  markdownPlugins(): PluggableList {
export const Description: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "Description",
    markdownPlugins() {
    return []
  }
  htmlPlugins(): PluggableList {
    },
    htmlPlugins() {
    return [
      () => {
        return async (tree: HTMLRoot, file) => {
@@ -35,7 +28,7 @@
          const sentences = desc.replace(/\s+/g, ' ').split('.')
          let finalDesc = ""
          let sentenceIdx = 0
          const len = this.opts.descriptionLength
            const len = opts.descriptionLength
          while (finalDesc.length < len) {
            finalDesc += sentences[sentenceIdx] + '.'
            sentenceIdx++
@@ -48,6 +41,7 @@
    ]
  }
}
}
declare module 'vfile' {
  interface DataMap {
quartz/plugins/transformers/frontmatter.ts
@@ -1,4 +1,3 @@
import { PluggableList } from "unified"
import matter from "gray-matter"
import remarkFrontmatter from 'remark-frontmatter'
import { QuartzTransformerPlugin } from "../types"
@@ -13,21 +12,16 @@
  delims: '---'
}
export class FrontMatter extends QuartzTransformerPlugin {
  name = "FrontMatter"
  opts: Options
  constructor(opts?: Partial<Options>) {
    super()
    this.opts = { ...defaultOptions, ...opts }
  }
  markdownPlugins(): PluggableList {
export const FrontMatter: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "FrontMatter",
    markdownPlugins() {
    return [
      remarkFrontmatter,
      () => {
        return (_, file) => {
          const { data } = matter(file.value, this.opts)
            const { data } = matter(file.value, opts)
          // fill in frontmatter
          file.data.frontmatter = {
@@ -38,12 +32,12 @@
        }
      }
    ]
  }
  htmlPlugins(): PluggableList {
    },
    htmlPlugins() {
    return []
  }
}
}
declare module 'vfile' {
  interface DataMap {
quartz/plugins/transformers/gfm.ts
@@ -15,27 +15,24 @@
  linkHeadings: true
}
export class GitHubFlavoredMarkdown extends QuartzTransformerPlugin {
  name = "GitHubFlavoredMarkdown"
  opts: Options
  constructor(opts?: Partial<Options>) {
    super()
    this.opts = { ...defaultOptions, ...opts }
  }
  markdownPlugins(): PluggableList {
    return this.opts.enableSmartyPants ? [remarkGfm] : [remarkGfm, smartypants]
  }
  htmlPlugins(): PluggableList {
    return this.opts.linkHeadings
      ? [rehypeSlug, [rehypeAutolinkHeadings, {
export const GitHubFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "GitHubFlavoredMarkdown",
    markdownPlugins() {
      return opts.enableSmartyPants ? [remarkGfm] : [remarkGfm, smartypants]
    },
    htmlPlugins() {
      if (opts.linkHeadings) {
        return [rehypeSlug, [rehypeAutolinkHeadings, {
        behavior: 'append', content: {
          type: 'text',
          value: ' Â§'
        }
      }]]
      : []
      } else {
        return []
      }
    }
  }
}
quartz/plugins/transformers/lastmod.ts
@@ -1,4 +1,3 @@
import { PluggableList } from "unified"
import fs from "fs"
import path from 'path'
import { Repository } from "@napi-rs/simple-git"
@@ -12,19 +11,11 @@
  priority: ['frontmatter', 'git', 'filesystem']
}
export class CreatedModifiedDate extends QuartzTransformerPlugin {
  name = "CreatedModifiedDate"
  opts: Options
  constructor(opts?: Partial<Options>) {
    super()
    this.opts = {
      ...defaultOptions,
      ...opts,
    }
  }
  markdownPlugins(): PluggableList {
export const CreatedModifiedDate: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "CreatedModifiedDate",
    markdownPlugins() {
    return [
      () => {
        let repo: Repository | undefined = undefined
@@ -34,7 +25,7 @@
          let published: undefined | Date = undefined
          const fp = path.join(file.cwd, file.data.filePath as string)
          for (const source of this.opts.priority) {
            for (const source of opts.priority) {
            if (source === "filesystem") {
              const st = await fs.promises.stat(fp)
              created ||= new Date(st.birthtimeMs)
@@ -61,12 +52,12 @@
        }
      }
    ]
  }
  htmlPlugins(): PluggableList {
    },
    htmlPlugins() {
    return []
  }
}
}
declare module 'vfile' {
  interface DataMap {
quartz/plugins/transformers/latex.ts
@@ -1,24 +1,20 @@
import { PluggableList } from "unified"
import remarkMath from "remark-math"
import rehypeKatex from 'rehype-katex'
import { StaticResources } from "../../resources"
import { QuartzTransformerPlugin } from "../types"
export class Katex extends QuartzTransformerPlugin {
  name = "Katex"
  markdownPlugins(): PluggableList {
export const Katex: QuartzTransformerPlugin = () => ({
  name: "Katex",
  markdownPlugins() {
    return [remarkMath]
  }
  htmlPlugins(): PluggableList {
  },
  htmlPlugins() {
    return [
      [rehypeKatex, {
        output: 'html',
      }]
    ]
  }
  externalResources: Partial<StaticResources> = {
  },
  externalResources: {
    css: [
      // base css
      "https://cdn.jsdelivr.net/npm/katex@0.16.0/dist/katex.min.css",
@@ -31,4 +27,4 @@
      }
    ]
  }
}
})
quartz/plugins/transformers/links.ts
@@ -1,4 +1,3 @@
import { PluggableList } from "unified"
import { QuartzTransformerPlugin } from "../types"
import { relative, relativeToRoot, slugify } from "../../path"
import path from "path"
@@ -17,26 +16,20 @@
  prettyLinks: true
}
export class ResolveLinks extends QuartzTransformerPlugin {
  name = "LinkProcessing"
  opts: Options
  constructor(opts?: Partial<Options>) {
    super()
    this.opts = { ...defaultOptions, ...opts }
  }
  markdownPlugins(): PluggableList {
export const ResolveLinks: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "LinkProcessing",
    markdownPlugins() {
    return []
  }
  htmlPlugins(): PluggableList {
    },
    htmlPlugins() {
    return [() => {
      return (tree, file) => {
        const curSlug = file.data.slug!
        const transformLink = (target: string) => {
          const targetSlug = slugify(decodeURI(target).trim())
          if (this.opts.markdownLinkResolution === 'relative' && !path.isAbsolute(targetSlug)) {
            if (opts.markdownLinkResolution === 'relative' && !path.isAbsolute(targetSlug)) {
            return './' + relative(curSlug, targetSlug)
          } else {
            return './' + relativeToRoot(curSlug, targetSlug)
@@ -58,7 +51,7 @@
            }
            // rewrite link internals if prettylinks is on
            if (this.opts.prettyLinks && node.children.length === 1 && node.children[0].type === 'text') {
              if (opts.prettyLinks && node.children.length === 1 && node.children[0].type === 'text') {
              node.children[0].value = path.basename(node.children[0].value)
            }
          }
@@ -79,3 +72,4 @@
    }]
  }
}
}
quartz/plugins/transformers/ofm.ts
@@ -89,19 +89,13 @@
  return s.substring(0, 1).toUpperCase() + s.substring(1);
}
export class ObsidianFlavoredMarkdown extends QuartzTransformerPlugin {
  name = "ObsidianFlavoredMarkdown"
  opts: Options
  constructor(opts?: Partial<Options>) {
    super()
    this.opts = { ...defaultOptions, ...opts }
  }
  markdownPlugins(): PluggableList {
export const ObsidianFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "ObsidianFlavoredMarkdown",
    markdownPlugins() {
    const plugins: PluggableList = []
    if (this.opts.wikilinks) {
      if (opts.wikilinks) {
      plugins.push(() => {
        // Match wikilinks 
        // !?               -> optional embedding
@@ -169,7 +163,7 @@
      )
    }
    if (this.opts.highlight) {
      if (opts.highlight) {
      plugins.push(() => {
        // Match highlights 
        const highlightRegex = new RegExp(/==(.+)==/, "g")
@@ -185,7 +179,7 @@
      })
    }
    if (this.opts.callouts) {
      if (opts.callouts) {
      plugins.push(() => {
        // from https://github.com/escwxyz/remark-obsidian-callout/blob/main/src/index.ts
        const calloutRegex = new RegExp(/^\[\!(\w+)\]([+-]?)/)
@@ -252,11 +246,11 @@
        }
      })
    }
    return plugins
  }
    },
  htmlPlugins(): PluggableList {
    htmlPlugins() {
    return [rehypeRaw]
  }
}
}
quartz/plugins/transformers/syntax.ts
@@ -1,15 +1,12 @@
import { PluggableList } from "unified"
import { QuartzTransformerPlugin } from "../types"
import rehypePrettyCode, { Options as CodeOptions } from "rehype-pretty-code"
export class SyntaxHighlighting extends QuartzTransformerPlugin {
  name = "SyntaxHighlighting"
  markdownPlugins(): PluggableList {
export const SyntaxHighlighting: QuartzTransformerPlugin = () => ({
  name: "SyntaxHighlighting",
  markdownPlugins() {
    return []
  }
  htmlPlugins(): PluggableList {
  },
  htmlPlugins() {
    return [[rehypePrettyCode, {
      theme: 'css-variables',
      onVisitLine(node) {
@@ -25,4 +22,4 @@
      },
    } satisfies Partial<CodeOptions>]]
  }
}
})
quartz/plugins/transformers/toc.ts
@@ -1,4 +1,3 @@
import { PluggableList } from "unified"
import { QuartzTransformerPlugin } from "../types"
import { Root } from "mdast"
import { visit } from "unist-util-visit"
@@ -23,24 +22,19 @@
  slug: string
}
export class TableOfContents extends QuartzTransformerPlugin {
  name = "TableOfContents"
  opts: Options
  constructor(opts?: Partial<Options>) {
    super()
    this.opts = { ...defaultOptions, ...opts }
  }
  markdownPlugins(): PluggableList {
export const TableOfContents: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "TableOfContents",
    markdownPlugins() {
    return [() => {
      return async (tree: Root, file) => {
        const display = file.data.frontmatter?.enableToc ?? this.opts.showByDefault
          const display = file.data.frontmatter?.enableToc ?? opts.showByDefault
        if (display) {
          const toc: TocEntry[] = []
          let highestDepth: number = this.opts.maxDepth
            let highestDepth: number = opts.maxDepth
          visit(tree, 'heading', (node) => {
            if (node.depth <= this.opts.maxDepth) {
              if (node.depth <= opts.maxDepth) {
              const text = toString(node)
              highestDepth = Math.min(highestDepth, node.depth)
              toc.push({
@@ -51,18 +45,18 @@
            }
          })
          if (toc.length > this.opts.minEntries) {
            if (toc.length > opts.minEntries) {
            file.data.toc = toc.map(entry => ({ ...entry, depth: entry.depth - highestDepth }))
          }
        }
      }
    }]
  }
  htmlPlugins(): PluggableList {
    },
    htmlPlugins() {
    return []
  }
}
}
declare module 'vfile' {
  interface DataMap {
quartz/plugins/types.ts
@@ -4,16 +4,32 @@
import { GlobalConfiguration } from "../cfg"
import { QuartzComponent } from "../components/types"
export abstract class QuartzTransformerPlugin {
  abstract name: string
  abstract markdownPlugins(): PluggableList
  abstract htmlPlugins(): PluggableList
export interface PluginTypes {
  transformers: QuartzTransformerPluginInstance[],
  filters: QuartzFilterPluginInstance[],
  emitters: QuartzEmitterPluginInstance[],
}
type OptionType = object | undefined
export type QuartzTransformerPlugin<Options extends OptionType = undefined> = (opts?: Options) => QuartzTransformerPluginInstance
export type QuartzTransformerPluginInstance = {
  name: string
  markdownPlugins(): PluggableList
  htmlPlugins(): PluggableList
  externalResources?: Partial<StaticResources>
}
export abstract class QuartzFilterPlugin {
  abstract name: string
  abstract shouldPublish(content: ProcessedContent): boolean
export type QuartzFilterPlugin<Options extends OptionType = undefined> = (opts?: Options) => QuartzFilterPluginInstance
export type QuartzFilterPluginInstance = {
  name: string
  shouldPublish(content: ProcessedContent): boolean
}
export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (opts?: Options) => QuartzEmitterPluginInstance
export type QuartzEmitterPluginInstance = {
  name: string
  emit(cfg: GlobalConfiguration, content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise<string[]>
  getQuartzComponents(): QuartzComponent[]
}
export interface EmitOptions {
@@ -23,14 +39,3 @@
}
export type EmitCallback = (data: EmitOptions) => Promise<string>
export abstract class QuartzEmitterPlugin {
  abstract name: string
  abstract emit(cfg: GlobalConfiguration, content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise<string[]>
  abstract getQuartzComponents(): QuartzComponent[]
}
export interface PluginTypes {
  transformers: QuartzTransformerPlugin[],
  filters: QuartzFilterPlugin[],
  emitters: QuartzEmitterPlugin[],
}
quartz/processors/filter.ts
@@ -1,8 +1,8 @@
import { PerfTimer } from "../perf"
import { QuartzFilterPlugin } from "../plugins/types"
import { QuartzFilterPluginInstance } from "../plugins/types"
import { ProcessedContent } from "../plugins/vfile"
export function filterContent(plugins: QuartzFilterPlugin[], content: ProcessedContent[], verbose: boolean): ProcessedContent[] {
export function filterContent(plugins: QuartzFilterPluginInstance[], content: ProcessedContent[], verbose: boolean): ProcessedContent[] {
  const perf = new PerfTimer()
  const initialLength = content.length
  for (const plugin of plugins) {
quartz/processors/parse.ts
@@ -11,12 +11,12 @@
import path from 'path'
import os from 'os'
import workerpool, { Promise as WorkerPromise } from 'workerpool'
import { QuartzTransformerPlugin } from '../plugins/types'
import { QuartzTransformerPluginInstance } from '../plugins/types'
import { QuartzLogger } from '../log'
import chalk from 'chalk'
export type QuartzProcessor = Processor<MDRoot, HTMLRoot, void>
export function createProcessor(transformers: QuartzTransformerPlugin[]): QuartzProcessor {
export function createProcessor(transformers: QuartzTransformerPluginInstance[]): QuartzProcessor {
  // base Markdown -> MD AST
  let processor = unified().use(remarkParse)
@@ -101,7 +101,7 @@
  }
}
export async function parseMarkdown(transformers: QuartzTransformerPlugin[], baseDir: string, fps: string[], verbose: boolean): Promise<ProcessedContent[]> {
export async function parseMarkdown(transformers: QuartzTransformerPluginInstance[], baseDir: string, fps: string[], verbose: boolean): Promise<ProcessedContent[]> {
  const perf = new PerfTimer()
  const log = new QuartzLogger(verbose)