roadmap/quartz/plugins/types.ts

37 lines
1.1 KiB
TypeScript
Raw Normal View History

2023-05-30 15:02:20 +00:00
import { PluggableList } from "unified"
import { StaticResources } from "../resources"
import { ProcessedContent } from "./vfile"
2023-06-01 21:35:31 +00:00
import { GlobalConfiguration } from "../cfg"
2023-06-03 19:07:19 +00:00
import { QuartzComponent } from "../components/types"
2023-05-30 15:02:20 +00:00
export abstract class QuartzTransformerPlugin {
abstract name: string
abstract markdownPlugins(): PluggableList
abstract htmlPlugins(): PluggableList
externalResources?: Partial<StaticResources>
}
export abstract class QuartzFilterPlugin {
abstract name: string
abstract shouldPublish(content: ProcessedContent): boolean
}
export interface EmitOptions {
slug: string
ext: `.${string}`
content: string
}
export type EmitCallback = (data: EmitOptions) => Promise<string>
2023-05-30 15:02:20 +00:00
export abstract class QuartzEmitterPlugin {
abstract name: string
2023-06-01 21:35:31 +00:00
abstract emit(cfg: GlobalConfiguration, content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise<string[]>
2023-06-03 19:07:19 +00:00
abstract getQuartzComponents(): QuartzComponent<any>[]
2023-05-30 15:02:20 +00:00
}
export interface PluginTypes {
transformers: QuartzTransformerPlugin[],
filters: QuartzFilterPlugin[],
emitters: QuartzEmitterPlugin[],
}