| | |
| | | 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 "../util/path" |
| | | import { BuildCtx } from "../util/ctx" |
| | | |
| | | export interface PluginTypes { |
| | | transformers: QuartzTransformerPluginInstance[], |
| | | filters: QuartzFilterPluginInstance[], |
| | | emitters: QuartzEmitterPluginInstance[], |
| | | transformers: QuartzTransformerPluginInstance[] |
| | | filters: QuartzFilterPluginInstance[] |
| | | emitters: QuartzEmitterPluginInstance[] |
| | | } |
| | | |
| | | type OptionType = object | undefined |
| | | export type QuartzTransformerPlugin<Options extends OptionType = undefined> = (opts?: Options) => QuartzTransformerPluginInstance |
| | | export type QuartzTransformerPlugin<Options extends OptionType = undefined> = ( |
| | | opts?: Options, |
| | | ) => QuartzTransformerPluginInstance |
| | | export type QuartzTransformerPluginInstance = { |
| | | name: string |
| | | 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> = (opts?: Options) => QuartzFilterPluginInstance |
| | | export type QuartzFilterPlugin<Options extends OptionType = undefined> = ( |
| | | opts?: Options, |
| | | ) => QuartzFilterPluginInstance |
| | | export type QuartzFilterPluginInstance = { |
| | | name: string |
| | | shouldPublish(content: ProcessedContent): boolean |
| | | shouldPublish(ctx: BuildCtx, content: ProcessedContent): boolean |
| | | } |
| | | |
| | | export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (opts?: Options) => QuartzEmitterPluginInstance |
| | | export type QuartzEmitterPlugin<Options extends OptionType = undefined> = ( |
| | | opts?: Options, |
| | | ) => QuartzEmitterPluginInstance |
| | | export type QuartzEmitterPluginInstance = { |
| | | name: string |
| | | emit(contentDir: string, cfg: GlobalConfiguration, content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise<string[]> |
| | | getQuartzComponents(): QuartzComponent[] |
| | | emit( |
| | | ctx: BuildCtx, |
| | | content: ProcessedContent[], |
| | | resources: StaticResources, |
| | | emitCallback: EmitCallback, |
| | | ): Promise<FilePath[]> |
| | | getQuartzComponents(ctx: BuildCtx): QuartzComponent[] |
| | | } |
| | | |
| | | export interface EmitOptions { |
| | | slug: string |
| | | slug: ServerSlug |
| | | ext: `.${string}` | "" |
| | | content: string |
| | | } |
| | | |
| | | export type EmitCallback = (data: EmitOptions) => Promise<string> |
| | | export type EmitCallback = (data: EmitOptions) => Promise<FilePath> |