From ec00a40aefca73596ab76e3ebe3a8e1129b43688 Mon Sep 17 00:00:00 2001
From: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date: Tue, 27 Jan 2026 18:27:17 +0000
Subject: [PATCH] chore(deps): bump the production-dependencies group with 4 updates (#2289)
---
quartz/plugins/transformers/frontmatter.ts | 142 ++++++++++++++++++++++++++++++++++++----------
1 files changed, 110 insertions(+), 32 deletions(-)
diff --git a/quartz/plugins/transformers/frontmatter.ts b/quartz/plugins/transformers/frontmatter.ts
index 017d3d1..db1cf42 100644
--- a/quartz/plugins/transformers/frontmatter.ts
+++ b/quartz/plugins/transformers/frontmatter.ts
@@ -3,32 +3,67 @@
import { QuartzTransformerPlugin } from "../types"
import yaml from "js-yaml"
import toml from "toml"
-import { slugTag } from "../../util/path"
+import { FilePath, FullSlug, getFileExtension, slugifyFilePath, slugTag } from "../../util/path"
+import { QuartzPluginData } from "../vfile"
+import { i18n } from "../../i18n"
export interface Options {
- delims: string | string[]
+ delimiters: string | [string, string]
language: "yaml" | "toml"
- oneLineTagDelim: string
}
const defaultOptions: Options = {
- delims: "---",
+ delimiters: "---",
language: "yaml",
- oneLineTagDelim: ",",
}
-export const FrontMatter: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
+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())
+}
+
+function getAliasSlugs(aliases: string[]): FullSlug[] {
+ const res: FullSlug[] = []
+ for (const alias of aliases) {
+ const isMd = getFileExtension(alias) === "md"
+ const mockFp = isMd ? alias : alias + ".md"
+ const slug = slugifyFilePath(mockFp as FilePath)
+ res.push(slug)
+ }
+
+ return res
+}
+
+export const FrontMatter: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "FrontMatter",
- markdownPlugins() {
- const { oneLineTagDelim } = opts
-
+ markdownPlugins(ctx) {
+ const { cfg, allSlugs } = ctx
return [
[remarkFrontmatter, ["yaml", "toml"]],
() => {
return (_, file) => {
- const { data } = matter(file.value, {
+ const fileData = Buffer.from(file.value as Uint8Array)
+ const { data } = matter(fileData, {
...opts,
engines: {
yaml: (s) => yaml.load(s, { schema: yaml.JSON_SCHEMA }) as object,
@@ -36,32 +71,60 @@
},
})
- // tag is an alias for tags
- if (data.tag) {
- data.tags = data.tag
- }
-
- // coerce title to string
- if (data.title) {
+ if (data.title != null && data.title.toString() !== "") {
data.title = data.title.toString()
+ } else {
+ data.title = file.stem ?? i18n(cfg.configuration.locale).propertyDefaults.title
}
- if (data.tags && !Array.isArray(data.tags)) {
- data.tags = data.tags
- .toString()
- .split(oneLineTagDelim)
- .map((tag: string) => tag.trim())
+ const tags = coerceToArray(coalesceAliases(data, ["tags", "tag"]))
+ if (tags) data.tags = [...new Set(tags.map((tag: string) => slugTag(tag)))]
+
+ const aliases = coerceToArray(coalesceAliases(data, ["aliases", "alias"]))
+ if (aliases) {
+ data.aliases = aliases // frontmatter
+ file.data.aliases = getAliasSlugs(aliases)
+ allSlugs.push(...file.data.aliases)
}
- // slug them all!!
- data.tags = [...new Set(data.tags?.map((tag: string) => slugTag(tag)))] ?? []
+ if (data.permalink != null && data.permalink.toString() !== "") {
+ data.permalink = data.permalink.toString() as FullSlug
+ const aliases = file.data.aliases ?? []
+ aliases.push(data.permalink)
+ file.data.aliases = aliases
+ allSlugs.push(data.permalink)
+ }
+
+ const cssclasses = coerceToArray(coalesceAliases(data, ["cssclasses", "cssclass"]))
+ if (cssclasses) data.cssclasses = cssclasses
+
+ const socialImage = coalesceAliases(data, ["socialImage", "image", "cover"])
+
+ const created = coalesceAliases(data, ["created", "date"])
+ if (created) {
+ data.created = created
+ }
+
+ const modified = coalesceAliases(data, [
+ "modified",
+ "lastmod",
+ "updated",
+ "last-modified",
+ ])
+ if (modified) data.modified = modified
+ data.modified ||= created // if modified is not set, use created
+
+ const published = coalesceAliases(data, ["published", "publishDate", "date"])
+ if (published) data.published = published
+
+ if (socialImage) data.socialImage = socialImage
+
+ // Remove duplicate slugs
+ const uniqueSlugs = [...new Set(allSlugs)]
+ allSlugs.splice(0, allSlugs.length, ...uniqueSlugs)
// fill in frontmatter
- file.data.frontmatter = {
- title: file.stem ?? "Untitled",
- tags: [],
- ...data,
- }
+ file.data.frontmatter = data as QuartzPluginData["frontmatter"]
}
},
]
@@ -71,9 +134,24 @@
declare module "vfile" {
interface DataMap {
- frontmatter: { [key: string]: any } & {
+ aliases: FullSlug[]
+ frontmatter: { [key: string]: unknown } & {
title: string
- tags: string[]
- }
+ } & Partial<{
+ tags: string[]
+ aliases: string[]
+ modified: string
+ created: string
+ published: string
+ description: string
+ socialDescription: string
+ publish: boolean | string
+ draft: boolean | string
+ lang: string
+ enableToc: string
+ cssclasses: string[]
+ socialImage: string
+ comments: boolean | string
+ }>
}
}
--
Gitblit v1.10.0