From 5b13ff21992a61eb8b03670ae1742a72703c2afe Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Thu, 06 Mar 2025 02:16:24 +0000
Subject: [PATCH] feat: support emitters defining external resources, emit link from contentindex directly
---
quartz/plugins/types.ts | 29 ++++++++++++-----------------
1 files changed, 12 insertions(+), 17 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index 2662aed..283a999 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -1,9 +1,10 @@
import { PluggableList } from "unified"
-import { StaticResources } from "../resources"
+import { StaticResources } from "../util/resources"
import { ProcessedContent } from "./vfile"
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[]
@@ -12,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?: (ctx: BuildCtx, src: string | Buffer) => string | Buffer
+ textTransform?: (ctx: BuildCtx, src: string) => string
markdownPlugins?: (ctx: BuildCtx) => PluggableList
htmlPlugins?: (ctx: BuildCtx) => PluggableList
- externalResources?: (ctx: BuildCtx) => Partial<StaticResources>
+ externalResources?: ExternalResourcesFn
}
export type QuartzFilterPlugin<Options extends OptionType = undefined> = (
@@ -36,19 +38,12 @@
) => QuartzEmitterPluginInstance
export type QuartzEmitterPluginInstance = {
name: string
- emit(
+ emit(ctx: BuildCtx, content: ProcessedContent[], resources: StaticResources): Promise<FilePath[]>
+ getQuartzComponents(ctx: BuildCtx): QuartzComponent[]
+ getDependencyGraph?(
ctx: BuildCtx,
content: ProcessedContent[],
resources: StaticResources,
- emitCallback: EmitCallback,
- ): Promise<FilePath[]>
- getQuartzComponents(ctx: BuildCtx): 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