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

76 lines
1.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"
2023-05-30 15:02:20 +00:00
export interface Options {
delims: string | string[]
language: "yaml" | "toml"
2023-05-30 15:02:20 +00:00
}
const defaultOptions: Options = {
2023-07-23 00:27:41 +00:00
delims: "---",
language: "yaml",
2023-05-30 15:02:20 +00:00
}
export const FrontMatter: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "FrontMatter",
markdownPlugins() {
return [
[remarkFrontmatter, ["yaml", "toml"]],
() => {
return (_, file) => {
2023-07-07 01:45:38 +00:00
const { data } = matter(file.value, {
...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()
}
2023-07-07 01:45:38 +00:00
if (data.tags && !Array.isArray(data.tags)) {
2023-07-23 00:27:41 +00:00
data.tags = data.tags
.toString()
.split(",")
.map((tag: string) => tag.trim())
2023-07-07 01:32:48 +00:00
}
2023-07-10 02:32:24 +00:00
// slug them all!!
data.tags = [...new Set(data.tags?.map((tag: string) => slugTag(tag)))] ?? []
2023-07-10 02:32:24 +00:00
// fill in frontmatter
file.data.frontmatter = {
title: file.stem ?? "Untitled",
tags: [],
2023-07-23 00:27:41 +00:00
...data,
}
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[]
}
}
}