app/lib/dictionary/parse.mjs

Functions

Imports

It imports no other module of this repo. Imported by app/lib/carrel/dictionary-handler.server.ts, app/lib/dictionary/compile.mjs, app/lib/dictionary/save.server.ts, app/lib/health/checks.server.ts, app/lib/operator/sync-tools.server.ts.

Source

1// Reads a dictionary entry file (docs/DICTIONARY.md) into its front matter as written and its body, the
2// editors' notes. Nothing here judges: compile.mjs does, so the gate, the build and the save read one parse.
3
4import matter from "gray-matter";
5
6export const DICTIONARY_DIR = "content/dictionary";
7
8/** The repository path of an entry's file, from its key (`capsid`). */
9export function dictionaryPath(/** @type {string} */ key) {
10  return `${DICTIONARY_DIR}/${key}.md`;
11}
12
13/**
14 * @typedef {{ data: Record<string, unknown>, body: string, problems: string[] }} ParsedEntry
15 */
16
17/**
18 * @param {{ file: string, raw: string }} input
19 * @returns {ParsedEntry}
20 */
21export function parseDictionaryEntry({ file, raw }) {
22  /** @type {string[]} */
23  const problems = [];
24  if (!raw.startsWith("---")) {
25    problems.push(`${file}: the file must start with a --- front matter block`);
26  }
27  try {
28    // An options object, even an empty one: gray-matter caches by input when it is omitted, and a cached
29    // parse is one object shared by every caller.
30    const parsed = matter(raw, {});
31    return { data: /** @type {Record<string, unknown>} */ (parsed.data), body: parsed.content, problems };
32  } catch (error) {
33    problems.push(`${file}: the front matter does not parse: ${error instanceof Error ? error.message.split("\n")[0] : String(error)}`);
34    return { data: {}, body: "", problems };
35  }
36}