From fea352849c6972da4b3b8935eb2e86f6cefc76ed Mon Sep 17 00:00:00 2001
From: Ben Schlegel <ben5.schlegel@gmail.com>
Date: Sat, 16 Sep 2023 17:45:21 +0000
Subject: [PATCH] fix: create deep copy of file passed into tree
---
quartz/plugins/types.ts | 65 +++++++++++++++++++++-----------
1 files changed, 43 insertions(+), 22 deletions(-)
diff --git a/quartz/plugins/types.ts b/quartz/plugins/types.ts
index 80c70cb..eaeb12a 100644
--- a/quartz/plugins/types.ts
+++ b/quartz/plugins/types.ts
@@ -1,33 +1,54 @@
import { PluggableList } from "unified"
-import { StaticResources } from "../resources"
+import { StaticResources } from "../util/resources"
import { ProcessedContent } from "./vfile"
+import { QuartzComponent } from "../components/types"
+import { FilePath, FullSlug } from "../util/path"
+import { BuildCtx } from "../util/ctx"
-export abstract class QuartzTransformerPlugin {
- abstract name: string
- abstract markdownPlugins(): PluggableList
- abstract htmlPlugins(): PluggableList
- externalResources?: Partial<StaticResources>
+export interface PluginTypes {
+ transformers: QuartzTransformerPluginInstance[]
+ filters: QuartzFilterPluginInstance[]
+ emitters: QuartzEmitterPluginInstance[]
}
-export abstract class QuartzFilterPlugin {
- abstract name: string
- abstract shouldPublish(content: ProcessedContent): boolean
+type OptionType = object | undefined
+export type QuartzTransformerPlugin<Options extends OptionType = undefined> = (
+ opts?: Options,
+) => QuartzTransformerPluginInstance
+export type QuartzTransformerPluginInstance = {
+ name: string
+ 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 QuartzFilterPluginInstance = {
+ name: string
+ shouldPublish(ctx: BuildCtx, content: ProcessedContent): boolean
+}
+
+export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
+ opts?: Options,
+) => QuartzEmitterPluginInstance
+export type QuartzEmitterPluginInstance = {
+ name: string
+ emit(
+ ctx: BuildCtx,
+ content: ProcessedContent[],
+ resources: StaticResources,
+ emitCallback: EmitCallback,
+ ): Promise<FilePath[]>
+ getQuartzComponents(ctx: BuildCtx): QuartzComponent[]
}
export interface EmitOptions {
- slug: string
- ext: `.${string}`
+ slug: FullSlug
+ ext: `.${string}` | ""
content: string
}
-export type EmitCallback = (data: EmitOptions) => Promise<string>
-export abstract class QuartzEmitterPlugin {
- abstract name: string
- abstract emit(content: ProcessedContent[], resources: StaticResources, emitCallback: EmitCallback): Promise<string[]>
-}
-
-export interface PluginTypes {
- transformers: QuartzTransformerPlugin[],
- filters: QuartzFilterPlugin[],
- emitters: QuartzEmitterPlugin[],
-}
+export type EmitCallback = (data: EmitOptions) => Promise<FilePath>
--
Gitblit v1.10.0