app/lib/media/folders.mjs

Functions

Imports

It imports no other module of this repo. Imported by app/lib/media/view.mjs.

Source

1// The NOTE is what stops somebody deleting files a post-level tracker calls unreferenced (the roster
2// photos are placed by a template). Entries with no files yet are kept; an empty section renders nothing.
3
4/**
5 * Order is render order.
6 * @type {Array<[string, string, string]>}
7 */
8const FOLDERS = [
9  ["/phage-hunters/", "Cohort photographs", "Placed by the roster page template"],
10  ["og/", "Social cards", "Generated at build time"],
11  ["derived/", "Generated documents", "Rendered by the site from its own data and replaced on each change, never edited"],
12  ["/diagrams/", "Diagrams", ""],
13  ["/research/publications/", "Publications", ""],
14  ["/site/", "Site", ""],
15  ["/uploads/", "Uploads", "Dropped here, not yet placed anywhere"],
16  ["/teaching/", "Teaching", ""],
17  ["/talks/", "Talks", ""],
18  ["/brand/", "Brand", "Referenced by the layout, never by a post"],
19];
20
21/** @type {[string, string, string]} */
22const ROOT = ["", "Brand and site files", "Referenced by the layout, never by a post"];
23
24/**
25 * @param {string} key
26 * @returns {{ prefix: string, title: string, note: string }}
27 */
28export function folderFor(key) {
29  if (typeof key !== "string") {
30    return { prefix: ROOT[0], title: ROOT[1], note: ROOT[2] };
31  }
32  /** @type {[string, string, string] | null} */
33  let best = null;
34  for (const [prefix, title, note] of FOLDERS) {
35    if (!key.startsWith(prefix)) continue;
36    if (!best || prefix.length > best[0].length) best = [prefix, title, note];
37  }
38  if (best) return { prefix: best[0], title: best[1], note: best[2] };
39
40  // Unknown folder: derive a title from its own directory rather than mislabel it as the root section.
41  const at = key.lastIndexOf("/");
42  if (at <= 0) return { prefix: ROOT[0], title: ROOT[1], note: ROOT[2] };
43  const prefix = key.slice(0, at + 1);
44  return { prefix, title: titleFromPrefix(prefix), note: "" };
45}
46
47/**
48 * @param {string} prefix
49 * @returns {string}
50 */
51function titleFromPrefix(prefix) {
52  const last = prefix.replace(/^\/+|\/+$/g, "").split("/").pop() ?? "";
53  if (!last) return ROOT[1];
54  const words = last.replace(/[-_]+/g, " ").trim();
55  return words.charAt(0).toUpperCase() + words.slice(1);
56}
57
58/**
59 * @param {string} prefix
60 * @returns {number}
61 */
62export function folderRank(prefix) {
63  const at = FOLDERS.findIndex(([p]) => p === prefix);
64  return at === -1 ? FOLDERS.length : at;
65}