paperlint 2.0.1 → 3.0.0

package/dist/presets.js

@@ -0,0 +1,184 @@
+/**
+ * VENUE PRESETS — what `"extends"` in a paper's `paperlint.json` resolves to.
+ *
+ * A venue is a preset, the way an ESLint config is a shareable config: a file with the venue's
+ * format (page size, columns, fonts, font sizes, page limits per kind), the TeX packages its
+ * template needs, and the rules it implies. A preset may build on another with its own `extends`:
+ * `agenticdev` extends the family `acm-sigconf`, which holds everything the ACM template decides.
+ *
+ * ── TWO SPEC FORMS, AND ONLY TWO ─────────────────────────────────────────────────
+ *   paperlint:<name>   a preset shipped in the package's venues directory
+ *   ./x.jsonc, ../x    a file of the project's own, relative to the file that names it
+ * Anything else — an npm package name, a bare name — is refused by name. npm presets are not
+ * supported yet; a bare name is almost always a shipped name missing its prefix, and the message says so.
+ *
+ * ── THE CHAIN ─────────────────────────────────────────────────────────────────────
+ * At most `MAX_PRESET_DEPTH` files, root to leaf. A cycle (relative paths can form one) is refused
+ * naming the chain. The chain is merged block by block:
+ *
+ *   tex        union — a child never removes a package its parent needs
+ *   format     per key, the child wins; `kinds` by kind name, a child's kind replaces that kind
+ *   rules      per rule id, the child wins
+ *   template   the child wins; so does `name`
+ *
+ * ── THE LABEL ─────────────────────────────────────────────────────────────────────
+ * Messages, the facts file and the build plan need a word for the venue. It is the most derived
+ * preset's `name` when one sets it, else the spec's file name without its extension
+ * (`paperlint:agenticdev` → `agenticdev`, `./venues/usenix-sec.jsonc` → `usenix-sec`). Display
+ * only: nothing is ever resolved by it.
+ */
+import { basename, dirname, extname, join, resolve } from "node:path";
+import { mergeRequirements, NO_FORMAT, NO_REQUIREMENTS, parsePreset, profileFileOf, venueNames, } from "./tex-requirements.js";
+import { err, ok } from "./domain/result.js";
+import { readPaperSettings, } from "./paper-settings.js";
+import { CONFIG_FILE } from "../lib/paper-config.mjs";
+/** The prefix of a shipped preset's spec. */
+export const SHIPPED_PREFIX = "paperlint:";
+/** The longest chain of presets, the paper's own target included. */
+export const MAX_PRESET_DEPTH = 4;
+/** The display label of a spec: the file name without its extension. Pure. */
+export function labelOf(spec) {
+    const name = spec.startsWith(SHIPPED_PREFIX)
+        ? spec.slice(SHIPPED_PREFIX.length)
+        : basename(spec);
+    return name.slice(0, name.length - extname(name).length) || name;
+}
+const isRelative = (spec) => spec.startsWith("./") || spec.startsWith("../");
+/** A spec → the file it names, or why it names none. Pure. */
+function fileOf(spec, from, venuesDir) {
+    if (isRelative(spec))
+        return ok(resolve(dirname(from), spec));
+    if (!spec.startsWith(SHIPPED_PREFIX))
+        return err({ kind: "unsupported", spec });
+    const file = profileFileOf(spec.slice(SHIPPED_PREFIX.length));
+    return file === null
+        ? err({ kind: "not-found", spec, file: spec, shipped: [] })
+        : ok(join(venuesDir, file));
+}
+/** One file of the chain: read and parsed, or why not. */
+function readPreset(spec, from, deps) {
+    const where = fileOf(spec, from, deps.venuesDir);
+    if (!where.ok)
+        return where;
+    const bytes = deps.files.readBytes(where.value);
+    if (bytes === null)
+        return err({ kind: "not-found", spec, file: where.value, shipped: [] });
+    try {
+        const text = new TextDecoder().decode(bytes);
+        return ok({
+            file: where.value,
+            preset: parsePreset(text, where.value, deps.venuesDir),
+        });
+    }
+    catch (e) {
+        return err({
+            kind: "broken",
+            file: where.value,
+            why: e.message.split("\n").join(" "),
+        });
+    }
+}
+/** The chain's files, leaf first, each parsed. */
+function chainOf(spec, from, deps) {
+    const out = [];
+    let next = { spec, from };
+    while (next !== null) {
+        const r = readPreset(next.spec, next.from, deps);
+        if (!r.ok)
+            return r;
+        const files = out.map((x) => x.file);
+        if (files.includes(r.value.file))
+            return err({ kind: "cycle", chain: [...files, r.value.file] });
+        if (out.length === MAX_PRESET_DEPTH)
+            return err({ kind: "too-deep", chain: [...files, r.value.file] });
+        out.push(r.value);
+        const up = r.value.preset.extends;
+        next = up === null ? null : { spec: up, from: r.value.file };
+    }
+    return ok(out);
+}
+/** A child's format over its parent's: per key the child wins, kinds by name. Pure. */
+export function mergeFormat(parent, child) {
+    const keys = Object.keys(NO_FORMAT).filter((k) => k !== "kinds");
+    const scalars = Object.fromEntries(keys.map((k) => [k, child[k] ?? parent[k]]));
+    return { ...scalars, kinds: new Map([...parent.kinds, ...child.kinds]) };
+}
+/** The chain, root first, merged into one preset. Pure. */
+function merged(spec, rootFirst, files) {
+    const base = {
+        name: null,
+        template: null,
+        tex: NO_REQUIREMENTS,
+        format: NO_FORMAT,
+        rules: {},
+    };
+    const m = rootFirst.reduce((acc, p) => ({
+        name: p.name ?? acc.name,
+        template: p.template ?? acc.template,
+        tex: p.tex ? mergeRequirements(acc.tex, p.tex) : acc.tex,
+        format: mergeFormat(acc.format, p.format),
+        rules: { ...acc.rules, ...p.rules },
+    }), base);
+    return {
+        label: m.name ?? labelOf(spec),
+        chain: files,
+        template: m.template,
+        tex: m.tex,
+        format: m.format,
+        rules: m.rules,
+    };
+}
+/**
+ * `spec`, as written in `fromFile` (a paper's `paperlint.json`), → the merged preset, or why it
+ * does not resolve. Reads through `deps.files` only; never throws.
+ */
+export function resolvePreset(spec, fromFile, deps) {
+    const chain = chainOf(spec, fromFile, deps);
+    if (!chain.ok)
+        return chain.error.kind === "not-found"
+            ? err({ ...chain.error, shipped: shippedPresets(deps.venuesDir) })
+            : chain;
+    const rootFirst = [...chain.value].reverse();
+    return ok(merged(spec, rootFirst.map((x) => x.preset), rootFirst.map((x) => x.file)));
+}
+/** The shipped presets' names (each is spelled `paperlint:<name>`). */
+export function shippedPresets(venuesDir) {
+    return venueNames(venuesDir);
+}
+/** One line for a problem, naming what to change. Pure. */
+export function presetProblemText(p) {
+    switch (p.kind) {
+        case "unsupported":
+            return `"extends": "${p.spec}" — a preset is \`paperlint:<name>\` (shipped) or a path starting with ./ or ../ (your own); npm presets: not yet supported. Did you mean "${SHIPPED_PREFIX}${p.spec}"?`;
+        case "not-found":
+            return `"extends": "${p.spec}" names no preset (${p.file}); shipped presets (${SHIPPED_PREFIX}<name>): ${p.shipped.join(", ")}`;
+        case "cycle":
+            return `the presets extend each other in a cycle: ${p.chain.join(" → ")}`;
+        case "too-deep":
+            return `the preset chain is longer than ${String(MAX_PRESET_DEPTH)}: ${p.chain.join(" → ")}`;
+        case "broken":
+            return `the preset ${p.file} does not parse: ${p.why}`;
+    }
+}
+/** A paper directory → its settings and its resolved preset. Reads through `deps.files`; never throws. */
+export function paperPreset(paperDir, deps) {
+    const read = readPaperSettings(deps.files, paperDir);
+    if (!read.ok)
+        return { kind: "settings-problem", problem: read.error };
+    const settings = read.value;
+    if (settings?.extends == null)
+        return { kind: "none", settings };
+    const r = resolvePreset(settings.extends, join(paperDir, CONFIG_FILE), deps);
+    return r.ok
+        ? { kind: "resolved", settings, preset: r.value }
+        : { kind: "preset-problem", settings, problem: r.error };
+}
+/** The one-line reason a paper's settings or preset cannot be used, or null when they can. */
+export function paperPresetProblem(paperDir, p) {
+    if (p.kind === "preset-problem")
+        return `${join(paperDir, CONFIG_FILE)}: ${presetProblemText(p.problem)}`;
+    if (p.kind !== "settings-problem")
+        return null;
+    return `${join(paperDir, CONFIG_FILE)}: ${p.problem.why}`;
+}
+//# sourceMappingURL=presets.js.map

