From 2bfe90b7e64839d8ec6319fe93b76472b0285114 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Mon, 12 Jun 2023 06:46:38 +0000
Subject: [PATCH] add config to components
---
quartz/plugins/types.ts | 41 ++++++++++++++++++++++++-----------------
1 files changed, 24 insertions(+), 17 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index 5239d0c..ac386c9 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -2,17 +2,34 @@
import { StaticResources } from "../resources"
import { ProcessedContent } from "./vfile"
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 {
@@ -22,13 +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[]>
-}
-
-export interface PluginTypes {
- transformers: QuartzTransformerPlugin[],
- filters: QuartzFilterPlugin[],
- emitters: QuartzEmitterPlugin[],
-}
--
Gitblit v1.10.0