Jacky Zhao
2023-08-19 c874e7e9378a5ba895870e9680484fb4af5c6e93
quartz/plugins/types.ts
@@ -1,10 +1,9 @@
import { PluggableList } from "unified"
import { StaticResources } from "../resources"
import { StaticResources } from "../util/resources"
import { ProcessedContent } from "./vfile"
import { GlobalConfiguration } from "../cfg"
import { QuartzComponent } from "../components/types"
import { FilePath, ServerSlug } from "../path"
import { BuildCtx } from "../ctx"
import { FilePath, FullSlug } from "../util/path"
import { BuildCtx } from "../util/ctx"
export interface PluginTypes {
  transformers: QuartzTransformerPluginInstance[]
@@ -18,10 +17,10 @@
) => QuartzTransformerPluginInstance
export type QuartzTransformerPluginInstance = {
  name: string
  textTransform?: (src: string | Buffer) => string | Buffer
  markdownPlugins?: () => PluggableList
  htmlPlugins?: () => PluggableList
  externalResources?: () => Partial<StaticResources>
  textTransform?: (ctx: BuildCtx, src: string | Buffer) => string | Buffer
  markdownPlugins?: (ctx: BuildCtx) => PluggableList
  htmlPlugins?: (ctx: BuildCtx) => PluggableList
  externalResources?: (ctx: BuildCtx) => Partial<StaticResources>
}
export type QuartzFilterPlugin<Options extends OptionType = undefined> = (
@@ -29,7 +28,7 @@
) => QuartzFilterPluginInstance
export type QuartzFilterPluginInstance = {
  name: string
  shouldPublish(content: ProcessedContent): boolean
  shouldPublish(ctx: BuildCtx, content: ProcessedContent): boolean
}
export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
@@ -43,11 +42,11 @@
    resources: StaticResources,
    emitCallback: EmitCallback,
  ): Promise<FilePath[]>
  getQuartzComponents(): QuartzComponent[]
  getQuartzComponents(ctx: BuildCtx): QuartzComponent[]
}
export interface EmitOptions {
  slug: ServerSlug
  slug: FullSlug
  ext: `.${string}` | ""
  content: string
}