app/lib/cv/markdown.mjs

Functions

Imports

It imports app/data/organisms.ts, app/lib/content-pages.mjs, app/lib/cv/entries.mjs, app/lib/cv/view.mjs. Imported by app/lib/cv/compile.mjs, app/lib/cv/pdf-html.mjs, app/routes/cv[.md].ts.

Source

1/**
2 * The CV as markdown, from the same resolved entries the page renders (app/lib/cv/entries.mjs).
3 * app/routes/cv[.md].ts serves it as the /cv.md twin (cvTwin), build:content compiles it for the search records,
4 * and the PDF (app/lib/cv/pdf-html.mjs) is rendered from the same markdown, so the surfaces say the same thing.
5 * Traditional order and no filtering: this is the version a committee reads start to finish.
6 */
7
8import { ORGANISM_PATTERN } from "../../data/organisms.ts";
9import { contentPageMarkdownBody } from "../content-pages.mjs";
10import { CV_PAGE, CV_PDF_PATH, formatDollars } from "./entries.mjs";
11import { TYPES } from "./view.mjs";
12
13/**
14 * Markdown-significant characters in data text are escaped, and a colon before a letter is escaped
15 * because the pipeline reads `:word` as a directive and fails closed on unknown ones.
16 *
17 * @param {string} text
18 */
19function esc(text) {
20  return String(text)
21    .replace(/([\\`*_[\]<>#|])/g, "\\$1")
22    .replace(/:(?=[A-Za-z])/g, "\\:");
23}
24
25const OWNER_NAMES = new Set(["Dustin Edwards", "Dustin C. Edwards", "Dustin Cole Edwards", "D. Edwards"]);
26
27/** @param {string[]} authors */
28function authorLine(authors) {
29  return authors.map((name) => (OWNER_NAMES.has(name) ? `**${esc(name)}**` : esc(name))).join(", ");
30}
31
32/** @param {import("./entries.mjs").CvEntry} e */
33function paperItem(e) {
34  const p = e.paper;
35  if (!p) throw new Error(`cv markdown: ${e.id} is a publication with no paper`);
36  const end = /[.?!]$/.test(e.title) ? "" : ".";
37  const links = [];
38  if (p.doi) links.push(`[doi:${esc(p.doi)}](https://doi.org/${p.doi})`);
39  if (p.pmid) links.push(`[PubMed ${p.pmid}](https://pubmed.ncbi.nlm.nih.gov/${p.pmid}/)`);
40  // Genus and species italic, as the paper pages set them (app/lib/scientific-names.tsx).
41  const title = esc(e.title).replace(ORGANISM_PATTERN, (name) => `*${name}*`);
42  return `${authorLine(p.authors)}. ${e.year}. ${title}${end} *${esc(p.venue)}*.${links.length ? ` ${links.join(", ")}` : ""}`;
43}
44
45/** @param {import("./entries.mjs").CvEntry} e */
46function lineItem(e) {
47  const lead = e.when ? `**${e.when}** ` : "";
48  switch (e.type) {
49    case "grant": {
50      const parts = [formatDollars(e.amount ?? 0), e.title, ...e.meta, ...(e.note ? [e.note] : [])];
51      return `${lead}${esc(parts.join(", "))}`;
52    }
53    case "course":
54      return esc(`${e.title}, ${e.meta.join(", ")}`);
55    case "talk":
56      return `${lead}${esc(e.title)}. ${esc(e.meta.join(". "))}`;
57    default: {
58      const rest = e.meta.filter(Boolean);
59      return `${lead}${esc(e.title)}${rest.length ? `. ${esc(rest.join(". "))}` : ""}`;
60    }
61  }
62}
63
64/**
65 * @param {import("./entries.mjs").Cv} CV the resolved CV (buildCv)
66 * @param {{ pdf?: boolean }} [options] the PDF leaves out the opening lines, which it sets as a letterhead
67 * @returns {string} markdown body, no frontmatter
68 */
69export function cvMarkdownBody(CV, options = {}) {
70  const { person, entries, presentations } = CV;
71  const out = [];
72  // The PDF sets its own letterhead (app/lib/cv/pdf-html.mjs), so it starts at the first section.
73  if (!options.pdf) {
74    out.push(`${person.name}, ${person.degree} ${person.title}, ${person.department}, ${esc(person.org)}.`);
75    out.push("");
76    out.push(
77      `This is the ${CV.edition} CV. The same entries are at [/cv](/cv), where they can be filtered, and as a [PDF](${CV_PDF_PATH}). Each paper also has its own page under [Publications](/research/publications).`,
78    );
79  }
80
81  for (const [type, , plural] of TYPES) {
82    const list = entries.filter((e) => e.type === type);
83    if (list.length === 0) continue;
84    out.push(...(out.length ? [""] : []), `## ${plural}`);
85    if (type === "talk") {
86      out.push(
87        "",
88        `The CV lists ${presentations.international} international and ${presentations.national} national and regional presentations, ${presentations.from}-${presentations.to}, most of them posters and talks given by students with Dustin as senior author. Invited talks, seminars and roundtables where Dustin is the lead or only author:`,
89      );
90    }
91    if (type === "mentoring") {
92      out.push("", "Shown as counts; the CV names each student.");
93    }
94    if (type === "grant") {
95      const total = list.reduce((sum, e) => sum + (e.amount ?? 0), 0);
96      out.push("", `${list.length} awards totaling ${formatDollars(total)}, newest first. Where a student shares an award, this says "with a student researcher" instead of a name.`);
97    }
98
99    /** @type {Map<string, typeof list>} */
100    const sections = new Map();
101    for (const e of list) {
102      const key = e.section ?? "";
103      if (!sections.has(key)) sections.set(key, []);
104      sections.get(key)?.push(e);
105    }
106    for (const [section, items] of sections) {
107      if (section) out.push("", `### ${esc(section)}`);
108      if (type === "publication") {
109        out.push("");
110        items.forEach((e, i) => out.push(`${i + 1}. ${paperItem(e)}`));
111        continue;
112      }
113      let listOpen = false;
114      for (const e of items) {
115        if (e.duties.length === 0) {
116          if (!listOpen) out.push("");
117          listOpen = true;
118          out.push(`- ${lineItem(e)}`);
119          continue;
120        }
121        listOpen = false;
122        out.push("", `#### ${esc(`${e.when}: ${e.title}`)}`, "", `${esc(e.meta.join(". "))}.`);
123        for (const duty of e.duties) {
124          out.push("", `${esc(duty.heading)}:`, "");
125          for (const item of duty.items) out.push(`- ${esc(item)}`);
126        }
127      }
128    }
129  }
130
131  return `${out.join("\n")}\n`;
132}
133
134/** The whole source file build:content reads for /cv, frontmatter included. */
135/** @param {import("./entries.mjs").Cv} CV the resolved CV (buildCv) */
136export function cvMarkdownDocument(CV) {
137  const fm = [
138    "---",
139    `path: ${CV_PAGE.path}`,
140    `title: ${JSON.stringify(CV_PAGE.title)}`,
141    `seo_title: ${JSON.stringify(CV_PAGE.seoTitle)}`,
142    `description: ${JSON.stringify(CV_PAGE.description)}`,
143    "schema_type: WebPage",
144    "---",
145    "",
146  ].join("\n");
147  return `${fm}${cvMarkdownBody(CV)}`;
148}
149
150/**
151 * The twin a machine reads at /cv.md: the title, then the body, as every page's twin is made
152 * (contentPageMarkdownBody), so the CV answers as the other pages do.
153 *
154 * @param {import("./entries.mjs").Cv} CV the resolved CV (buildCv)
155 */
156export function cvTwin(CV) {
157  return contentPageMarkdownBody({ path: CV_PAGE.path, title: CV_PAGE.title, markdown: cvMarkdownBody(CV) });
158}