From cbae88fc4e9b98764cfccca2e85f265c4b894573 Mon Sep 17 00:00:00 2001
From: Adam Brangenberg <adambrangenberg@proton.me>
Date: Mon, 31 Jul 2023 04:08:32 +0000
Subject: [PATCH] Removing redundant properties (#356)
---
quartz/plugins/types.ts | 44 ++++++++++++++++++++++++++++----------------
1 files changed, 28 insertions(+), 16 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index f74b3c9..2662aed 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -1,42 +1,54 @@
import { PluggableList } from "unified"
import { StaticResources } from "../resources"
import { ProcessedContent } from "./vfile"
-import { GlobalConfiguration } from "../cfg"
import { QuartzComponent } from "../components/types"
+import { FilePath, ServerSlug } from "../path"
+import { BuildCtx } from "../ctx"
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
- textTransform?: (src: string | Buffer) => string | Buffer
- markdownPlugins?: () => PluggableList
- htmlPlugins?: () => PluggableList
- externalResources?: () => Partial<StaticResources>
+ textTransform?: (ctx: BuildCtx, src: string | Buffer) => string | Buffer
+ markdownPlugins?: (ctx: BuildCtx) => PluggableList
+ htmlPlugins?: (ctx: BuildCtx) => PluggableList
+ externalResources?: (ctx: BuildCtx) => 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
+ 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,
+ emitCallback: EmitCallback,
+ ): Promise<FilePath[]>
+ getQuartzComponents(ctx: BuildCtx): 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