From efd46f84de2d8dcc630b96de5454027bfbbf5f6e Mon Sep 17 00:00:00 2001
From: Eiko Wagenknecht <git@eiko-wagenknecht.de>
Date: Mon, 19 Feb 2024 08:08:36 +0000
Subject: [PATCH] fix(frontmatter): delimiters parameter was not passed (#885)
---
quartz/plugins/transformers/frontmatter.ts | 92 +++++++++++++++++++++++++++++++---------------
1 files changed, 62 insertions(+), 30 deletions(-)
diff --git a/quartz/plugins/transformers/frontmatter.ts b/quartz/plugins/transformers/frontmatter.ts
index e9432a1..7073d43 100644
--- a/quartz/plugins/transformers/frontmatter.ts
+++ b/quartz/plugins/transformers/frontmatter.ts
@@ -1,65 +1,97 @@
import matter from "gray-matter"
-import remarkFrontmatter from 'remark-frontmatter'
+import remarkFrontmatter from "remark-frontmatter"
import { QuartzTransformerPlugin } from "../types"
-import yaml from 'js-yaml'
-import { slug as slugAnchor } from 'github-slugger'
+import yaml from "js-yaml"
+import toml from "toml"
+import { slugTag } from "../../util/path"
+import { QuartzPluginData } from "../vfile"
+import { i18n } from "../../i18n"
export interface Options {
- language: 'yaml' | 'toml',
- delims: string | string[]
+ delimiters: string | [string, string]
+ language: "yaml" | "toml"
}
const defaultOptions: Options = {
- language: 'yaml',
- delims: '---'
+ delimiters: "---",
+ language: "yaml",
+}
+
+function coalesceAliases(data: { [key: string]: any }, aliases: string[]) {
+ for (const alias of aliases) {
+ if (data[alias] !== undefined && data[alias] !== null) return data[alias]
+ }
+}
+
+function coerceToArray(input: string | string[]): string[] | undefined {
+ if (input === undefined || input === null) return undefined
+
+ // coerce to array
+ if (!Array.isArray(input)) {
+ input = input
+ .toString()
+ .split(",")
+ .map((tag: string) => tag.trim())
+ }
+
+ // remove all non-strings
+ return input
+ .filter((tag: unknown) => typeof tag === "string" || typeof tag === "number")
+ .map((tag: string | number) => tag.toString())
}
export const FrontMatter: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "FrontMatter",
- markdownPlugins() {
+ markdownPlugins({ cfg }) {
return [
- remarkFrontmatter,
+ [remarkFrontmatter, ["yaml", "toml"]],
() => {
return (_, file) => {
- const { data } = matter(file.value, {
+ const { data } = matter(Buffer.from(file.value), {
...opts,
engines: {
- yaml: s => yaml.load(s, { schema: yaml.JSON_SCHEMA }) as object
- }
+ yaml: (s) => yaml.load(s, { schema: yaml.JSON_SCHEMA }) as object,
+ toml: (s) => toml.parse(s) as object,
+ },
})
- // tag is an alias for tags
- if (data.tag) {
- data.tags = data.tag
+ if (data.title) {
+ data.title = data.title.toString()
+ } else if (data.title === null || data.title === undefined) {
+ data.title = file.stem ?? i18n(cfg.configuration.locale).propertyDefaults.title
}
- if (data.tags && !Array.isArray(data.tags)) {
- data.tags = data.tags.toString().split(",").map((tag: string) => tag.trim())
- }
+ const tags = coerceToArray(coalesceAliases(data, ["tags", "tag"]))
+ if (tags) data.tags = [...new Set(tags.map((tag: string) => slugTag(tag)))]
- // slug them all!!
- data.tags = data.tags?.map((tag: string) => slugAnchor(tag)) ?? []
+ const aliases = coerceToArray(coalesceAliases(data, ["aliases", "alias"]))
+ if (aliases) data.aliases = aliases
+ const cssclasses = coerceToArray(coalesceAliases(data, ["cssclasses", "cssclass"]))
+ if (cssclasses) data.cssclasses = cssclasses
// fill in frontmatter
- file.data.frontmatter = {
- title: file.stem ?? "Untitled",
- tags: [],
- ...data
- }
+ file.data.frontmatter = data as QuartzPluginData["frontmatter"]
}
- }
+ },
]
},
}
}
-declare module 'vfile' {
+declare module "vfile" {
interface DataMap {
- frontmatter: { [key: string]: any } & {
+ frontmatter: { [key: string]: unknown } & {
title: string
- tags: string[]
- }
+ } & Partial<{
+ tags: string[]
+ aliases: string[]
+ description: string
+ publish: boolean
+ draft: boolean
+ enableToc: string
+ cssclasses: string[]
+ }>
}
}
--
Gitblit v1.10.0