package/dist/presets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"presets.js","sourceRoot":"","sources":["../src/presets.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACtE,OAAO,EACL,iBAAiB,EACjB,SAAS,EACT,eAAe,EACf,WAAW,EACX,aAAa,EACb,UAAU,GAIX,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,GAAG,EAAE,EAAE,EAAe,MAAM,oBAAoB,CAAC;AAE1D,OAAO,EACL,iBAAiB,GAGlB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEtD,6CAA6C;AAC7C,MAAM,CAAC,MAAM,cAAc,GAAG,YAAY,CAAC;AAC3C,qEAAqE;AACrE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAiClC,8EAA8E;AAC9E,MAAM,UAAU,OAAO,CAAC,IAAY;IAClC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;QAC1C,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC;QACnC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,IAAY,EAAW,EAAE,CAC3C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;AAElD,8DAA8D;AAC9D,SAAS,MAAM,CACb,IAAY,EACZ,IAAY,EACZ,SAAiB;IAEjB,IAAI,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IAC9D,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;QAClC,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9D,OAAO,IAAI,KAAK,IAAI;QAClB,CAAC,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAC3D,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;AAChC,CAAC;AAED,0DAA0D;AAC1D,SAAS,UAAU,CACjB,IAAY,EACZ,IAAY,EACZ,IAAgB;IAEhB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACjD,IAAI,CAAC,KAAK,CAAC,EAAE;QAAE,OAAO,KAAK,CAAC;IAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,KAAqB,CAAC,CAAC;IAChE,IAAI,KAAK,KAAK,IAAI;QAChB,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC1E,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7C,OAAO,EAAE,CAAC;YACR,IAAI,EAAE,KAAK,CAAC,KAAK;YACjB,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC;SACvD,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,GAAG,CAAC;YACT,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,KAAK,CAAC,KAAK;YACjB,GAAG,EAAG,CAAW,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;SAChD,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,kDAAkD;AAClD,SAAS,OAAO,CACd,IAAY,EACZ,IAAY,EACZ,IAAgB;IAEhB,MAAM,GAAG,GAA2C,EAAE,CAAC;IACvD,IAAI,IAAI,GAA0C,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACjE,OAAO,IAAI,KAAK,IAAI,EAAE,CAAC;QACrB,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,CAAC,CAAC,EAAE;YAAE,OAAO,CAAC,CAAC;QACpB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;YAC9B,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjE,IAAI,GAAG,CAAC,MAAM,KAAK,gBAAgB;YACjC,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAClB,MAAM,EAAE,GAAkB,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC;QACjD,IAAI,GAAG,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC/D,CAAC;IACD,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;AACjB,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,WAAW,CACzB,MAAmB,EACnB,KAAkB;IAElB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,OAAO,CAG5D,CAAC;IACJ,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CACd,CAAC;IAChC,OAAO,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;AAC3E,CAAC;AAED,2DAA2D;AAC3D,SAAS,MAAM,CACb,IAAY,EACZ,SAAgC,EAChC,KAAwB;IAExB,MAAM,IAAI,GAAG;QACX,IAAI,EAAE,IAAqB;QAC3B,QAAQ,EAAE,IAAqB;QAC/B,GAAG,EAAE,eAAe;QACpB,MAAM,EAAE,SAAS;QACjB,KAAK,EAAE,EAAuC;KAC/C,CAAC;IACF,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,CACxB,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACX,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI;QACxB,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ;QACpC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG;QACxD,MAAM,EAAE,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACzC,KAAK,EAAE,EAAE,GAAG,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE;KACpC,CAAC,EACF,IAAI,CACL,CAAC;IACF,OAAO;QACL,KAAK,EAAE,CAAC,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;QAC9B,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,GAAG,EAAE,CAAC,CAAC,GAAG;QACV,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,KAAK,EAAE,CAAC,CAAC,KAAK;KACf,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAY,EACZ,QAAgB,EAChB,IAAgB;IAEhB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC5C,IAAI,CAAC,KAAK,CAAC,EAAE;QACX,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW;YACrC,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAClE,CAAC,CAAC,KAAK,CAAC;IACZ,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;IAC7C,OAAO,EAAE,CACP,MAAM,CACJ,IAAI,EACJ,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAC9B,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAC7B,CACF,CAAC;AACJ,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,cAAc,CAAC,SAAiB;IAC9C,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC;AAC/B,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,iBAAiB,CAAC,CAAgB;IAChD,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACf,KAAK,aAAa;YAChB,OAAO,eAAe,CAAC,CAAC,IAAI,8IAA8I,cAAc,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC;QACxM,KAAK,WAAW;YACd,OAAO,eAAe,CAAC,CAAC,IAAI,sBAAsB,CAAC,CAAC,IAAI,uBAAuB,cAAc,YAAY,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAClI,KAAK,OAAO;YACV,OAAO,6CAA6C,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5E,KAAK,UAAU;YACb,OAAO,mCAAmC,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/F,KAAK,QAAQ;YACX,OAAO,cAAc,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAC,GAAG,EAAE,CAAC;IAC3D,CAAC;AACH,CAAC;AAsBD,0GAA0G;AAC1G,MAAM,UAAU,WAAW,CAAC,QAAgB,EAAE,IAAgB;IAC5D,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACrD,IAAI,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC;IAC5B,IAAI,QAAQ,EAAE,OAAO,IAAI,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IACjE,MAAM,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC;IAC7E,OAAO,CAAC,CAAC,EAAE;QACT,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE;QACjD,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;AAC7D,CAAC;AAED,8FAA8F;AAC9F,MAAM,UAAU,kBAAkB,CAChC,QAAgB,EAChB,CAAc;IAEd,IAAI,CAAC,CAAC,IAAI,KAAK,gBAAgB;QAC7B,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,KAAK,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAC3E,IAAI,CAAC,CAAC,IAAI,KAAK,kBAAkB;QAAE,OAAO,IAAI,CAAC;IAC/C,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;AAC5D,CAAC"}

