paperlint 14.0.0 → 14.2.0

package/skills/build-label-page/scripts/label-page-core.test.ts

@@ -6,6 +6,7 @@
 import assert from "node:assert/strict";
 import { readFileSync, writeFileSync } from "node:fs";
 import { join } from "node:path";
+import * as R from "remeda";
 import { test } from "vitest";
 import { z } from "zod";
 import {
@@ -29,7 +30,15 @@ import {
 /** A node of the declared config schema, as `example-generator.py schema` prints it. */
 const Node: z.ZodType<SchemaNode> = z.lazy(() =>
   z.object({
-    kind: z.enum(["string", "integer", "boolean", "map", "array", "object"]),
+    kind: z.enum([
+      "string",
+      "text",
+      "integer",
+      "boolean",
+      "map",
+      "array",
+      "object",
+    ]),
     required: z.boolean(),
     pattern: z.string().optional(),
     key_pattern: z.string().optional(),
@@ -42,7 +51,8 @@ const Node: z.ZodType<SchemaNode> = z.lazy(() =>
 );
 
 interface SchemaNode {
-  readonly kind: "string" | "integer" | "boolean" | "map" | "array" | "object";
+  readonly kind:
+    "string" | "text" | "integer" | "boolean" | "map" | "array" | "object";
   readonly required: boolean;
   readonly pattern?: string | undefined;
   readonly key_pattern?: string | undefined;
@@ -73,6 +83,40 @@ const CARD = {
   rules: [{ linter: "eslint", id: "no-console" }],
   unit: { id: "L0", text: "One line.", mark: "One", part: 1, of: 1 },
   readings: { a: "on", b: "off" },
+  situation: { summary: "S", question: "Q?" },
+  excerpt: {
+    file: "src/a.ts",
+    url: "https://example.com/a.ts",
+    lines: [{ n: 1, text: "", mark: true }],
+    caption: "C",
+    mark_label: "M",
+  },
+  references: {
+    summary: "S",
+    entries: [
+      {
+        label: "L",
+        title: "T",
+        fields: [{ label: "F", text: "X", style: "code" }],
+        url: "https://example.com/r",
+        url_label: "U",
+      },
+    ],
+  },
+  more: { summary: "S", items: ["`src/b.ts`"], rest: "R" },
+  table: {
+    summary: "S",
+    note: "N",
+    rows: [
+      {
+        label: "L",
+        value: "V",
+        plain: "P",
+        mark: { tone: "yes", text: "Y" },
+      },
+    ],
+  },
+  repeat: { group: "g", index: 1, of: 1 },
 };
 /** A config with EVERY optional field present, so every schema path has a value to spoil. */
 const FULL: DocObject = (() => {
@@ -90,10 +134,22 @@ const FULL: DocObject = (() => {
         QUESTIONS[1],
       ],
       labeller_knows: ["python", "go", "rust"],
+      answerers: ["author", "second"],
+      min_seconds: 30,
       familiarity: true,
       familiarity_question: "How well do you know {group}?",
+      labels: {
+        place: "C",
+        body: "B",
+        line: "L",
+        line_part: "{line} {part}/{of}",
+        repeat: "R",
+        practice_example: "P",
+      },
       practice: PRACTICE.map((p, n) => (n === 0 ? { ...p, ...CARD } : p)),
-      items: ITEMS.map((i, n) => (n === 0 ? { ...i, ...CARD } : i)),
+      items: ITEMS.map((i, n) =>
+        n === 0 ? { ...i, ...CARD, answerers: ["author"] } : i,
+      ),
     }),
   );
   assert.ok(isObject(doc));
@@ -187,6 +243,7 @@ function spoil(path: string, bad: Doc | undefined): DocObject {
 
 const WRONG_TYPES: Readonly<Record<SchemaNode["kind"], readonly Doc[]>> = {
   string: [null, 1, true, ["x"], {}, "", "   "],
+  text: [null, 1, true, ["x"], {}],
   integer: [null, "7", true, 7.5, []],
   boolean: [null, "false", 0, [], {}],
   map: [null, "x", ["x"], 1],
@@ -223,6 +280,21 @@ function badCases({ node, member }: Leaf): readonly BadCase[] {
   return [...wrongType, ...extra];
 }
 
+/** `doc` with its first item's own answerers taken out. */
+function withoutItemAnswerers(doc: DocObject): DocObject {
+  const out = put(doc, ["items", 0, "answerers"], undefined);
+  assert.ok(isObject(out));
+  return out;
+}
+/**
+ * A field whose absence takes another with it: familiarity_question asks nothing unless familiarity
+ * is on, and an item's answerers name the page's.
+ */
+const RELAX: Partial<Record<string, (doc: DocObject) => DocObject>> = {
+  familiarity: (doc) => R.omit(doc, ["familiarity_question"]),
+  answerers: withoutItemAnswerers,
+};
+
 /** Spoil `leaf` each way in `badCases`; every one must stop the build and name the path. */
 function expectRefused(leaf: Leaf): void {
   badCases(leaf).forEach(([label, value], i) => {
@@ -238,16 +310,9 @@ function expectRefused(leaf: Leaf): void {
   });
   if (!leaf.node.required && !leaf.member) {
     const absent = spoil(leaf.path, undefined);
-    // familiarity_question asks nothing unless familiarity is on: the two leave together.
     const r = tryBuild(
       `schema-${leaf.path.replace(/\W/g, "_")}-absent`,
-      leaf.path === "familiarity"
-        ? Object.fromEntries(
-            Object.entries(absent).filter(
-              ([k]) => k !== "familiarity_question",
-            ),
-          )
-        : absent,
+      (RELAX[leaf.path] ?? R.identity())(absent),
     );
     assert.equal(r.status, 0, `${leaf.path} is optional: ${r.out}`);
   }
@@ -261,6 +326,8 @@ const DOCUMENTED_FIELDS = [
   "seed",
   "groups",
   "labeller_knows",
+  "answerers",
+  "min_seconds",
   "familiarity",
   "familiarity_question",
   "questions",