app/kb/gap-labels.mjs

Functions

Imports

It imports app/kb/form-fields.mjs. Imported by app/components/admin/kb-form-fields.tsx, app/components/admin/kb-form-steps.tsx, app/kb/admin.mjs, app/kb/editor.server.ts.

Source

1// A recorded gap said in plain words, with where it is filled in (docs/KNOWLEDGE-BASE.md): "TES buffer: storage",
2// "Step 4: rotor", "Biosafety level", never the path the validator records it under. The words below the top-level field
3// come from the compile (validate.mjs, `where`), so the admin's list and the editor say the same thing.
4
5import { fieldLabel, keyWords } from "./form-fields.mjs";
6
7/** What a step flag's gap is missing, in words. */
8const STEP_WORDS = /** @type {Record<string, string>} */ ({ spin: "rotor" });
9
10const STEP_GAP = /^step (\d+) \(line \d+\)\.(\w+)$/;
11
12/** An input's id from a field key, the id the form gives the field's input. @param {string} key */
13export const fieldAnchor = (key) => `kb-field-${key.replace(/[^a-z0-9_-]/gi, "-")}`;
14
15/** A cell's id in a list the form edits as rows (materials): the list, the row's name, the column. */
16export const cellAnchor = (/** @type {string} */ key, /** @type {string} */ name, /** @type {string} */ column) =>
17  `${fieldAnchor(key)}-${name.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "")}-${column}`;
18
19/** The lists the form edits as rows, so a gap in a row lands on its cell. */
20const ROW_LISTS = new Set(["materials"]);
21
22/**
23 * A step card's id, from its section's heading and its number, so a gap in a step lands on its card. A heading's own
24 * `{#id}` is left out, as the page leaves it out.
25 *
26 * @param {string} section
27 * @param {number} number
28 */
29export function stepAnchor(section, number) {
30  const words = section.replace(/\s+\{#[a-z0-9-]+\}\s*$/, "").toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "");
31  return `kb-step-${words || "section"}-${number}`;
32}
33
34/** A heading's first words, before its colon: "Part A" for "Part A: collect the phage". @param {string} heading */
35const shortHeading = (heading) => heading.replace(/\s+\{#[a-z0-9-]+\}\s*$/, "").split(":")[0]?.trim() ?? heading;
36
37/**
38 * Each gap with its label and the id of the input it is filled in at. A step's section is named only when two gaps are
39 * in steps with the same number.
40 *
41 * @template {{ field: string, reason: string, where?: string[], section?: string }} G
42 * @param {G[]} gaps
43 * @param {string | null} profile null for a registry item, whose fields are its kind's
44 * @returns {Array<G & { label: string, anchor: string }>}
45 */
46export function labelGaps(gaps, profile) {
47  const stepSections = new Map();
48  for (const gap of gaps) {
49    const step = STEP_GAP.exec(gap.field);
50    if (step) stepSections.set(step[1], new Set([...(stepSections.get(step[1]) ?? []), gap.section ?? ""]));
51  }
52  return gaps.map((gap) => {
53    const step = STEP_GAP.exec(gap.field);
54    if (step) {
55      const number = step[1] ?? "";
56      const section = gap.section ?? "";
57      const named = (stepSections.get(number)?.size ?? 0) > 1 && section ? ` (${shortHeading(section)})` : "";
58      return { ...gap, label: `Step ${number}${named}: ${STEP_WORDS[step[2] ?? ""] ?? step[2]}`, anchor: stepAnchor(section, Number(number)) };
59    }
60    const top = /^[^.[]+/.exec(gap.field)?.[0] ?? gap.field;
61    const label = profile ? fieldLabel(profile, top) : keyWords(top);
62    const where = gap.where ?? [];
63    // An item a list names ("TES buffer") says which field it is in; an item known by its place ("20 cycles") does not.
64    const first = /^\[([^\]]*)\]/.exec(gap.field.slice(top.length));
65    const parts = where.length === 0 ? [label] : first && !/^\d+$/.test(first[1] ?? "") ? where : [label, ...where];
66    const last = parts.pop() ?? label;
67    const column = /^\[[^\]]*\]\.(\w+)$/.exec(gap.field.slice(top.length))?.[1];
68    const anchor = ROW_LISTS.has(top) && first && column ? cellAnchor(top, first[1] ?? "", column) : fieldAnchor(top);
69    return { ...gap, label: parts.length > 0 ? `${parts.join(", ")}: ${last}` : last, anchor };
70  });
71}