package/dist/reference-rules.d.ts

@@ -0,0 +1,47 @@
+import type { Files } from "./ports/files.ts";
+interface Loc {
+    readonly line: number;
+    readonly column: number;
+}
+interface RuleContext {
+    readonly filename: string;
+    readonly cwd: string;
+    readonly sourceCode: {
+        getLocFromIndex(i: number): Loc;
+    };
+    report(d: {
+        loc: {
+            start: Loc;
+            end: Loc;
+        };
+        messageId: string;
+        data?: Record<string, string>;
+    }): void;
+}
+export interface ReferenceRuleModule {
+    readonly meta: {
+        readonly type: "problem" | "suggestion";
+        readonly docs: {
+            readonly description: string;
+        };
+        readonly schema: readonly object[];
+        readonly messages: Readonly<Record<string, string>>;
+    };
+    create(context: RuleContext): {
+        "root:exit"?: () => void;
+    };
+}
+type Name = "author-list" | "cite-exists" | "refs-checked" | "refs-fresh";
+/** The four rules, reading through `files`. They act on `paper.tex` only. */
+export declare function referenceRules({ files, }: {
+    files: Files;
+}): Record<Name, ReferenceRuleModule>;
+/** The level each is on at for every `paper.tex` in paperlint's own config. */
+export declare const REFERENCE_RULE_LEVELS: {
+    readonly "paper/author-list": "error";
+    readonly "paper/cite-exists": "error";
+    readonly "paper/refs-checked": "warn";
+    readonly "paper/refs-fresh": "error";
+};
+export {};
+//# sourceMappingURL=reference-rules.d.ts.map

