quartz-research-note/quartz/plugins/transformers/frontmatter.ts

100 lines
2.9 KiB
TypeScript
Raw Normal View History

2023-05-30 15:02:20 +00:00
import matter from "gray-matter"
2023-07-23 00:27:41 +00:00
import remarkFrontmatter from "remark-frontmatter"
2023-05-30 15:02:20 +00:00
import { QuartzTransformerPlugin } from "../types"
2023-07-23 00:27:41 +00:00
import yaml from "js-yaml"
import toml from "toml"
import { slugTag } from "../../util/path"
2024-01-05 08:29:34 +00:00
import { QuartzPluginData } from "../vfile"
2024-02-05 10:45:36 +00:00
import { i18n } from "../../i18n"
2023-05-30 15:02:20 +00:00
export interface Options {
delims: string | string[]
language: "yaml" | "toml"
2024-01-05 08:29:34 +00:00
oneLineTagDelim: string
2023-05-30 15:02:20 +00:00
}
const defaultOptions: Options = {
2023-07-23 00:27:41 +00:00
delims: "---",
language: "yaml",
2024-01-05 08:29:34 +00:00
oneLineTagDelim: ",",
2023-05-30 15:02:20 +00:00
}
2024-02-05 10:45:36 +00:00
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",
2024-02-05 10:45:36 +00:00
markdownPlugins({ cfg }) {
return [
[remarkFrontmatter, ["yaml", "toml"]],
() => {
return (_, file) => {
2024-01-05 08:29:34 +00:00
const { data } = matter(Buffer.from(file.value), {
2023-07-07 01:45:38 +00:00
...opts,
engines: {
2023-07-23 00:27:41 +00:00
yaml: (s) => yaml.load(s, { schema: yaml.JSON_SCHEMA }) as object,
toml: (s) => toml.parse(s) as object,
2023-07-23 00:27:41 +00:00
},
2023-07-07 01:45:38 +00:00
})
2023-09-26 01:15:55 +00:00
if (data.title) {
data.title = data.title.toString()
2024-01-05 08:29:34 +00:00
} else if (data.title === null || data.title === undefined) {
2024-02-05 10:45:36 +00:00
data.title = file.stem ?? i18n(cfg.configuration.locale).propertyDefaults.title
2023-09-26 01:15:55 +00:00
}
2024-02-05 10:45:36 +00:00
const tags = coerceToArray(coalesceAliases(data, ["tags", "tag"]))
if (tags) data.tags = [...new Set(tags.map((tag: string) => slugTag(tag)))]
2023-07-07 01:32:48 +00:00
2024-02-05 10:45:36 +00:00
const aliases = coerceToArray(coalesceAliases(data, ["aliases", "alias"]))
if (aliases) data.aliases = aliases
const cssclasses = coerceToArray(coalesceAliases(data, ["cssclasses", "cssclass"]))
if (cssclasses) data.cssclasses = cssclasses
2023-07-10 02:32:24 +00:00
// fill in frontmatter
2024-01-05 08:29:34 +00:00
file.data.frontmatter = data as QuartzPluginData["frontmatter"]
2023-05-30 15:02:20 +00:00
}
2023-07-23 00:27:41 +00:00
},
]
},
2023-05-30 15:02:20 +00:00
}
}
2023-07-23 00:27:41 +00:00
declare module "vfile" {
2023-05-30 15:02:20 +00:00
interface DataMap {
2024-02-05 10:45:36 +00:00
frontmatter: { [key: string]: unknown } & {
2023-05-30 15:02:20 +00:00
title: string
2024-02-05 10:45:36 +00:00
} & Partial<{
tags: string[]
aliases: string[]
description: string
publish: boolean
draft: boolean
enableToc: string
cssclasses: string[]
}>
2023-05-30 15:02:20 +00:00
}
}