From 9c8fec06d2b58e4e3bbe280ddc665a99fcc4878c Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 09 Mar 2025 22:33:15 +0000
Subject: [PATCH] feat: support non-singleton search
---
quartz/plugins/types.ts | 57 +++++++++++++++++++++++++++++++++++----------------------
1 files changed, 35 insertions(+), 22 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index 444fcff..e7cfb47 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -1,41 +1,54 @@
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 } from "../util/path"
+import { BuildCtx } from "../util/ctx"
+import DepGraph from "../depgraph"
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
+type ExternalResourcesFn = (ctx: BuildCtx) => Partial<StaticResources> | undefined
+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) => string
+ markdownPlugins?: (ctx: BuildCtx) => PluggableList
+ htmlPlugins?: (ctx: BuildCtx) => PluggableList
+ externalResources?: ExternalResourcesFn
}
-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): Promise<FilePath[]>
+ /**
+ * 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[]
+ getDependencyGraph?(
+ ctx: BuildCtx,
+ content: ProcessedContent[],
+ resources: StaticResources,
+ ): Promise<DepGraph<FilePath>>
+ externalResources?: ExternalResourcesFn
}
-
-export interface EmitOptions {
- slug: string
- ext: `.${string}` | ""
- content: string
-}
-
-export type EmitCallback = (data: EmitOptions) => Promise<string>
--
Gitblit v1.10.0