package/dist/reference-rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reference-rules.d.ts","sourceRoot":"","sources":["../src/reference-rules.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAS9C,UAAU,GAAG;IACX,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AACD,UAAU,WAAW;IACnB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,UAAU,EAAE;QACnB,eAAe,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;KACjC,CAAC;IACF,MAAM,CAAC,CAAC,EAAE;QACR,GAAG,EAAE;YAAE,KAAK,EAAE,GAAG,CAAC;YAAC,GAAG,EAAE,GAAG,CAAA;SAAE,CAAC;QAC9B,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC/B,GAAG,IAAI,CAAC;CACV;AACD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE;QACb,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,YAAY,CAAC;QACxC,QAAQ,CAAC,IAAI,EAAE;YAAE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;SAAE,CAAC;QAChD,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;QACnC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;KACrD,CAAC;IACF,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG;QAAE,WAAW,CAAC,EAAE,MAAM,IAAI,CAAA;KAAE,CAAC;CAC5D;AAED,KAAK,IAAI,GAAG,aAAa,GAAG,aAAa,GAAG,cAAc,GAAG,YAAY,CAAC;AAgI1E,6EAA6E;AAC7E,wBAAgB,cAAc,CAAC,EAC7B,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,MAAM,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAiCpC;AAED,+EAA+E;AAC/E,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC"}

package/dist/reference-rules.js

@@ -0,0 +1,156 @@
+/**
+ * The reference rules — `paper/author-list`, `paper/cite-exists`, `paper/refs-checked`,
+ * `paper/refs-fresh` — judge `_build/references.json` (`references.ts`), offline. `paperlint build`
+ * does the online work; lint never touches the network.
+ *
+ *   entry whose authors are the preprint's   paper/author-list (error), on the entry
+ *   entry whose identifier provably fails    paper/cite-exists (error), on the entry
+ *   no record, or recorded "not checked"     paper/refs-checked (warn) — like pdf/measured
+ *   bibliography edited after the build      paper/refs-fresh (error) — like pdf/fresh
+ *
+ * While the record is stale, the per-entry rules are silent: they would judge a bibliography
+ * that no longer exists, and refs-fresh already says so once. A paper with no bibliography gets
+ * nothing.
+ *
+ * `paper/author-list` used to live on PIPELINE-STATUS.md and ask whether the scorecard mentioned
+ * a run. It lives here now because its subject is the bibliography, and the record of the run is
+ * the run's own output.
+ */
+import { basename, dirname } from "node:path";
+import { bibHash, bibliographyOf, readReferences, REFERENCES_FILE, } from "./references.js";
+function assess(files, paperDir) {
+    const bib = bibliographyOf(files, paperDir);
+    if (bib === null)
+        return { kind: "no-bibliography" };
+    const doc = readReferences(files, paperDir);
+    if (doc === null)
+        return { kind: "unrecorded" };
+    if (doc.bib.sha256 !== bibHash(bib))
+        return { kind: "stale" };
+    if (doc.status === "not-checked")
+        return { kind: "not-checked", why: doc.why ?? "no reason recorded" };
+    const failing = doc.entries.flatMap((e) => [
+        ...(e.authors === "mismatch"
+            ? [{ key: e.key, rule: "author-list", why: e.why ?? "" }]
+            : []),
+        ...(e.exists === "false"
+            ? [{ key: e.key, rule: "cite-exists", why: e.why ?? "" }]
+            : []),
+    ]);
+    return { kind: "ready", bib, failing };
+}
+/** Where entry `key` starts in the source file: its `@type{key,` line, or the file's start. */
+function entryOffset(bib, key) {
+    const escaped = key.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+    const m = new RegExp(`^@\\w+\\s*\\{\\s*${escaped}\\s*,`, "m").exec(bib.text);
+    return m ? bib.offset + m.index : 0;
+}
+const BUILD = "`npx paperlint build`";
+const META = {
+    "author-list": {
+        type: "problem",
+        docs: {
+            description: "each entry's authors are those of the version it cites, not the preprint's (recorded by paperlint build)",
+        },
+        schema: [],
+        messages: {
+            mismatch: "`{{key}}`: the authors are not those of the version cited — {{why}}. The citation resolves and the id resolves, and the list is the PREPRINT's under a published venue",
+        },
+    },
+    "cite-exists": {
+        type: "problem",
+        docs: {
+            description: "each entry's identifier resolves to the work cited (recorded by paperlint build)",
+        },
+        schema: [],
+        messages: {
+            missing: "`{{key}}` does not resolve to the work cited — {{why}}",
+        },
+    },
+    "refs-checked": {
+        type: "suggestion",
+        docs: {
+            description: "the build checked the references online (existence, title, authors); a warning when it could not",
+        },
+        schema: [],
+        messages: {
+            unrecorded: `the references have not been checked — ${BUILD} checks them online and records the result in _build/${REFERENCES_FILE}`,
+            notChecked: `the last build could not check the references ({{why}}) — run ${BUILD} with network`,
+        },
+    },
+    "refs-fresh": {
+        type: "problem",
+        docs: {
+            description: "the recorded reference verdicts are about the bibliography on disk, not an earlier one",
+        },
+        schema: [],
+        messages: {
+            stale: `the references changed since the last build checked them — run ${BUILD}`,
+        },
+    },
+};
+const JUDGES = {
+    "author-list": (a) => a.kind === "ready"
+        ? a.failing
+            .filter((f) => f.rule === "author-list")
+            .map((f) => ({
+            at: entryOffset(a.bib, f.key),
+            messageId: "mismatch",
+            data: { key: f.key, why: f.why },
+        }))
+        : [],
+    "cite-exists": (a) => a.kind === "ready"
+        ? a.failing
+            .filter((f) => f.rule === "cite-exists")
+            .map((f) => ({
+            at: entryOffset(a.bib, f.key),
+            messageId: "missing",
+            data: { key: f.key, why: f.why },
+        }))
+        : [],
+    "refs-checked": (a) => a.kind === "unrecorded"
+        ? [{ at: 0, messageId: "unrecorded" }]
+        : a.kind === "not-checked"
+            ? [{ at: 0, messageId: "notChecked", data: { why: a.why } }]
+            : [],
+    "refs-fresh": (a) => a.kind === "stale" ? [{ at: 0, messageId: "stale" }] : [],
+};
+/** The four rules, reading through `files`. They act on `paper.tex` only. */
+export function referenceRules({ files, }) {
+    const make = (name) => ({
+        meta: META[name],
+        create: (context) => basename(context.filename) !== "paper.tex"
+            ? {}
+            : {
+                "root:exit": () => {
+                    const paperDir = dirname(context.filename);
+                    const a = assess(files, paperDir);
+                    // An external refs.bib: the entry is not in this file, so the finding sits at its
+                    // start and names the key.
+                    const external = a.kind === "ready" && a.bib.source !== "paper.tex";
+                    for (const r of JUDGES[name](a)) {
+                        const loc = context.sourceCode.getLocFromIndex(external ? 0 : r.at);
+                        context.report({
+                            loc: { start: loc, end: loc },
+                            messageId: r.messageId,
+                            ...(r.data ? { data: r.data } : {}),
+                        });
+                    }
+                },
+            },
+    });
+    return {
+        "author-list": make("author-list"),
+        "cite-exists": make("cite-exists"),
+        "refs-checked": make("refs-checked"),
+        "refs-fresh": make("refs-fresh"),
+    };
+}
+/** The level each is on at for every `paper.tex` in paperlint's own config. */
+export const REFERENCE_RULE_LEVELS = {
+    "paper/author-list": "error",
+    "paper/cite-exists": "error",
+    "paper/refs-checked": "warn",
+    "paper/refs-fresh": "error",
+};
+//# sourceMappingURL=reference-rules.js.map

