1
0
silverbullet/plug-api/lib/frontmatter.ts
Zef Hemel 0313565610
Complete redo of content indexing and querying (#517)
Complete redo of data store
Introduces live queries and live templates
2023-10-03 14:16:33 +02:00

124 lines
3.3 KiB
TypeScript

import { YAML } from "$sb/plugos-syscall/mod.ts";
import {
addParentPointers,
collectNodesOfType,
ParseTree,
renderToText,
replaceNodesMatchingAsync,
traverseTreeAsync,
} from "$sb/lib/tree.ts";
// Extracts front matter (or legacy "meta" code blocks) from a markdown document
// optionally removes certain keys from the front matter
export async function extractFrontmatter(
tree: ParseTree,
removeKeys: string[] = [],
removeFrontmatterSection = false,
): Promise<any> {
let data: any = {};
addParentPointers(tree);
let paragraphCounter = 0;
await replaceNodesMatchingAsync(tree, async (t) => {
if (t.type === "Paragraph") {
paragraphCounter++;
// Only attach hashtags in the first paragraph to the page
if (paragraphCounter !== 1) {
return;
}
collectNodesOfType(t, "Hashtag").forEach((h) => {
if (!data.tags) {
data.tags = [];
}
const tagname = h.children![0].text!.substring(1);
if (Array.isArray(data.tags) && !data.tags.includes(tagname)) {
data.tags.push(tagname);
}
});
}
// Find FrontMatter and parse it
if (t.type === "FrontMatter") {
const yamlNode = t.children![1].children![0];
const yamlText = renderToText(yamlNode);
try {
const parsedData: any = await YAML.parse(yamlText);
const newData = { ...parsedData };
data = { ...data, ...parsedData };
if (removeKeys.length > 0) {
let removedOne = false;
for (const key of removeKeys) {
if (key in newData) {
delete newData[key];
removedOne = true;
}
}
if (removedOne) {
yamlNode.text = await YAML.stringify(newData);
}
}
// If nothing is left, let's just delete this whole block
if (Object.keys(newData).length === 0 || removeFrontmatterSection) {
return null;
}
} catch (e: any) {
console.warn("Could not parse frontmatter", e.message);
}
}
return undefined;
});
if (data.name) {
data.displayName = data.name;
delete data.name;
}
return data;
}
// Updates the front matter of a markdown document and returns the text as a rendered string
export async function prepareFrontmatterDispatch(
tree: ParseTree,
data: Record<string, any>,
): Promise<any> {
let dispatchData: any = null;
await traverseTreeAsync(tree, async (t) => {
// Find FrontMatter and parse it
if (t.type === "FrontMatter") {
const bodyNode = t.children![1].children![0];
const yamlText = renderToText(bodyNode);
try {
const parsedYaml = await YAML.parse(yamlText) as any;
const newData = { ...parsedYaml, ...data };
// Patch inline
dispatchData = {
changes: {
from: bodyNode.from,
to: bodyNode.to,
insert: await YAML.stringify(newData),
},
};
} catch (e: any) {
console.error("Error parsing YAML", e);
}
return true;
}
return false;
});
if (!dispatchData) {
// If we didn't find frontmatter, let's add it
dispatchData = {
changes: {
from: 0,
to: 0,
insert: "---\n" + await YAML.stringify(data) +
"---\n",
},
};
}
return dispatchData;
}