paperlint 7.2.0 → 9.0.0

package/src/tex-venue-rules.test.ts

@@ -7,6 +7,7 @@ import { readdirSync, readFileSync } from "node:fs";
 import { join } from "node:path";
 import { describe, expect, it } from "vitest";
 import { memoryFiles } from "./adapters/memory/index.ts";
+import { sourcesCodec } from "./adapters/sources-record/index.ts";
 import { presetsDir } from "./package-dirs.ts";
 import { latexReader } from "./adapters/latex/index.ts";
 import {
@@ -21,10 +22,13 @@ import {
 } from "./tex-venue-rules.ts";
 import { resolvePreset } from "./presets.ts";
 import { buildConfig, SHIPPED_RULES } from "./cli.ts";
+import { builtPaper } from "../test/recorded-fixture.ts";
 import { venuePreset } from "../test/support.ts";
 
 const VENUES = presetsDir();
 const PAPER = "/work/papers/p";
+/** What the rules read with besides the files: the presets, the LaTeX reader, the record's schema. */
+const READERS = { venuesDir: VENUES, latex: latexReader, codec: sourcesCodec };
 const shipped = Object.fromEntries(
   readdirSync(VENUES)
     .filter((f) => f.endsWith(".jsonc") || f.endsWith(".json"))
@@ -70,7 +74,7 @@ function lint(
     ...extra,
   });
   const out: Finding[] = [];
-  const deps = { files, venuesDir: VENUES, latex: latexReader };
+  const deps = { files, ...READERS };
   for (const [id, rule] of [
     ...Object.entries(texVenueRules(deps)).map(
       ([n, r]) => [`tex/${n}`, r] as const,
@@ -207,13 +211,29 @@ describe("the venue rules read the whole paper: the files it \\inputs, spliced w
       "\\documentclass[conference,compsoc]{IEEEtran}",
       "Text.\n\\input{sections/closing}",
     );
-    const extra = {
-      [`${PAPER}/sections/closing.tex`]:
-        "\\section*{LLM Usage Statement}\nNone.\n",
-    };
+    // The build recorded TeX reading both files.
+    const extra = builtPaper(
+      PAPER,
+      {
+        "paper.tex": tex,
+        "sections/closing.tex": "\\section*{LLM Usage Statement}\nNone.\n",
+      },
+      [
+        { path: "paper.tex", role: "body" },
+        { path: "sections/closing.tex", role: "body" },
+      ],
+    );
     expect(lint(tex, AIDC, { extra })).toEqual([]);
     // Without the file, the section is missing.
     expect(ids(lint(tex, AIDC))).toEqual(["tex/required-section:missing"]);
+    // 🔴 The file on disk and no record of the build: the paper is paper.tex, and the section is missing.
+    const unbuilt = {
+      [`${PAPER}/sections/closing.tex`]:
+        "\\section*{LLM Usage Statement}\nNone.\n",
+    };
+    expect(ids(lint(tex, AIDC, { extra: unbuilt }))).toEqual([
+      "tex/required-section:missing",
+    ]);
   });
 
   it("a leftover venue name in an included file is reported at the \\input, naming the file and line", () => {
@@ -222,9 +242,17 @@ describe("the venue rules read the whole paper: the files it \\inputs, spliced w
       "Text.\n\\input{intro}\n\\section*{LLM Usage Statement}\nNone.",
     );
     const fs = lint(tex, AIDC, {
-      extra: {
-        [`${PAPER}/intro.tex`]: "One line.\nFirst written for AgenticDev.\n",
-      },
+      extra: builtPaper(
+        PAPER,
+        {
+          "paper.tex": tex,
+          "intro.tex": "One line.\nFirst written for AgenticDev.\n",
+        },
+        [
+          { path: "paper.tex", role: "body" },
+          { path: "intro.tex", role: "body" },
+        ],
+      ),
     });
     expect(fs.map((f) => [f.line, f.message.split(": ")[0]])).toEqual([
       [5, "intro.tex:2:19"],

package/src/tex-venue-rules.ts

@@ -49,7 +49,7 @@ import type { LatexReader } from "./ports/latex.ts";
 import { paperPreset, shippedVenueNames, type Preset } from "./presets.ts";
 import type { NamedVenue } from "./domain/venue-name.ts";
 import type { PaperSource } from "./domain/paper-source.ts";
-import { readPaper, reportInPaper } from "./tex-paper.ts";
+import { readPaper, reportInPaper, type ProseDeps } from "./tex-paper.ts";
 import type { RequiredSection } from "./tex-requirements.ts";
 import type { Finding, VenueRuleDeps } from "./venue-rules.ts";
 import { isPorting } from "./domain/cycle.ts";
@@ -476,10 +476,8 @@ export function otherVenues(
     .map(({ label, aliases, mentions }) => ({ label, aliases, mentions }));
 }
 
-/** What the venue-conformance rules are built with: the preset store, and the LaTeX reader. */
-export interface TexVenueRuleDeps extends VenueRuleDeps {
-  readonly latex: LatexReader;
-}
+/** What the venue-conformance rules are built with: the preset store, the LaTeX reader, and the paper's files as the build recorded them. */
+export interface TexVenueRuleDeps extends VenueRuleDeps, ProseDeps {}
 
 /**
  * What a judge reads for the paper whose `paper.tex` is `filename` — the paper with its includes

package/src/types.ts

@@ -62,8 +62,6 @@ export interface Args {
   noHooks: boolean;
   /** `--paper <name>`: `init` creates this paper. */
   paper: string | null;
-  /** `--format tex|md` for `new` and `init --paper`. Validated by the command, not here. */
-  format: string | null;
   /** `--venue <preset>` for `new`: a shipped preset name, or a path to the project's own. */
   venue: string | null;
   /** `--kind <kind>` for `new`: one of the venue preset's kinds. */

package/dist/eslint-rules/bib-reachable-entry.d.ts

@@ -1,22 +0,0 @@
-import type { RuleContext } from "./rule-context.ts";
-declare const _default: {
-    rules: {
-        "reachable-entry": {
-            meta: {
-                type: "suggestion";
-                docs: {
-                    description: string;
-                };
-                schema: never[];
-                messages: {
-                    unreachable: string;
-                };
-            };
-            create(context: RuleContext): {
-                "root:exit"(): void;
-            };
-        };
-    };
-};
-export default _default;
-//# sourceMappingURL=bib-reachable-entry.d.ts.map

package/dist/eslint-rules/bib-reachable-entry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bib-reachable-entry.d.ts","sourceRoot":"","sources":["../../eslint-rules/bib-reachable-entry.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;;;;;;;;;;;;;;4BAsB/B,WAAW;;;;;;AAfjC,wBA4CE"}

package/dist/eslint-rules/bib-reachable-entry.js

@@ -1,75 +0,0 @@
-/**
- * `bib/reachable-entry` — a bibliography entry a reader cannot follow: no doi, no url, no arXiv
- * id. Reported ON THE ENTRY, one finding per entry; there is no fix, because the link has to be
- * looked up. Default severity: warn.
- *
- * Provenance: Reviewer A on HotCRP #20 (2026-08-23), "not every entry has a DOI/link" — one
- * paper had 0 of 47 entries reachable. Until 3.0.0 this was one count inside `paper/typography`,
- * silenced per paper by a declared debt; now each entry is its own finding, and an entry that
- * genuinely has no link (a talk, a personal communication) carries a disable directive with its
- * reason, in the bibliography itself:
- *
- *   % eslint-disable-next-line bib/reachable-entry -- an invited talk, no recording exists
- *   @misc{smith2024talk, …}
- *
- * ⚠️ NOT "no doi". Measured 2026-08-24: ICLR/NeurIPS/TMLR issue no DOIs at all, so a doi-only
- * rule would demand something that does not exist and get muted for lying. A url or an arXiv id
- * counts.
- *
- * The bibliography read is the one INSIDE `paper.tex` (`filecontents`), where the papers this
- * package targets keep it. The entry boundaries and fields are found by a line-anchored `@` and
- * a field name followed by `=` — BibTeX's own lexical shape, one lexeme at a time, not a parse:
- * the parser (`@retorquere/bibtex-parser`) is an OPTIONAL peer of this package.
- */
-import { bibRange } from "./paper-typography.js";
-/** Entry types that are not references. */
-const NOT_AN_ENTRY = /^@(comment|string|preamble)\b/i;
-const HAS_LINK = /\b(doi|url)\s*=/i;
-const HAS_ARXIV = /arxiv[:\s]*\d{4}\.\d{4,5}/i;
-export default {
-    rules: {
-        "reachable-entry": {
-            meta: {
-                type: "suggestion",
-                docs: {
-                    description: "a bibliography entry carries a doi, a url or an arXiv id — something a reader can follow",
-                },
-                schema: [],
-                messages: {
-                    unreachable: "`{{key}}` has no doi, url or arXiv id — a reader has nothing to follow. If none exists, keep the exception with `% eslint-disable-next-line bib/reachable-entry -- <why>` above the entry",
-                },
-            },
-            create(context) {
-                return {
-                    "root:exit"() {
-                        const sc = context.sourceCode;
-                        const raw = sc.raw ?? sc.text;
-                        const bib = typeof raw === "string" ? bibRange(raw) : null;
-                        if (!bib)
-                            return;
-                        const starts = [...bib.body.matchAll(/^@/gm)].map((m) => m.index);
-                        starts.forEach((s, i) => {
-                            const entry = bib.body.slice(s, starts[i + 1] ?? bib.body.length);
-                            if (NOT_AN_ENTRY.test(entry))
-                                return;
-                            if (HAS_LINK.test(entry) || HAS_ARXIV.test(entry))
-                                return;
-                            const [head = ""] = entry.split("\n");
-                            const key = /\{\s*([^,\s]+)/.exec(head)?.[1] ?? "?";
-                            const from = bib.bodyStart + s;
-                            context.report({
-                                loc: {
-                                    start: sc.getLocFromIndex(from),
-                                    end: sc.getLocFromIndex(from + head.length),
-                                },
-                                messageId: "unreachable",
-                                data: { key },
-                            });
-                        });
-                    },
-                };
-            },
-        },
-    },
-};
-//# sourceMappingURL=bib-reachable-entry.js.map

package/dist/eslint-rules/bib-reachable-entry.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bib-reachable-entry.js","sourceRoot":"","sources":["../../eslint-rules/bib-reachable-entry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAGjD,2CAA2C;AAC3C,MAAM,YAAY,GAAG,gCAAgC,CAAC;AACtD,MAAM,QAAQ,GAAG,kBAAkB,CAAC;AACpC,MAAM,SAAS,GAAG,4BAA4B,CAAC;AAE/C,eAAe;IACb,KAAK,EAAE;QACL,iBAAiB,EAAE;YACjB,IAAI,EAAE;gBACJ,IAAI,EAAE,YAAqB;gBAC3B,IAAI,EAAE;oBACJ,WAAW,EACT,0FAA0F;iBAC7F;gBACD,MAAM,EAAE,EAAE;gBACV,QAAQ,EAAE;oBACR,WAAW,EACT,2LAA2L;iBAC9L;aACF;YACD,MAAM,CAAC,OAAoB;gBACzB,OAAO;oBACL,WAAW;wBACT,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;wBAC9B,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,CAAC;wBAC9B,MAAM,GAAG,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;wBAC3D,IAAI,CAAC,GAAG;4BAAE,OAAO;wBACjB,MAAM,MAAM,GAAG,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;wBAClE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;4BACtB,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;4BAClE,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;gCAAE,OAAO;4BACrC,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;gCAAE,OAAO;4BAC1D,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;4BACtC,MAAM,GAAG,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC;4BACpD,MAAM,IAAI,GAAG,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC;4BAC/B,OAAO,CAAC,MAAM,CAAC;gCACb,GAAG,EAAE;oCACH,KAAK,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC;oCAC/B,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;iCAC5C;gCACD,SAAS,EAAE,aAAa;gCACxB,IAAI,EAAE,EAAE,GAAG,EAAE;6BACd,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;oBACL,CAAC;iBACF,CAAC;YACJ,CAAC;SACF;KACF;CACF,CAAC"}

package/eslint-rules/bib-reachable-entry.ts

@@ -1,76 +0,0 @@
-/**
- * `bib/reachable-entry` — a bibliography entry a reader cannot follow: no doi, no url, no arXiv
- * id. Reported ON THE ENTRY, one finding per entry; there is no fix, because the link has to be
- * looked up. Default severity: warn.
- *
- * Provenance: Reviewer A on HotCRP #20 (2026-08-23), "not every entry has a DOI/link" — one
- * paper had 0 of 47 entries reachable. Until 3.0.0 this was one count inside `paper/typography`,
- * silenced per paper by a declared debt; now each entry is its own finding, and an entry that
- * genuinely has no link (a talk, a personal communication) carries a disable directive with its
- * reason, in the bibliography itself:
- *
- *   % eslint-disable-next-line bib/reachable-entry -- an invited talk, no recording exists
- *   @misc{smith2024talk, …}
- *
- * ⚠️ NOT "no doi". Measured 2026-08-24: ICLR/NeurIPS/TMLR issue no DOIs at all, so a doi-only
- * rule would demand something that does not exist and get muted for lying. A url or an arXiv id
- * counts.
- *
- * The bibliography read is the one INSIDE `paper.tex` (`filecontents`), where the papers this
- * package targets keep it. The entry boundaries and fields are found by a line-anchored `@` and
- * a field name followed by `=` — BibTeX's own lexical shape, one lexeme at a time, not a parse:
- * the parser (`@retorquere/bibtex-parser`) is an OPTIONAL peer of this package.
- */
-import { bibRange } from "./paper-typography.ts";
-import type { RuleContext } from "./rule-context.ts";
-
-/** Entry types that are not references. */
-const NOT_AN_ENTRY = /^@(comment|string|preamble)\b/i;
-const HAS_LINK = /\b(doi|url)\s*=/i;
-const HAS_ARXIV = /arxiv[:\s]*\d{4}\.\d{4,5}/i;
-
-export default {
-  rules: {
-    "reachable-entry": {
-      meta: {
-        type: "suggestion" as const,
-        docs: {
-          description:
-            "a bibliography entry carries a doi, a url or an arXiv id — something a reader can follow",
-        },
-        schema: [],
-        messages: {
-          unreachable:
-            "`{{key}}` has no doi, url or arXiv id — a reader has nothing to follow. If none exists, keep the exception with `% eslint-disable-next-line bib/reachable-entry -- <why>` above the entry",
-        },
-      },
-      create(context: RuleContext) {
-        return {
-          "root:exit"() {
-            const sc = context.sourceCode;
-            const raw = sc.raw ?? sc.text;
-            const bib = typeof raw === "string" ? bibRange(raw) : null;
-            if (!bib) return;
-            const starts = [...bib.body.matchAll(/^@/gm)].map((m) => m.index);
-            starts.forEach((s, i) => {
-              const entry = bib.body.slice(s, starts[i + 1] ?? bib.body.length);
-              if (NOT_AN_ENTRY.test(entry)) return;
-              if (HAS_LINK.test(entry) || HAS_ARXIV.test(entry)) return;
-              const [head = ""] = entry.split("\n");
-              const key = /\{\s*([^,\s]+)/.exec(head)?.[1] ?? "?";
-              const from = bib.bodyStart + s;
-              context.report({
-                loc: {
-                  start: sc.getLocFromIndex(from),
-                  end: sc.getLocFromIndex(from + head.length),
-                },
-                messageId: "unreachable",
-                data: { key },
-              });
-            });
-          },
-        };
-      },
-    },
-  },
-};

package/fixtures/real-markdown-paper/baseline.json

@@ -1,22 +0,0 @@
-{
-  "$comment": [
-    "What the rules say about this article TODAY, as data rather than as a sentence in a docblock.",
-    "It is not a target and not a clean bill of health — the fixture's README says findings here",
-    "are measurements. Its job is the SILENCE half: a rule that starts reporting something new on",
-    "225 lines of real prose has almost certainly gained a false positive, and the harness beside",
-    "this file names the rule. That is not expressible on an eleven-line stub, where every line was",
-    "written by someone who already knew which rule would read it.",
-    "",
-    "Recorded 2026-09-19, re-recorded 2026-09-26 for 3.0.0. Two of the three rules are about the",
-    "scorecard being deliberately thin (no pdf, no frozen source) rather than about the prose.",
-    "paper/leading-zero reports each of the 18 p-values of paperlint#44 where it is (one finding per",
-    "occurrence since 3.0.0; before, paper/typography reported them as one count). They are real",
-    "findings against IEEE / ISO 80000-1 style, in a blog post written for a general audience.",
-    "The count is expected to stay. A drop is never a failure here, only growth is."
-  ],
-  "findings": {
-    "paper/stages": 2,
-    "paper/source": 1,
-    "paper/leading-zero": 18
-  }
-}

package/fixtures/real-markdown-paper/baseline.ts

@@ -1,70 +0,0 @@
-/**
- * ONE reader of `baseline.json`, shared by every run that compares against one: the harness beside
- * this file (the repository's own `bin/paperlint.mjs`), `test/e2e/install/install.e2e.ts` (the
- * binary a consumer actually got), and `fixtures/accepted-papers/accepted-papers.test.ts` (one
- * baseline per accepted paper). Two copies of "growth fails, a drop never does" would drift the
- * first time one of them is tightened, and the runs would then disagree about the same rules.
- */
-import { readFileSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
-import { z } from "zod";
-
-/** Findings per rule id. */
-export type Counts = Record<string, number>;
-
-const Baseline = z.object({ findings: z.record(z.string(), z.number()) });
-const LintOutput = z.array(
-  z.object({
-    messages: z.array(z.object({ ruleId: z.string().nullable() })).nullish(),
-  }),
-);
-
-const HERE = dirname(fileURLToPath(import.meta.url));
-
-/** The counts recorded in `dir`'s `baseline.json` (this article's by default), `{ruleId: n}`. */
-export function recordedFindings(dir: string = HERE): Counts {
-  return Baseline.parse(
-    JSON.parse(readFileSync(join(dir, "baseline.json"), "utf8")),
-  ).findings;
-}
-
-/**
- * `paperlint lint --json` stdout → `{ruleId: n}`.
- * 🔴 Output that does not parse THROWS. An empty set read as "clean" is how this repository's
- * checks have gone hollow before.
- */
-export function countByRule(stdout: string): Counts {
-  const out: Counts = {};
-  for (const file of LintOutput.parse(JSON.parse(stdout)))
-    for (const m of file.messages ?? []) {
-      const rule = String(m.ruleId);
-      out[rule] = (out[rule] ?? 0) + 1;
-    }
-  return out;
-}
-
-/**
- * Compare measured counts with the recording.
- *   grew     — a rule says MORE about real prose than recorded: a false positive until shown
- *              otherwise. Always a failure.
- *   vanished — a recorded rule went fully quiet without the recording being updated: how a check
- *              dies unnoticed. Also a failure.
- * A partial drop is neither: it is what a fix looks like (paperlint#44 is expected to take typography
- * to zero, and then the recording is updated in the same change).
- */
-export function compareToBaseline(
-  found: Readonly<Counts>,
-  recorded: Readonly<Counts> = recordedFindings(),
-): {
-  grew: { rule: string; now: number; recorded: number }[];
-  vanished: string[];
-} {
-  const grew = Object.entries(found)
-    .filter(([rule, n]) => n > (recorded[rule] ?? 0))
-    .map(([rule, n]) => ({ rule, now: n, recorded: recorded[rule] ?? 0 }));
-  const vanished = Object.keys(recorded).filter(
-    (r) => (recorded[r] ?? 0) > 0 && !(r in found),
-  );
-  return { grew, vanished };
-}