package/dist/reference-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reference-rules.js","sourceRoot":"","sources":["../src/reference-rules.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAE9C,OAAO,EACL,OAAO,EACP,cAAc,EACd,cAAc,EACd,eAAe,GAEhB,MAAM,iBAAiB,CAAC;AA8CzB,SAAS,MAAM,CAAC,KAAY,EAAE,QAAgB;IAC5C,MAAM,GAAG,GAAG,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC5C,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;IACrD,MAAM,GAAG,GAAG,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC5C,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAChD,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAC9D,IAAI,GAAG,CAAC,MAAM,KAAK,aAAa;QAC9B,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,oBAAoB,EAAE,CAAC;IACvE,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACzC,GAAG,CAAC,CAAC,CAAC,OAAO,KAAK,UAAU;YAC1B,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,aAAsB,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC;YAClE,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO;YACtB,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,aAAsB,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC;YAClE,CAAC,CAAC,EAAE,CAAC;KACR,CAAC,CAAC;IACH,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;AACzC,CAAC;AAED,+FAA+F;AAC/F,SAAS,WAAW,CAAC,GAAiB,EAAE,GAAW;IACjD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAC3D,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,oBAAoB,OAAO,OAAO,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC7E,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,KAAK,GAAG,uBAAuB,CAAC;AAEtC,MAAM,IAAI,GAAwD;IAChE,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,0GAA0G;SAC7G;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,QAAQ,EACN,wKAAwK;SAC3K;KACF;IACD,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,kFAAkF;SACrF;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,OAAO,EAAE,wDAAwD;SAClE;KACF;IACD,cAAc,EAAE;QACd,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EACT,kGAAkG;SACrG;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,UAAU,EAAE,0CAA0C,KAAK,wDAAwD,eAAe,EAAE;YACpI,UAAU,EAAE,iEAAiE,KAAK,eAAe;SAClG;KACF;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,wFAAwF;SAC3F;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,KAAK,EAAE,kEAAkE,KAAK,EAAE;SACjF;KACF;CACF,CAAC;AAIF,MAAM,MAAM,GAAwD;IAClE,aAAa,EAAE,CAAC,CAAC,EAAE,EAAE,CACnB,CAAC,CAAC,IAAI,KAAK,OAAO;QAChB,CAAC,CAAC,CAAC,CAAC,OAAO;aACN,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC;aACvC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACX,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC;YAC7B,SAAS,EAAE,UAAU;YACrB,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE;SACjC,CAAC,CAAC;QACP,CAAC,CAAC,EAAE;IACR,aAAa,EAAE,CAAC,CAAC,EAAE,EAAE,CACnB,CAAC,CAAC,IAAI,KAAK,OAAO;QAChB,CAAC,CAAC,CAAC,CAAC,OAAO;aACN,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC;aACvC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACX,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC;YAC7B,SAAS,EAAE,SAAS;YACpB,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE;SACjC,CAAC,CAAC;QACP,CAAC,CAAC,EAAE;IACR,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,CACpB,CAAC,CAAC,IAAI,KAAK,YAAY;QACrB,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;QACtC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,aAAa;YACxB,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC;YAC5D,CAAC,CAAC,EAAE;IACV,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAClB,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE;CAC5D,CAAC;AAEF,6EAA6E;AAC7E,MAAM,UAAU,cAAc,CAAC,EAC7B,KAAK,GAGN;IACC,MAAM,IAAI,GAAG,CAAC,IAAU,EAAuB,EAAE,CAAC,CAAC;QACjD,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;QAChB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,CAClB,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,WAAW;YACxC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE,WAAW,EAAE,GAAG,EAAE;oBAChB,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC3C,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;oBAClC,kFAAkF;oBAClF,2BAA2B;oBAC3B,MAAM,QAAQ,GACZ,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,WAAW,CAAC;oBACrD,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;wBAChC,MAAM,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAC5C,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CACpB,CAAC;wBACF,OAAO,CAAC,MAAM,CAAC;4BACb,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;4BAC7B,SAAS,EAAE,CAAC,CAAC,SAAS;4BACtB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;yBACpC,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;aACF;KACR,CAAC,CAAC;IACH,OAAO;QACL,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAClC,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAClC,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC;QACpC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC;KACjC,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,mBAAmB,EAAE,OAAO;IAC5B,mBAAmB,EAAE,OAAO;IAC5B,oBAAoB,EAAE,MAAM;IAC5B,kBAAkB,EAAE,OAAO;CACnB,CAAC"}

