feat(comments): conditional display via frontmatter (#1566)

David Fischer

2024-11-09 31e0b7c6f802cfab7250b7e9dfb321b3889ef6ca

 quartz/plugins/transformers/frontmatter.ts

@@ -5,35 +5,18 @@
import toml from "toml"
import { slugTag } from "../../util/path"
import { QuartzPluginData } from "../vfile"
import chalk from "chalk"
import { i18n } from "../../i18n"

export interface Options {
  delims: string | string[]
  delimiters: string | [string, string]
  language: "yaml" | "toml"
}

const defaultOptions: Options = {
  delims: "---",
  delimiters: "---",
  language: "yaml",
}

function coerceDate(fp: string, d: unknown): Date | undefined {
  if (d === undefined || d === null) return undefined
  const dt = new Date(d as string | number)
  const invalidDate = isNaN(dt.getTime()) || dt.getTime() === 0
  if (invalidDate) {
    console.log(
      chalk.yellow(
        `\nWarning: found invalid date "${d}" in \`${fp}\`. Supported formats: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format`,
      ),
    )

    return undefined
  }

  return dt
}

function coalesceAliases(data: { [key: string]: any }, aliases: string[]) {
  for (const alias of aliases) {
    if (data[alias] !== undefined && data[alias] !== null) return data[alias]
@@ -57,16 +40,15 @@
    .map((tag: string | number) => tag.toString())
}

export const FrontMatter: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
export const FrontMatter: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => {
  const opts = { ...defaultOptions, ...userOpts }
  return {
    name: "FrontMatter",
    markdownPlugins() {
    markdownPlugins({ cfg }) {
      return [
        [remarkFrontmatter, ["yaml", "toml"]],
        () => {
          return (_, file) => {
            const fp = file.data.filePath!
            const { data } = matter(Buffer.from(file.value), {
              ...opts,
              engines: {
@@ -75,10 +57,10 @@
              },
            })

            if (data.title) {
            if (data.title != null && data.title.toString() !== "") {
              data.title = data.title.toString()
            } else if (data.title === null || data.title === undefined) {
              data.title = file.stem ?? "Untitled"
            } else {
              data.title = file.stem ?? i18n(cfg.configuration.locale).propertyDefaults.title
            }

            const tags = coerceToArray(coalesceAliases(data, ["tags", "tag"]))
@@ -88,16 +70,6 @@
            if (aliases) data.aliases = aliases
            const cssclasses = coerceToArray(coalesceAliases(data, ["cssclasses", "cssclass"]))
            if (cssclasses) data.cssclasses = cssclasses
            const created = coerceDate(fp, coalesceAliases(data, ["created", "date"]))

            if (created) data.created = created
            const modified = coerceDate(
              fp,
              coalesceAliases(data, ["modified", "lastmod", "updated", "last-modified"]),
            )
            if (modified) data.modified = modified
            const published = coerceDate(fp, coalesceAliases(data, ["published", "publishDate"]))
            if (published) data.published = published

            // fill in frontmatter
            file.data.frontmatter = data as QuartzPluginData["frontmatter"]
@@ -116,13 +88,12 @@
        tags: string[]
        aliases: string[]
        description: string
        publish: boolean
        draft: boolean
        publish: boolean | string
        draft: boolean | string
        lang: string
        enableToc: string
        cssclasses: string[]
        created: Date
        modified: Date
        published: Date
        comments: boolean | string
      }>
  }
}