From c538c151c7462ad0395ff2c15c5e11e89e362aa8 Mon Sep 17 00:00:00 2001
From: Striven <sg.striven@cutecat.club>
Date: Sat, 04 Apr 2026 19:47:16 +0000
Subject: [PATCH] Initial commit
---
quartz/plugins/types.ts | 89 +++++++++++++++++++++++++++++---------------
1 files changed, 59 insertions(+), 30 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index 80d6cee..2a7c16c 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -1,36 +1,65 @@
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"
-
-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>
-export abstract class QuartzEmitterPlugin {
- abstract name: string
- abstract emit(cfg: GlobalConfiguration, content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise<string[]>
- abstract getQuartzComponents(): QuartzComponent<any>[]
-}
+import { FilePath } from "../util/path"
+import { BuildCtx } from "../util/ctx"
+import { VFile } from "vfile"
export interface PluginTypes {
- transformers: QuartzTransformerPlugin[],
- filters: QuartzFilterPlugin[],
- emitters: QuartzEmitterPlugin[],
+ transformers: QuartzTransformerPluginInstance[]
+ filters: QuartzFilterPluginInstance[]
+ emitters: QuartzEmitterPluginInstance[]
+}
+
+type OptionType = object | undefined
+type ExternalResourcesFn = (ctx: BuildCtx) => Partial<StaticResources> | undefined
+export type QuartzTransformerPlugin<Options extends OptionType = undefined> = (
+ opts?: Options,
+) => QuartzTransformerPluginInstance
+export type QuartzTransformerPluginInstance = {
+ name: string
+ textTransform?: (ctx: BuildCtx, src: string) => string
+ markdownPlugins?: (ctx: BuildCtx) => PluggableList
+ htmlPlugins?: (ctx: BuildCtx) => PluggableList
+ externalResources?: ExternalResourcesFn
+}
+
+export type QuartzFilterPlugin<Options extends OptionType = undefined> = (
+ opts?: Options,
+) => QuartzFilterPluginInstance
+export type QuartzFilterPluginInstance = {
+ name: string
+ shouldPublish(ctx: BuildCtx, content: ProcessedContent): boolean
+}
+
+export type ChangeEvent = {
+ type: "add" | "change" | "delete"
+ path: FilePath
+ file?: VFile
+}
+
+export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
+ opts?: Options,
+) => QuartzEmitterPluginInstance
+export type QuartzEmitterPluginInstance = {
+ name: string
+ emit: (
+ ctx: BuildCtx,
+ content: ProcessedContent[],
+ resources: StaticResources,
+ ) => Promise<FilePath[]> | AsyncGenerator<FilePath>
+ partialEmit?: (
+ ctx: BuildCtx,
+ content: ProcessedContent[],
+ resources: StaticResources,
+ changeEvents: ChangeEvent[],
+ ) => Promise<FilePath[]> | AsyncGenerator<FilePath> | null
+ /**
+ * Returns the components (if any) that are used in rendering the page.
+ * This helps Quartz optimize the page by only including necessary resources
+ * for components that are actually used.
+ */
+ getQuartzComponents?: (ctx: BuildCtx) => QuartzComponent[]
+ externalResources?: ExternalResourcesFn
}
--
Gitblit v1.10.0