package/dist/references.d.ts

@@ -0,0 +1,36 @@
+import type { Files } from "./ports/files.ts";
+import type { CheckReferences, EntryVerdict, ReferencesCheck } from "./ports/check-references.ts";
+export declare const REFERENCES_SCHEMA = 1;
+export declare const REFERENCES_FILE = "references.json";
+/** Where a paper's reference verdicts live — beside `paper.facts.json`. */
+export declare const referencesPath: (paperDir: string) => string;
+/** The bibliography a paper carries: inside `paper.tex` (`filecontents`), else `refs.bib`. */
+export interface Bibliography {
+    readonly source: "paper.tex" | "refs.bib";
+    readonly text: string;
+    /** Where `text` starts in the source file — so a finding can point at an entry. */
+    readonly offset: number;
+}
+export declare function bibliographyOf(files: Files, paperDir: string): Bibliography | null;
+export declare const bibHash: (b: Bibliography) => string;
+/** What `_build/references.json` holds. */
+export interface ReferencesDocument {
+    readonly schema: number;
+    readonly bib: {
+        readonly source: string;
+        readonly sha256: string;
+    };
+    readonly status: "checked" | "not-checked";
+    readonly why?: string;
+    readonly entries: readonly EntryVerdict[];
+}
+export declare const documentOf: (bib: Bibliography, check: ReferencesCheck) => ReferencesDocument;
+/** The recorded verdicts, or null when there are none or they do not parse. */
+export declare function readReferences(files: Files, paperDir: string): ReferencesDocument | null;
+/**
+ * The build step's work: check the bibliography and record the verdicts. Returns the one-line
+ * note the build prints. A checker that throws is recorded as `not-checked` — the step reports,
+ * it never refuses.
+ */
+export declare function recordReferences(files: Files, paperDir: string, check: CheckReferences): Promise<string>;
+//# sourceMappingURL=references.d.ts.map

package/dist/references.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"references.d.ts","sourceRoot":"","sources":["../src/references.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EACV,eAAe,EACf,YAAY,EACZ,eAAe,EAChB,MAAM,6BAA6B,CAAC;AAIrC,eAAO,MAAM,iBAAiB,IAAI,CAAC;AACnC,eAAO,MAAM,eAAe,oBAAoB,CAAC;AAEjD,2EAA2E;AAC3E,eAAO,MAAM,cAAc,GAAI,UAAU,MAAM,KAAG,MACP,CAAC;AAQ5C,8FAA8F;AAC9F,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,UAAU,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,mFAAmF;IACnF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,wBAAgB,cAAc,CAC5B,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,MAAM,GACf,YAAY,GAAG,IAAI,CAOrB;AAED,eAAO,MAAM,OAAO,GAAI,GAAG,YAAY,KAAG,MACG,CAAC;AAE9C,2CAA2C;AAC3C,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE;QAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACnE,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,aAAa,CAAC;IAC3C,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAC;CAC3C;AAED,eAAO,MAAM,UAAU,GACrB,KAAK,YAAY,EACjB,OAAO,eAAe,KACrB,kBAMD,CAAC;AAEH,+EAA+E;AAC/E,wBAAgB,cAAc,CAC5B,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,MAAM,GACf,kBAAkB,GAAG,IAAI,CAW3B;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,eAAe,GACrB,OAAO,CAAC,MAAM,CAAC,CAoBjB"}

