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

87 lines
2.4 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"
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
}
export const FrontMatter: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "FrontMatter",
markdownPlugins() {
2024-01-05 08:29:34 +00:00
const { oneLineTagDelim } = opts
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-07-10 02:32:24 +00:00
// tag is an alias for tags
if (data.tag) {
data.tags = data.tag
}
2023-09-26 01:15:55 +00:00
// coerce title to string
if (data.title) {
data.title = data.title.toString()
2024-01-05 08:29:34 +00:00
} else if (data.title === null || data.title === undefined) {
data.title = file.stem ?? "Untitled"
2023-09-26 01:15:55 +00:00
}
2024-01-05 08:29:34 +00:00
if (data.tags) {
// coerce to array
if (!Array.isArray(data.tags)) {
data.tags = data.tags
.toString()
.split(oneLineTagDelim)
.map((tag: string) => tag.trim())
}
// remove all non-string tags
2023-07-23 00:27:41 +00:00
data.tags = data.tags
2024-01-05 08:29:34 +00:00
.filter((tag: unknown) => typeof tag === "string" || typeof tag === "number")
.map((tag: string | number) => tag.toString())
2023-07-07 01:32:48 +00:00
}
2023-07-10 02:32:24 +00:00
// slug them all!!
2024-01-05 08:29:34 +00:00
data.tags = [...new Set(data.tags?.map((tag: string) => slugTag(tag)))]
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 {
frontmatter: { [key: string]: any } & {
title: string
tags: string[]
}
}
}