| | |
| | | import { QuartzTransformerPlugin } from "../types" |
| | | import yaml from "js-yaml" |
| | | import toml from "toml" |
| | | import { FilePath, FullSlug, joinSegments, slugifyFilePath, slugTag } from "../../util/path" |
| | | import { FilePath, FullSlug, getFileExtension, 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 { |
| | | delimiters: string | [string, string] |
| | |
| | | .map((tag: string | number) => tag.toString()) |
| | | } |
| | | |
| | | 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) |
| | | function getAliasSlugs(aliases: string[]): FullSlug[] { |
| | | const res: FullSlug[] = [] |
| | | for (const alias of aliases) { |
| | | const isMd = getFileExtension(alias) === "md" |
| | | const mockFp = isMd ? alias : alias + ".md" |
| | | const slug = slugifyFilePath(mockFp as FilePath) |
| | | res.push(slug) |
| | | } |
| | | // fix any slugs that have trailing slash |
| | | return slugs.map((slug) => |
| | | slug.endsWith("/") ? (joinSegments(slug, "index") as FullSlug) : slug, |
| | | ) |
| | | |
| | | return res |
| | | } |
| | | |
| | | export const FrontMatter: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => { |
| | | const opts = { ...defaultOptions, ...userOpts } |
| | | return { |
| | | name: "FrontMatter", |
| | | markdownPlugins({ cfg, allSlugs, argv }) { |
| | | markdownPlugins(ctx) { |
| | | const { cfg, allSlugs } = ctx |
| | | return [ |
| | | [remarkFrontmatter, ["yaml", "toml"]], |
| | | () => { |
| | | return (_, file) => { |
| | | const { data } = matter(Buffer.from(file.value), { |
| | | 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, |
| | |
| | | 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) |
| | | file.data.aliases = getAliasSlugs(aliases) |
| | | allSlugs.push(...file.data.aliases) |
| | | } |
| | | |
| | | if (data.permalink != null && data.permalink.toString() !== "") { |
| | | data.permalink = data.permalink.toString() as FullSlug |
| | | const aliases = file.data.aliases ?? [] |
| | | aliases.push(data.permalink) |
| | | file.data.aliases = aliases |
| | | allSlugs.push(data.permalink) |
| | | } |
| | | |
| | | const cssclasses = coerceToArray(coalesceAliases(data, ["cssclasses", "cssclass"])) |
| | | if (cssclasses) data.cssclasses = cssclasses |
| | | |
| | |
| | | created: string |
| | | published: string |
| | | description: string |
| | | socialDescription: string |
| | | publish: boolean | string |
| | | draft: boolean | string |
| | | lang: string |