package/dist/references.js

@@ -0,0 +1,91 @@
+/**
+ * THE REFERENCES A BUILD CHECKED — `<paper>/_build/references.json`, written by `paperlint build`
+ * and read, offline, by the lint rules in `reference-rules.ts`.
+ *
+ * The package ships two online checks: `verify-cites` (the cited work exists and its title
+ * matches) and `bib-authors` (the authors are those of the version cited, not the preprint's).
+ * Until 3.0.0 lint could only ask whether someone had run them — by finding the word
+ * "bib-authors" in a scorecard table, or a command the project configured. Now the build runs
+ * them and records the result as data, beside the facts it already writes about the PDF:
+ *
+ *   { "schema": 1,
+ *     "bib": { "source": "paper.tex", "sha256": "…" },       the bibliography that was checked
+ *     "status": "checked" | "not-checked", "why": "…",       not-checked: nothing could be asked
+ *     "entries": [ { "key", "exists", "authors", "why" } ] }
+ *
+ * A sibling file, not a new field of `paper.facts.json`: those facts are about ONE PDF and are
+ * stale when it changes (`pdf_sha256`); these are about the bibliography and are stale when IT
+ * changes (`bib.sha256`). One staleness key per file, the way `pdf/fresh` already works.
+ *
+ * 🔴 THE STEP NEVER FAILS THE BUILD. A build without network still builds the PDF; the reference
+ * step records `not-checked` and the lint rule says so, as a warning. Recording "not checked" as
+ * a pass would be the counter that counts what it never looked at.
+ */
+import { join } from "node:path";
+import { sha256Hex } from "./domain/sha256.js";
+// @ts-expect-error — an ESLint rule module in .mjs, it has no types
+import { bibRange } from "../eslint-rules/paper-typography.mjs";
+export const REFERENCES_SCHEMA = 1;
+export const REFERENCES_FILE = "references.json";
+/** Where a paper's reference verdicts live — beside `paper.facts.json`. */
+export const referencesPath = (paperDir) => join(paperDir, "_build", REFERENCES_FILE);
+const at = (p) => p;
+const text = (files, p) => {
+    const b = files.readBytes(at(p));
+    return b === null ? null : new TextDecoder().decode(b);
+};
+export function bibliographyOf(files, paperDir) {
+    const tex = text(files, join(paperDir, "paper.tex"));
+    const inline = tex === null ? null : bibRange(tex);
+    if (inline)
+        return { source: "paper.tex", text: inline.body, offset: inline.bodyStart };
+    const bib = text(files, join(paperDir, "refs.bib"));
+    return bib === null ? null : { source: "refs.bib", text: bib, offset: 0 };
+}
+export const bibHash = (b) => sha256Hex(new TextEncoder().encode(b.text));
+export const documentOf = (bib, check) => ({
+    schema: REFERENCES_SCHEMA,
+    bib: { source: bib.source, sha256: bibHash(bib) },
+    ...(check.kind === "checked"
+        ? { status: "checked", entries: check.entries }
+        : { status: "not-checked", why: check.why, entries: [] }),
+});
+/** The recorded verdicts, or null when there are none or they do not parse. */
+export function readReferences(files, paperDir) {
+    const raw = text(files, referencesPath(paperDir));
+    if (raw === null)
+        return null;
+    try {
+        const d = JSON.parse(raw);
+        return d?.schema === REFERENCES_SCHEMA && Array.isArray(d.entries)
+            ? d
+            : null;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * The build step's work: check the bibliography and record the verdicts. Returns the one-line
+ * note the build prints. A checker that throws is recorded as `not-checked` — the step reports,
+ * it never refuses.
+ */
+export async function recordReferences(files, paperDir, check) {
+    const bib = bibliographyOf(files, paperDir);
+    if (bib === null)
+        return "no bibliography — nothing to check";
+    let result;
+    try {
+        result = await check(bib.text);
+    }
+    catch (e) {
+        result = { kind: "not-checked", why: e.message };
+    }
+    const doc = documentOf(bib, result);
+    files.writeAtomic(at(referencesPath(paperDir)), new TextEncoder().encode(`${JSON.stringify(doc, null, 2)}\n`));
+    if (doc.status === "not-checked")
+        return `references NOT checked — ${doc.why ?? "no reason given"}; lint will say so`;
+    const bad = doc.entries.filter((e) => e.exists === "false" || e.authors === "mismatch").length;
+    return `references: ${String(doc.entries.length)} checked, ${String(bad)} failing → _build/${REFERENCES_FILE}`;
+}
+//# sourceMappingURL=references.js.map

package/dist/references.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"references.js","sourceRoot":"","sources":["../src/references.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAO/C,oEAAoE;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AAEhE,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC;AACnC,MAAM,CAAC,MAAM,eAAe,GAAG,iBAAiB,CAAC;AAEjD,2EAA2E;AAC3E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,QAAgB,EAAU,EAAE,CACzD,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;AAE5C,MAAM,EAAE,GAAG,CAAC,CAAS,EAAgB,EAAE,CAAC,CAAiB,CAAC;AAC1D,MAAM,IAAI,GAAG,CAAC,KAAY,EAAE,CAAS,EAAiB,EAAE;IACtD,MAAM,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACjC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC;AAUF,MAAM,UAAU,cAAc,CAC5B,KAAY,EACZ,QAAgB;IAEhB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACnD,IAAI,MAAM;QACR,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;IAC9E,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IACpD,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;AAC5E,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAe,EAAU,EAAE,CACjD,SAAS,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAW9C,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,GAAiB,EACjB,KAAsB,EACF,EAAE,CAAC,CAAC;IACxB,MAAM,EAAE,iBAAiB;IACzB,GAAG,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE;IACjD,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS;QAC1B,CAAC,CAAC,EAAE,MAAM,EAAE,SAAkB,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE;QACxD,CAAC,CAAC,EAAE,MAAM,EAAE,aAAsB,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;CACrE,CAAC,CAAC;AAEH,+EAA+E;AAC/E,MAAM,UAAU,cAAc,CAC5B,KAAY,EACZ,QAAgB;IAEhB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IAClD,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC9B,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAuB,CAAC;QAChD,OAAO,CAAC,EAAE,MAAM,KAAK,iBAAiB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;YAChE,CAAC,CAAC,CAAC;YACH,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,KAAY,EACZ,QAAgB,EAChB,KAAsB;IAEtB,MAAM,GAAG,GAAG,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC5C,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,oCAAoC,CAAC;IAC9D,IAAI,MAAuB,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,GAAG,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,EAAG,CAAW,CAAC,OAAO,EAAE,CAAC;IAC9D,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACpC,KAAK,CAAC,WAAW,CACf,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,EAC5B,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAC9D,CAAC;IACF,IAAI,GAAG,CAAC,MAAM,KAAK,aAAa;QAC9B,OAAO,4BAA4B,GAAG,CAAC,GAAG,IAAI,iBAAiB,oBAAoB,CAAC;IACtF,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAC5B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,IAAI,CAAC,CAAC,OAAO,KAAK,UAAU,CACxD,CAAC,MAAM,CAAC;IACT,OAAO,eAAe,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,MAAM,CAAC,GAAG,CAAC,qBAAqB,eAAe,EAAE,CAAC;AACjH,CAAC"}

package/dist/rules-config.d.ts

@@ -18,10 +18,19 @@ export type Parsed<T> = {
 /** Every top-level key must be one paperlint or its skills read. */
 export declare function unknownKeys(settings: Record<string, unknown>): string[];
 /**
- * The `rules` key → config blocks, or one error naming the key path.
+ * A `rules` object — rule id → severity or `[severity, ...options]` — with only the rules paperlint
+ * ships. Read from every `paperlint.json`, the root's and each paper's.
+ *
+ * @param where  the key path to name in messages, e.g. `package.json → "paperlint".rules[0].rules`
+ */
+export declare function parseRuleEntries(v: unknown, where: string, shipped: ReadonlySet<string>): Parsed<Record<string, RuleEntry>>;
+/**
+ * The `rules` key → config blocks, or one error naming the key path. Two shapes, at every level:
+ * `{ id: severity }` is one block over every paper file under `baseDir`; a list is ESLint blocks
+ * (`files`, `ignores`, `rules`), their globs relative to `baseDir`.
  *
  * @param raw      the value under `rules` (undefined when absent)
- * @param where    how the settings are named in messages, e.g. `package.json → "paperlint"`
+ * @param where    how the settings are named in messages, e.g. `paperlint.json`
  * @param shipped  the rule ids paperlint ships (`shippedRuleIds`)
  * @param baseDir  the directory of the file holding the settings
  */

package/dist/rules-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rules-config.d.ts","sourceRoot":"","sources":["../src/rules-config.ts"],"names":[],"mappings":"AA6BA,qDAAqD;AACrD,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC5D,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAErE,yFAAyF;AACzF,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;CACrD;AAED,MAAM,MAAM,MAAM,CAAC,CAAC,IAChB;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GACxC;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAOnD,oEAAoE;AACpE,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,CAEvE;AA8ED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,EAC5B,OAAO,EAAE,MAAM,GACd,MAAM,CAAC,SAAS,SAAS,EAAE,CAAC,CAa9B;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,SAAS,OAAO,EAAE,EAC1B,OAAO,EAAE,SAAS,OAAO,EAAE,GAC1B,GAAG,CAAC,MAAM,CAAC,CAWb"}
+{"version":3,"file":"rules-config.d.ts","sourceRoot":"","sources":["../src/rules-config.ts"],"names":[],"mappings":"AA6BA,qDAAqD;AACrD,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC5D,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;AAErE,yFAAyF;AACzF,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;CACrD;AAED,MAAM,MAAM,MAAM,CAAC,CAAC,IAChB;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GACxC;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAQnD,oEAAoE;AACpE,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,CAEvE;AAcD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,CAAC,EAAE,OAAO,EACV,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,GAC3B,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAiBnC;AA6CD;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,OAAO,EACZ,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,EAC5B,OAAO,EAAE,MAAM,GACd,MAAM,CAAC,SAAS,SAAS,EAAE,CAAC,CAmB9B;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,SAAS,OAAO,EAAE,EAC1B,OAAO,EAAE,SAAS,OAAO,EAAE,GAC1B,GAAG,CAAC,MAAM,CAAC,CAWb"}