From 5480269d38ffaff7ffd6576d9a9407430429fb2d Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 09 Mar 2025 21:58:26 +0000
Subject: [PATCH] perf(explorer): client side explorer (#1810)
---
quartz/plugins/types.ts | 41 ++++++++++++++++++++---------------------
1 files changed, 20 insertions(+), 21 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index 4145e8f..e7cfb47 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -1,10 +1,10 @@
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 "../path"
-import { BuildCtx } from "../ctx"
+import { FilePath } from "../util/path"
+import { BuildCtx } from "../util/ctx"
+import DepGraph from "../depgraph"
export interface PluginTypes {
transformers: QuartzTransformerPluginInstance[]
@@ -13,15 +13,16 @@
}
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?: (src: string | Buffer) => string | Buffer
- 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> = (
@@ -29,7 +30,7 @@
) => QuartzFilterPluginInstance
export type QuartzFilterPluginInstance = {
name: string
- shouldPublish(content: ProcessedContent): boolean
+ shouldPublish(ctx: BuildCtx, content: ProcessedContent): boolean
}
export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
@@ -37,19 +38,17 @@
) => QuartzEmitterPluginInstance
export type QuartzEmitterPluginInstance = {
name: string
- emit(
+ 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,
- emitCallback: EmitCallback,
- ): Promise<FilePath[]>
- getQuartzComponents(): QuartzComponent[]
+ ): Promise<DepGraph<FilePath>>
+ externalResources?: ExternalResourcesFn
}
-
-export interface EmitOptions {
- slug: ServerSlug
- ext: `.${string}` | ""
- content: string
-}
-
-export type EmitCallback = (data: EmitOptions) => Promise<FilePath>
--
Gitblit v1.10.0