dependabot[bot]
2025-03-06 a3b62013650f09afd11c4e58675f495bbc085569
quartz/plugins/transformers/frontmatter.ts
@@ -1,55 +1,143 @@
import { PluggableList } from "unified"
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 toml from "toml"
import { FilePath, FullSlug, joinSegments, slugifyFilePath, slugTag } from "../../util/path"
import { QuartzPluginData } from "../vfile"
import { i18n } from "../../i18n"
import { Argv } from "../../util/ctx"
import { VFile } from "vfile"
import path from "path"
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",
}
export class FrontMatter extends QuartzTransformerPlugin {
  name = "FrontMatter"
  opts: Options
function coalesceAliases(data: { [key: string]: any }, aliases: string[]) {
  for (const alias of aliases) {
    if (data[alias] !== undefined && data[alias] !== null) return data[alias]
  }
}
  constructor(opts?: Partial<Options>) {
    super()
    this.opts = { ...defaultOptions, ...opts }
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())
  }
  markdownPlugins(): PluggableList {
    return [
      remarkFrontmatter,
      () => {
        return (_, file) => {
          const { data } = matter(file.value, this.opts)
  // remove all non-strings
  return input
    .filter((tag: unknown) => typeof tag === "string" || typeof tag === "number")
    .map((tag: string | number) => tag.toString())
}
          // fill in frontmatter
          file.data.frontmatter = {
            title: file.stem ?? "Untitled",
            tags: [],
            ...data
export function getAliasSlugs(aliases: string[], argv: Argv, file: VFile): FullSlug[] {
  const dir = path.posix.relative(argv.directory, path.dirname(file.data.filePath!))
  const slugs: FullSlug[] = aliases.map(
    (alias) => path.posix.join(dir, slugifyFilePath(alias as FilePath)) as FullSlug,
  )
  const permalink = file.data.frontmatter?.permalink
  if (typeof permalink === "string") {
    slugs.push(permalink as FullSlug)
  }
  // fix any slugs that have trailing slash
  return slugs.map((slug) =>
    slug.endsWith("/") ? (joinSegments(slug, "index") as FullSlug) : slug,
  )
}
export const FrontMatter: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => {
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "FrontMatter",
    markdownPlugins({ cfg, allSlugs, argv }) {
      return [
        [remarkFrontmatter, ["yaml", "toml"]],
        () => {
          return (_, file) => {
            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,
                toml: (s) => toml.parse(s) as object,
              },
            })
            if (data.title != null && data.title.toString() !== "") {
              data.title = data.title.toString()
            } else {
              data.title = file.stem ?? i18n(cfg.configuration.locale).propertyDefaults.title
            }
            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
              const slugs = (file.data.aliases = getAliasSlugs(aliases, argv, file))
              allSlugs.push(...slugs)
            }
            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
            const published = coalesceAliases(data, ["published", "publishDate", "date"])
            if (published) data.published = published
            if (socialImage) data.socialImage = socialImage
            // fill in frontmatter
            file.data.frontmatter = data as QuartzPluginData["frontmatter"]
          }
        }
      }
    ]
  }
  htmlPlugins(): PluggableList {
    return []
        },
      ]
    },
  }
}
declare module 'vfile' {
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
        publish: boolean | string
        draft: boolean | string
        lang: string
        enableToc: string
        cssclasses: string[]
        socialImage: string
        comments: boolean | string
      }>
  }
}