app/lib/writing/status.ts

Functions

Imports

It imports no other module of this repo. Imported by app/components/writing/status-label.tsx, app/lib/writing.server.ts, app/routes/book.outliner.tsx.

Source

1// Status lists (ruling 8). Each project starts from its kind's list and may edit it: each label has
2// one of Capsomer's eight series colors and filters the outliner. A file's `status:` is matched to a
3// label ignoring case; a value the list does not carry is shown as written, in a neutral pill, and
4// never refused.
5
6export type StatusLabel = { label: string; color: number };
7
8export type ProjectKind = "book" | "blog" | "manuscript" | "script";
9
10const list = (...labels: string[]): StatusLabel[] => labels.map((label, i) => ({ label, color: (i % 8) + 1 }));
11
12export const STARTING_STATUSES: Record<ProjectKind, StatusLabel[]> = {
13  book: list("Idea", "Outlined", "Drafting", "First draft", "Revised", "Final"),
14  // Published comes from the site, so it is not a label Carrel sets.
15  blog: list("Idea", "Drafting", "Ready", "Scheduled"),
16  manuscript: list("Drafting", "Draft done", "With coauthors", "Revising", "Final"),
17  script: list("Idea", "Outlined", "Drafting", "Revised", "Locked"),
18};
19
20/** The names a person sees for the eight colors, in token order (--series-1 to --series-8). */
21export const COLOR_NAMES = ["Violet", "Orange", "Teal", "Green", "Indigo", "Pine", "Pink", "Wine"] as const;
22
23export const MAX_LABELS = 12;
24const MAX_LABEL_LENGTH = 40;
25
26/** The label a file's `status:` names, or null for an empty or unknown value. */
27export function labelFor(labels: StatusLabel[], status: string): StatusLabel | null {
28  const wanted = status.trim().toLowerCase();
29  if (!wanted) return null;
30  return labels.find((l) => l.label.toLowerCase() === wanted) ?? null;
31}
32
33/**
34 * A list as a person submitted it: blank rows dropped, labels trimmed, duplicates (ignoring case)
35 * refused, colors kept to 1 to 8. Returns the clean list or why it was refused.
36 */
37export function cleanLabels(rows: { label: string; color: string | number }[]): { ok: true; labels: StatusLabel[] } | { ok: false; error: string } {
38  const labels: StatusLabel[] = [];
39  const seen = new Set<string>();
40  for (const row of rows) {
41    const label = row.label.trim().replace(/\s+/g, " ");
42    if (!label) continue;
43    if (label.length > MAX_LABEL_LENGTH) return { ok: false, error: `Keep each label to ${MAX_LABEL_LENGTH} characters: "${label.slice(0, 20)}..." is longer.` };
44    const key = label.toLowerCase();
45    if (seen.has(key)) return { ok: false, error: `"${label}" is in the list twice.` };
46    seen.add(key);
47    const color = Number(row.color);
48    labels.push({ label, color: Number.isInteger(color) && color >= 1 && color <= 8 ? color : (labels.length % 8) + 1 });
49  }
50  if (labels.length === 0) return { ok: false, error: "Keep at least one label." };
51  if (labels.length > MAX_LABELS) return { ok: false, error: `Keep the list to ${MAX_LABELS} labels.` };
52  return { ok: true, labels };
53}