From ae2e3b463a91d94caa8bdf62e5c3a3d726b8b4e4 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Sun, 23 Jul 2023 18:49:26 +0000
Subject: [PATCH] improve error handling while serving
---
quartz/plugins/types.ts | 38 ++++++++++++++++++++++++++------------
1 files changed, 26 insertions(+), 12 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index 444fcff..52dd833 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -3,39 +3,53 @@
import { ProcessedContent } from "./vfile"
import { GlobalConfiguration } from "../cfg"
import { QuartzComponent } from "../components/types"
+import { FilePath, ServerSlug } from "../path"
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
+export type QuartzTransformerPlugin<Options extends OptionType = undefined> = (
+ opts?: Options,
+) => QuartzTransformerPluginInstance
export type QuartzTransformerPluginInstance = {
name: string
- markdownPlugins(): PluggableList
- htmlPlugins(): PluggableList
- externalResources?(): Partial<StaticResources>
+ textTransform?: (src: string | Buffer) => string | Buffer
+ markdownPlugins?: () => PluggableList
+ htmlPlugins?: () => PluggableList
+ externalResources?: () => Partial<StaticResources>
}
-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
}
-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[]>
+ emit(
+ contentDir: string,
+ cfg: GlobalConfiguration,
+ content: ProcessedContent[],
+ resources: StaticResources,
+ emitCallback: EmitCallback,
+ ): Promise<FilePath[]>
getQuartzComponents(): QuartzComponent[]
}
export interface EmitOptions {
- slug: string
+ slug: ServerSlug
ext: `.${string}` | ""
content: string
}
-export type EmitCallback = (data: EmitOptions) => Promise<string>
+export type EmitCallback = (data: EmitOptions) => Promise<FilePath>
--
Gitblit v1.10.0