paperlint 3.1.2 → 3.2.0

package/dist/eslint-rules/pdf-last-page-balance.d.ts

@@ -0,0 +1,72 @@
+import type { RuleContext } from "./rule-context.ts";
+/** A reason to report, in ESLint's terms. */
+export interface Finding {
+    readonly messageId: string;
+    readonly data: Readonly<Record<string, string>>;
+}
+/** The `last_page` field, as far as this rule can judge it. */
+export type LastPage = {
+    readonly kind: "stub" | "review";
+} | {
+    readonly kind: "measured";
+    readonly left: number;
+    readonly right: number;
+};
+/** What `parseFacts` reads out of `paper.facts.json`, or why it cannot. */
+export type ParsedFacts = {
+    readonly ok: true;
+    readonly pdf: string;
+    /** Whatever the file holds there; it matched the digest pattern, and is compared as-is. */
+    readonly sha: unknown;
+    readonly last: LastPage;
+} | ({
+    readonly ok: false;
+} & Finding);
+/** The difference, in points, that two columns may end apart. See the harness for why 120. */
+export declare const DEFAULT_TOLERANCE_PT = 120;
+/** The schema of `paper.facts.json` this rule reads (`src/facts-file.ts`, FACTS_SCHEMA). */
+export declare const FACTS_SCHEMA = 2;
+export declare const FACTS_REL: string;
+/**
+ * The facts file's text → what this rule needs, or the reason it cannot be judged. Pure.
+ */
+export declare function parseFacts(text: string): ParsedFacts;
+/** The finding for a measured page, or null when it is balanced. Pure. */
+export declare function judgeColumns(last: LastPage, tolerancePt: number): Finding | null;
+declare const _default: {
+    rules: {
+        "last-page-balance": {
+            meta: {
+                type: string;
+                docs: {
+                    description: string;
+                };
+                schema: {
+                    type: string;
+                    properties: {
+                        tolerancePt: {
+                            type: string;
+                            exclusiveMinimum: number;
+                        };
+                    };
+                    additionalProperties: boolean;
+                }[];
+                messages: {
+                    unbalanced: string;
+                    noFacts: string;
+                    factsBroken: string;
+                    schema: string;
+                    pdfMissing: string;
+                    stale: string;
+                };
+            };
+            create(context: RuleContext): {
+                root?: never;
+            } | {
+                root(): void;
+            };
+        };
+    };
+};
+export default _default;
+//# sourceMappingURL=pdf-last-page-balance.d.ts.map

package/dist/eslint-rules/pdf-last-page-balance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdf-last-page-balance.d.ts","sourceRoot":"","sources":["../../eslint-rules/pdf-last-page-balance.ts"],"names":[],"mappings":"AAwCA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,6CAA6C;AAC7C,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACjD;AAED,+DAA+D;AAC/D,MAAM,MAAM,QAAQ,GAChB;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAA;CAAE,GACpC;IACE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAEN,2EAA2E;AAC3E,MAAM,MAAM,WAAW,GACnB;IACE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAClB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,2FAA2F;IAC3F,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;CACzB,GACD,CAAC;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,CAAC,CAAC;AAwBvC,8FAA8F;AAC9F,eAAO,MAAM,oBAAoB,MAAM,CAAC;AACxC,4FAA4F;AAC5F,eAAO,MAAM,YAAY,IAAI,CAAC;AAC9B,eAAO,MAAM,SAAS,QAAqC,CAAC;AAY5D;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CA+BpD;AAmBD,0EAA0E;AAC1E,wBAAgB,YAAY,CAC1B,IAAI,EAAE,QAAQ,EACd,WAAW,EAAE,MAAM,GAClB,OAAO,GAAG,IAAI,CAahB;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAqFiB,WAAW;;;;;;;;AAqB7B,wBAAwD"}

package/dist/eslint-rules/pdf-last-page-balance.js

@@ -0,0 +1,237 @@
+/**
+ * pdf/last-page-balance — the two columns of a paper's last page end at about the same height.
+ *
+ * OPTIONAL, OFF BY DEFAULT. Balance is a requirement of SOME venues, not of papers: some ACM
+ * production vendors return a camera-ready for it (Conference Publishing Consulting, which produces
+ * ICSE/ASE/SIGSOFT/SIGPLAN proceedings; Sheridan for ACM SIG conferences such as CCS), IEEEtran
+ * advises it for camera-ready work, and ACL, USENIX, AAAI and ICML say nothing. No standard format
+ * checker (HotCRP's banal, aclpubcheck, IEEE PDF eXpress) tests it. So a consumer turns it on for
+ * the papers whose venue asks, in that paper's paperlint.json:
+ *
+ *   { "rules": { "pdf/last-page-balance": ["error", { "tolerancePt": 120 }] } }
+ *
+ * (That is a line comment's worth of JSON in a block comment only because it has no asterisk
+ * followed by a slash; see rule 8 of CLAUDE.md before editing it.)
+ *
+ * ── WHAT IT READS: THE FACTS THE BUILD WROTE, NOT THE PDF ───────────────────────
+ * `paperlint build` measures the PDF with pdf.js and writes `<paper>/_build/paper.facts.json`. This rule
+ * runs on `paper.tex` — the one file every LaTeX paper has, and the one ESLint already parses — and
+ * judges that paper's facts file beside it. It never opens the PDF to measure it: it hashes it, to
+ * refuse facts about a different build than the one on disk.
+ *
+ * ── IT DOES NOT FIX, AND SAYS HOW TO ────────────────────────────────────────────
+ * paperlint used to search for a `\balance` position itself and fail the build when none worked. Every
+ * mechanism is documented as unreliable by its own authors (acmart: `balance` "may lead to
+ * problems", `pbalance` is "experimental"; pbalance: "this package is a hack"), and for ACM TAPS
+ * venues ACM recompiles the source, so an edit to a generated `.bbl` may never reach the proceedings.
+ * The message names the manual fixes the vendor itself lists, in its order.
+ *
+ * Silent, by design, where there is nothing to judge: a stub last page (a few lines) and a review
+ * build (numbered lines in the margins make both columns measure full height). Loud where the input
+ * is missing: no facts file (unless the paper extends a venue preset — then `pdf/measured` says it),
+ * a foreign schema, facts about a PDF that is not on disk or changed
+ * since — a rule that is on and reads nothing must not look like a rule that passed.
+ */
+import { createHash } from "node:crypto";
+import { existsSync, readFileSync } from "node:fs";
+import { basename, dirname, isAbsolute, join } from "node:path";
+import assert from "node:assert/strict";
+import { z } from "zod";
+import { CONFIG_FILE } from "../lib/paper-config.js";
+// The fields read, each as it is written; anything that is not a mapping has none of them.
+const FactsFields = z
+    .looseObject({
+    schema: z.unknown().optional(),
+    pdf: z.unknown().optional(),
+    pdf_sha256: z.unknown().optional(),
+    last_page: z.unknown().optional(),
+})
+    .catch({});
+const LastPageFields = z
+    .looseObject({
+    kind: z.unknown().optional(),
+    columns_pt: z.unknown().optional(),
+})
+    .catch({});
+/** Two column heights: finite numbers, exactly two of them. */
+const Columns = z.tuple([z.number(), z.number()]);
+const Settings = z.looseObject({ extends: z.unknown().optional() }).catch({});
+const RuleOptions = z
+    .object({ tolerancePt: z.number().optional() })
+    .default({});
+/** The difference, in points, that two columns may end apart. See the harness for why 120. */
+export const DEFAULT_TOLERANCE_PT = 120;
+/** The schema of `paper.facts.json` this rule reads (`src/facts-file.ts`, FACTS_SCHEMA). */
+export const FACTS_SCHEMA = 2;
+export const FACTS_REL = join("_build", "paper.facts.json");
+/** The `last_page` field, parsed. */
+function lastPageOf(v) {
+    const { kind, columns_pt } = LastPageFields.parse(v);
+    if (kind === "stub" || kind === "review")
+        return { kind };
+    const c = Columns.safeParse(columns_pt);
+    if (kind === "measured" && c.success)
+        return { kind: "measured", left: c.data[0], right: c.data[1] };
+    return null;
+}
+/**
+ * The facts file's text → what this rule needs, or the reason it cannot be judged. Pure.
+ */
+export function parseFacts(text) {
+    let raw;
+    try {
+        raw = JSON.parse(text);
+    }
+    catch (e) {
+        // `JSON.parse` throws a `SyntaxError` and nothing else.
+        assert.ok(e instanceof Error);
+        return { ok: false, messageId: "factsBroken", data: { why: e.message } };
+    }
+    const d = FactsFields.parse(raw);
+    if (d.schema !== FACTS_SCHEMA)
+        return {
+            ok: false,
+            messageId: "schema",
+            data: { got: JSON.stringify(d.schema ?? null) },
+        };
+    const last = lastPageOf(d.last_page);
+    if (typeof d.pdf !== "string" ||
+        typeof d.pdf_sha256 !== "string" ||
+        !/^[0-9a-f]{64}$/.test(d.pdf_sha256) ||
+        !last)
+        return {
+            ok: false,
+            messageId: "factsBroken",
+            data: {
+                why: "no `pdf`, `pdf_sha256` or `last_page` in the expected shape",
+            },
+        };
+    return { ok: true, pdf: d.pdf, sha: d.pdf_sha256, last };
+}
+/** Whether the facts describe the PDF on disk: null when they do, else the reason. */
+function staleness(paperDir, facts) {
+    const pdf = isAbsolute(facts.pdf) ? facts.pdf : join(paperDir, facts.pdf);
+    let got;
+    try {
+        got = createHash("sha256").update(readFileSync(pdf)).digest("hex");
+    }
+    catch {
+        return { messageId: "pdfMissing", data: { pdf: facts.pdf } };
+    }
+    return got === facts.sha
+        ? null
+        : { messageId: "stale", data: { pdf: facts.pdf } };
+}
+/** The finding for a measured page, or null when it is balanced. Pure. */
+export function judgeColumns(last, tolerancePt) {
+    if (last.kind !== "measured")
+        return null;
+    const diff = Math.abs(last.left - last.right);
+    if (diff <= tolerancePt)
+        return null;
+    return {
+        messageId: "unbalanced",
+        data: {
+            left: last.left.toFixed(1),
+            right: last.right.toFixed(1),
+            diff: diff.toFixed(1),
+            tol: String(tolerancePt),
+        },
+    };
+}
+/** Where a finding goes: the `\documentclass` line, where the class options that fix it live. */
+function reportLine(file) {
+    try {
+        const lines = readFileSync(file, "utf8").split("\n");
+        const i = lines.findIndex((l) => /^\s*\\documentclass\b/.test(l));
+        return i >= 0 ? i + 1 : 1;
+    }
+    catch {
+        return 1;
+    }
+}
+/**
+ * Whether the paper extends a venue preset. Then the venue rules run on it too, and `pdf/measured`
+ * already says — once, as a warning — that a paper with no facts was not checked; this rule
+ * repeating it as an error would fail a lint-only CI for every paper of a venue whose preset turns
+ * this rule on.
+ */
+function extendsPreset(paperDir) {
+    try {
+        const s = Settings.parse(JSON.parse(readFileSync(join(paperDir, CONFIG_FILE), "utf8")));
+        return typeof s.extends === "string" && s.extends !== "";
+    }
+    catch {
+        return false;
+    }
+}
+/** Everything the rule decides for one paper, as a finding or null. */
+function verdict(paperDir, tolerancePt) {
+    const factsFile = join(paperDir, FACTS_REL);
+    if (!existsSync(factsFile))
+        return extendsPreset(paperDir)
+            ? null
+            : { messageId: "noFacts", data: { file: FACTS_REL } };
+    const facts = parseFacts(readFileSync(factsFile, "utf8"));
+    if (!facts.ok)
+        return { messageId: facts.messageId, data: facts.data };
+    return staleness(paperDir, facts) ?? judgeColumns(facts.last, tolerancePt);
+}
+const rule = {
+    meta: {
+        type: "problem",
+        docs: {
+            description: "the last page's two columns end at about the same height (optional; for venues that require it)",
+        },
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    tolerancePt: { type: "number", exclusiveMinimum: 0 },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            unbalanced: "the last page is unbalanced: its columns end at {{left}} and {{right}} pt, {{diff}} pt " +
+                "apart (tolerance {{tol}} pt). Some ACM production vendors send such a camera-ready back. " +
+                "Conference Publishing Consulting's advice, in its order: \"For the ACMART style, use " +
+                "option 'balance' or, if this does not work, option 'pbalance'\" — acmart already has " +
+                "`balance` on by default, and it calls \\balance from the second column, where it does " +
+                "nothing when the last page is all bibliography, so try `pbalance`; then " +
+                "`\\usepackage{flushend}`; then `\\balance` (balance.sty) placed in what would be the " +
+                "FIRST column of the last page — in the bibliography, before the \\bibitem that starts " +
+                "that column. Rebuild (`paperlint build`) and lint again.",
+            noFacts: "pdf/last-page-balance is on for this paper, but {{file}} does not exist beside it. The rule " +
+                "judges the facts `paperlint build` writes after a successful compile — build the paper first.",
+            factsBroken: "{{why}} in _build/paper.facts.json — rebuild the paper (`paperlint build`) to rewrite it",
+            schema: "_build/paper.facts.json has schema {{got}}; this rule reads schema 2 — rebuild the paper " +
+                "(`paperlint build`) to rewrite it",
+            pdfMissing: "_build/paper.facts.json describes {{pdf}}, which is not on disk (a failed build removes " +
+                "it) — rebuild the paper",
+            stale: "_build/paper.facts.json describes a DIFFERENT {{pdf}} than the one on disk (its SHA-256 " +
+                "differs), so judging it would judge an earlier build — rebuild the paper",
+        },
+    },
+    create(context) {
+        // Judged once per paper, on its paper.tex: the paper directory is the file's directory.
+        if (basename(context.filename) !== "paper.tex")
+            return {};
+        const { tolerancePt = DEFAULT_TOLERANCE_PT } = RuleOptions.parse(context.options[0]);
+        return {
+            root() {
+                const v = verdict(dirname(context.filename), tolerancePt);
+                if (!v)
+                    return;
+                const line = reportLine(context.filename);
+                context.report({
+                    loc: { start: { line, column: 1 }, end: { line, column: 2 } },
+                    messageId: v.messageId,
+                    data: v.data,
+                });
+            },
+        };
+    },
+};
+export default { rules: { "last-page-balance": rule } };
+//# sourceMappingURL=pdf-last-page-balance.js.map

package/dist/eslint-rules/pdf-last-page-balance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdf-last-page-balance.js","sourceRoot":"","sources":["../../eslint-rules/pdf-last-page-balance.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAChE,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AA6BrD,2FAA2F;AAC3F,MAAM,WAAW,GAAG,CAAC;KAClB,WAAW,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC3B,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAClC,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC;KACD,KAAK,CAAC,EAAE,CAAC,CAAC;AACb,MAAM,cAAc,GAAG,CAAC;KACrB,WAAW,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5B,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC;KACD,KAAK,CAAC,EAAE,CAAC,CAAC;AACb,+DAA+D;AAC/D,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAClD,MAAM,QAAQ,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC9E,MAAM,WAAW,GAAG,CAAC;KAClB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC;KAC9C,OAAO,CAAC,EAAE,CAAC,CAAC;AAEf,8FAA8F;AAC9F,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACxC,4FAA4F;AAC5F,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC;AAC9B,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;AAE5D,qCAAqC;AACrC,SAAS,UAAU,CAAC,CAAU;IAC5B,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACrD,IAAI,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,QAAQ;QAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC1D,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACxC,IAAI,IAAI,KAAK,UAAU,IAAI,CAAC,CAAC,OAAO;QAClC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,IAAY;IACrC,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,wDAAwD;QACxD,MAAM,CAAC,EAAE,CAAC,CAAC,YAAY,KAAK,CAAC,CAAC;QAC9B,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;IAC3E,CAAC;IACD,MAAM,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,CAAC,CAAC,MAAM,KAAK,YAAY;QAC3B,OAAO;YACL,EAAE,EAAE,KAAK;YACT,SAAS,EAAE,QAAQ;YACnB,IAAI,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE;SAChD,CAAC;IACJ,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACrC,IACE,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ;QACzB,OAAO,CAAC,CAAC,UAAU,KAAK,QAAQ;QAChC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;QACpC,CAAC,IAAI;QAEL,OAAO;YACL,EAAE,EAAE,KAAK;YACT,SAAS,EAAE,aAAa;YACxB,IAAI,EAAE;gBACJ,GAAG,EAAE,6DAA6D;aACnE;SACF,CAAC;IACJ,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;AAC3D,CAAC;AAED,sFAAsF;AACtF,SAAS,SAAS,CAChB,QAAgB,EAChB,KAAsD;IAEtD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1E,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QACH,GAAG,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACrE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC;IAC/D,CAAC;IACD,OAAO,GAAG,KAAK,KAAK,CAAC,GAAG;QACtB,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC;AACvD,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,YAAY,CAC1B,IAAc,EACd,WAAmB;IAEnB,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU;QAAE,OAAO,IAAI,CAAC;IAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9C,IAAI,IAAI,IAAI,WAAW;QAAE,OAAO,IAAI,CAAC;IACrC,OAAO;QACL,SAAS,EAAE,YAAY;QACvB,IAAI,EAAE;YACJ,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;YAC1B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAC5B,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;YACrB,GAAG,EAAE,MAAM,CAAC,WAAW,CAAC;SACzB;KACF,CAAC;AACJ,CAAC;AAED,iGAAiG;AACjG,SAAS,UAAU,CAAC,IAAY;IAC9B,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrD,MAAM,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAClE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,CAAC;IACX,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CAAC,QAAgB;IACrC,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CACtB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC,CAC9D,CAAC;QACF,OAAO,OAAO,CAAC,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,OAAO,KAAK,EAAE,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,uEAAuE;AACvE,SAAS,OAAO,CAAC,QAAgB,EAAE,WAAmB;IACpD,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC5C,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QACxB,OAAO,aAAa,CAAC,QAAQ,CAAC;YAC5B,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC;IAC1D,MAAM,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1D,IAAI,CAAC,KAAK,CAAC,EAAE;QAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;IACvE,OAAO,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,IAAI,GAAG;IACX,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,iGAAiG;SACpG;QACD,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,EAAE;iBACrD;gBACD,oBAAoB,EAAE,KAAK;aAC5B;SACF;QACD,QAAQ,EAAE;YACR,UAAU,EACR,yFAAyF;gBACzF,2FAA2F;gBAC3F,uFAAuF;gBACvF,uFAAuF;gBACvF,wFAAwF;gBACxF,0EAA0E;gBAC1E,uFAAuF;gBACvF,wFAAwF;gBACxF,0DAA0D;YAC5D,OAAO,EACL,8FAA8F;gBAC9F,+FAA+F;YACjG,WAAW,EACT,0FAA0F;YAC5F,MAAM,EACJ,2FAA2F;gBAC3F,mCAAmC;YACrC,UAAU,EACR,0FAA0F;gBAC1F,yBAAyB;YAC3B,KAAK,EACH,0FAA0F;gBAC1F,0EAA0E;SAC7E;KACF;IACD,MAAM,CAAC,OAAoB;QACzB,wFAAwF;QACxF,IAAI,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,WAAW;YAAE,OAAO,EAAE,CAAC;QAC1D,MAAM,EAAE,WAAW,GAAG,oBAAoB,EAAE,GAAG,WAAW,CAAC,KAAK,CAC9D,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CACnB,CAAC;QACF,OAAO;YACL,IAAI;gBACF,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,CAAC;gBAC1D,IAAI,CAAC,CAAC;oBAAE,OAAO;gBACf,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAC1C,OAAO,CAAC,MAAM,CAAC;oBACb,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE;oBAC7D,SAAS,EAAE,CAAC,CAAC,SAAS;oBACtB,IAAI,EAAE,CAAC,CAAC,IAAI;iBACb,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,eAAe,EAAE,KAAK,EAAE,EAAE,mBAAmB,EAAE,IAAI,EAAE,EAAE,CAAC"}

package/dist/eslint-rules/review-frontmatter.d.ts

@@ -0,0 +1,57 @@
+import type { ErrorObject } from "ajv";
+import type { RuleContext } from "./rule-context.ts";
+/** A compiled schema, as far as `errorsOf` uses one. Ajv's `ValidateFunction` is one. */
+export interface Validate {
+    (data: unknown): unknown;
+    readonly errors?: readonly ErrorObject[] | null;
+}
+/** The schema's verdict on `data` as messages. Ajv types `errors` as possibly null; that is tolerated. */
+export declare const errorsOf: (validate: Validate, data: unknown) => string[];
+/**
+ * A rule that validates a markdown file's YAML frontmatter against the JSON Schema in `schemaUrl`
+ * (a file shipped beside the rule). A file with no frontmatter is validated as `{}`.
+ */
+export declare function frontmatterRule(schemaUrl: URL | string, description: string): {
+    meta: {
+        type: string;
+        docs: {
+            description: string;
+        };
+        schema: never[];
+        messages: {
+            malformed: string;
+            invalid: string;
+        };
+    };
+    create(context: RuleContext): {
+        yaml(node: {
+            readonly value?: string;
+        }): void;
+        "root:exit"(root: object): void;
+    };
+};
+declare const _default: {
+    rules: {
+        frontmatter: {
+            meta: {
+                type: string;
+                docs: {
+                    description: string;
+                };
+                schema: never[];
+                messages: {
+                    malformed: string;
+                    invalid: string;
+                };
+            };
+            create(context: RuleContext): {
+                yaml(node: {
+                    readonly value?: string;
+                }): void;
+                "root:exit"(root: object): void;
+            };
+        };
+    };
+};
+export default _default;
+//# sourceMappingURL=review-frontmatter.d.ts.map

package/dist/eslint-rules/review-frontmatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"review-frontmatter.d.ts","sourceRoot":"","sources":["../../eslint-rules/review-frontmatter.ts"],"names":[],"mappings":"AAwCA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,KAAK,CAAC;AAKvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,yFAAyF;AACzF,MAAM,WAAW,QAAQ;IACvB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,WAAW,EAAE,GAAG,IAAI,CAAC;CACjD;AAyBD,0GAA0G;AAC1G,eAAO,MAAM,QAAQ,GAAI,UAAU,QAAQ,EAAE,MAAM,OAAO,KAAG,MAAM,EAGU,CAAC;AAE9E;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,MAAM,EAAE,WAAW,EAAE,MAAM;;;;;;;;;;;;oBAexD,WAAW;mBAIZ;YAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE;0BAcpB,MAAM;;EAY/B;;;;;;;;;;;;;;;4BA9BmB,WAAW;2BAIZ;oBAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;iBAAE;kCAcpB,MAAM;;;;;AAchC,wBAOE"}

package/dist/eslint-rules/review-frontmatter.js

@@ -0,0 +1,126 @@
+/**
+ * `review/frontmatter` — a review report's frontmatter is a RECORD, validated by a JSON Schema.
+ *
+ * ── WHAT IT CHECKS ───────────────────────────────────────────────────────────────
+ * A review under `reviews/` declares what it found in its YAML frontmatter:
+ *
+ *   findings:
+ *     - id: 1
+ *       status: open            # open | fixed | wontfix
+ *       cause: missing-skill    # skill-defect | missing-skill | hook | rule — required when open
+ *
+ * The pipeline convention behind it: a review does not end with a list of findings, it ends with
+ * what in the PIPELINE let each one through. Otherwise the text gets fixed while the tool that
+ * missed it stays the same. The schema is `review-frontmatter.schema.json` beside this file, and
+ * "an open finding names its cause" is its `if`/`then`, not code here.
+ *
+ * The same mechanism, with a schema of its own, is `sibling/frontmatter`
+ * (`sibling-frontmatter.mjs`): `frontmatterRule` below is the one implementation.
+ *
+ * ── WHY THIS REPLACED TWO RULES IN 3.0.0 ────────────────────────────────────────────
+ * `review/findings-cause` GUESSED the findings from the prose: it counted numbered table rows and
+ * list items starting in bold, looked for a magic word (`causeMarker`, "Cause:") anywhere in the
+ * text, spoke only above a threshold (`minFindings`), and skipped reports older than a date
+ * (`sinceCreated`) — a date ratchet its own header said belonged in `ignores`. Every one of
+ * those was a convention in prose standing in for a field nobody had declared.
+ * `doc/fields` was a hand-rolled schema language in the config (`{ field: { values: [...] } }`),
+ * and its one real use was the `read:` field of sibling cards — which this package's own
+ * `analyze-sibling-paper` skill writes, so the package now ships that schema too. The record is
+ * data, the schema is JSON Schema, the validator is ajv.
+ *
+ * A review with no `findings` key is not a findings record and is not checked for findings — so
+ * there is no date to compare: old reports simply have no records. A file with no frontmatter is
+ * validated as `{}`, so a field a schema requires is still reported on it: a missing header must
+ * not be a way around the check.
+ *
+ * YAML is read with js-yaml's CORE schema, which leaves `2026-09-20` a string. The default schema
+ * turns it into a Date, and a schema asking for `"type": "string"` would then reject a date the
+ * author wrote correctly.
+ */
+import Ajv from "ajv";
+import { CORE_SCHEMA, load } from "js-yaml";
+import assert from "node:assert/strict";
+import { readFileSync } from "node:fs";
+import { z } from "zod";
+/**
+ * What a parser failure says about itself. js-yaml's `YAMLException` carries a `reason`; anything
+ * else thrown may carry a `message`, or be a bare value that says nothing.
+ */
+const Thrown = z
+    .object({
+    reason: z.string().optional().catch(undefined),
+    message: z.string().optional().catch(undefined),
+})
+    .catch({});
+/** One ajv error as a line a person can act on. `if` errors only repeat their `then`. */
+function describe(e) {
+    const where = e.dataPath
+        ? `\`${e.dataPath.replace(/^\./, "")}\``
+        : "the frontmatter";
+    if (e.keyword === "enum" && "allowedValues" in e.params)
+        return `${where} must be one of: ${e.params.allowedValues.join(", ")}`;
+    if (e.keyword === "additionalProperties" && "additionalProperty" in e.params)
+        return `${where} has an unknown field \`${e.params.additionalProperty}\``;
+    return `${where} ${String(e.message)}`;
+}
+/** The schema's verdict on `data` as messages. Ajv types `errors` as possibly null; that is tolerated. */
+export const errorsOf = (validate, data) => validate(data)
+    ? []
+    : (validate.errors ?? []).filter((e) => e.keyword !== "if").map(describe);
+/**
+ * A rule that validates a markdown file's YAML frontmatter against the JSON Schema in `schemaUrl`
+ * (a file shipped beside the rule). A file with no frontmatter is validated as `{}`.
+ */
+export function frontmatterRule(schemaUrl, description) {
+    const schema = JSON.parse(readFileSync(schemaUrl, "utf8"));
+    assert.ok(typeof schema === "object" && schema !== null, "not a schema");
+    const validate = new Ajv({ allErrors: true }).compile(schema);
+    return {
+        meta: {
+            type: "problem",
+            docs: { description },
+            schema: [],
+            messages: {
+                malformed: "the frontmatter does not parse as YAML ({{why}}) — there is no record to read",
+                invalid: "{{problem}}",
+            },
+        },
+        create(context) {
+            let frontmatter = null;
+            let data = {};
+            return {
+                yaml(node) {
+                    frontmatter = node;
+                    try {
+                        data = load(node.value ?? "", { schema: CORE_SCHEMA }) ?? {};
+                    }
+                    catch (e) {
+                        data = null;
+                        const { reason, message } = Thrown.parse(e);
+                        context.report({
+                            node,
+                            messageId: "malformed",
+                            data: { why: reason ?? message ?? "unparseable" },
+                        });
+                    }
+                },
+                "root:exit"(root) {
+                    if (data === null)
+                        return;
+                    for (const problem of errorsOf(validate, data))
+                        context.report({
+                            node: frontmatter ?? root,
+                            messageId: "invalid",
+                            data: { problem },
+                        });
+                },
+            };
+        },
+    };
+}
+export default {
+    rules: {
+        frontmatter: frontmatterRule(new URL("./review-frontmatter.schema.json", import.meta.url), "a review's frontmatter is a record: its findings, each with a status and, when open, the pipeline cause — validated by JSON Schema"),
+    },
+};
+//# sourceMappingURL=review-frontmatter.js.map

package/dist/eslint-rules/review-frontmatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"review-frontmatter.js","sourceRoot":"","sources":["../../eslint-rules/review-frontmatter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AASxB;;;GAGG;AACH,MAAM,MAAM,GAAG,CAAC;KACb,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;IAC9C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;CAChD,CAAC;KACD,KAAK,CAAC,EAAE,CAAC,CAAC;AAEb,yFAAyF;AACzF,SAAS,QAAQ,CAAC,CAAc;IAC9B,MAAM,KAAK,GAAG,CAAC,CAAC,QAAQ;QACtB,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI;QACxC,CAAC,CAAC,iBAAiB,CAAC;IACtB,IAAI,CAAC,CAAC,OAAO,KAAK,MAAM,IAAI,eAAe,IAAI,CAAC,CAAC,MAAM;QACrD,OAAO,GAAG,KAAK,oBAAoB,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IACzE,IAAI,CAAC,CAAC,OAAO,KAAK,sBAAsB,IAAI,oBAAoB,IAAI,CAAC,CAAC,MAAM;QAC1E,OAAO,GAAG,KAAK,2BAA2B,CAAC,CAAC,MAAM,CAAC,kBAAkB,IAAI,CAAC;IAC5E,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;AACzC,CAAC;AAED,0GAA0G;AAC1G,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,QAAkB,EAAE,IAAa,EAAY,EAAE,CACtE,QAAQ,CAAC,IAAI,CAAC;IACZ,CAAC,CAAC,EAAE;IACJ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAE9E;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,SAAuB,EAAE,WAAmB;IAC1E,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IACpE,MAAM,CAAC,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,cAAc,CAAC,CAAC;IACzE,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9D,OAAO;QACL,IAAI,EAAE;YACJ,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,EAAE,WAAW,EAAE;YACrB,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE;gBACR,SAAS,EACP,+EAA+E;gBACjF,OAAO,EAAE,aAAa;aACvB;SACF;QACD,MAAM,CAAC,OAAoB;YACzB,IAAI,WAAW,GAAkB,IAAI,CAAC;YACtC,IAAI,IAAI,GAAY,EAAE,CAAC;YACvB,OAAO;gBACL,IAAI,CAAC,IAAiC;oBACpC,WAAW,GAAG,IAAI,CAAC;oBACnB,IAAI,CAAC;wBACH,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;oBAC/D,CAAC;oBAAC,OAAO,CAAC,EAAE,CAAC;wBACX,IAAI,GAAG,IAAI,CAAC;wBACZ,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;wBAC5C,OAAO,CAAC,MAAM,CAAC;4BACb,IAAI;4BACJ,SAAS,EAAE,WAAW;4BACtB,IAAI,EAAE,EAAE,GAAG,EAAE,MAAM,IAAI,OAAO,IAAI,aAAa,EAAE;yBAClD,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;gBACD,WAAW,CAAC,IAAY;oBACtB,IAAI,IAAI,KAAK,IAAI;wBAAE,OAAO;oBAC1B,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;wBAC5C,OAAO,CAAC,MAAM,CAAC;4BACb,IAAI,EAAE,WAAW,IAAI,IAAI;4BACzB,SAAS,EAAE,SAAS;4BACpB,IAAI,EAAE,EAAE,OAAO,EAAE;yBAClB,CAAC,CAAC;gBACP,CAAC;aACF,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,eAAe;IACb,KAAK,EAAE;QACL,WAAW,EAAE,eAAe,CAC1B,IAAI,GAAG,CAAC,kCAAkC,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAC5D,oIAAoI,CACrI;KACF;CACF,CAAC"}

package/dist/eslint-rules/review-frontmatter.schema.json

@@ -0,0 +1,36 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "urn:paperlint:review-frontmatter",
+    "title": "paperlint review frontmatter",
+    "description": "The YAML frontmatter of a review report under reviews/. A review with no `findings` key is not a findings record and is not checked for findings.",
+    "type": "object",
+    "properties": {
+        "findings": {
+            "description": "What the review found, one record per finding.",
+            "type": "array",
+            "items": { "$ref": "#/definitions/finding" }
+        }
+    },
+    "definitions": {
+        "finding": {
+            "type": "object",
+            "required": ["id", "status"],
+            "properties": {
+                "id": {
+                    "description": "How the review body refers to this finding.",
+                    "type": ["integer", "string"]
+                },
+                "status": { "enum": ["open", "fixed", "wontfix"] },
+                "cause": {
+                    "description": "What in the PIPELINE let this through: a defective skill, a missing skill, a hook, or a rule. Fix that, and the text edit falls out of running the fixed tool.",
+                    "enum": ["skill-defect", "missing-skill", "hook", "rule"]
+                },
+                "title": { "type": "string" },
+                "note": { "type": "string" }
+            },
+            "additionalProperties": false,
+            "if": { "properties": { "status": { "const": "open" } } },
+            "then": { "required": ["cause"] }
+        }
+    }
+}

package/dist/eslint-rules/rule-context.d.ts

@@ -0,0 +1,55 @@
+/**
+ * The slice of ESLint's rule API the rules in this directory use.
+ *
+ * These rules run on three languages (JavaScript, markdown and the `.tex` language next door),
+ * and ESLint's own `Rule.RuleContext` is the JavaScript one. So the rules are typed against what
+ * they actually touch, the way `src/venue-rules.ts` and `src/reference-rules.ts` already are.
+ */
+/** A line and a 1-based column, as ESLint reports them. */
+export interface Loc {
+    readonly line: number;
+    readonly column: number;
+}
+import type { Root } from "mdast";
+/** The source code a rule reads. `raw` exists on the `.tex` language's source code only. */
+export interface RuleSourceCode {
+    readonly text: string;
+    readonly raw?: string;
+    /** mdast: the markdown language's tree, or the `.tex` language's projection of one. */
+    readonly ast?: Root;
+    getLocFromIndex(index: number): Loc;
+    getText(node?: object): string;
+}
+/** What a fix produces: replace `range` of the file with `text`. */
+export interface RuleFix {
+    readonly range: readonly [number, number];
+    readonly text: string;
+}
+export interface RuleFixer {
+    replaceTextRange(range: readonly [number, number], text: string): RuleFix;
+    insertTextBeforeRange(range: readonly [number, number], text: string): RuleFix;
+}
+export interface RuleSuggestion {
+    readonly messageId: string;
+    readonly data?: Readonly<Record<string, string | number>>;
+    fix(fixer: RuleFixer): RuleFix;
+}
+export interface RuleReport {
+    readonly node?: object;
+    readonly loc?: {
+        readonly start: Loc;
+        readonly end: Loc;
+    };
+    readonly messageId: string;
+    readonly data?: Readonly<Record<string, string | number>>;
+    readonly fix?: (fixer: RuleFixer) => RuleFix;
+    readonly suggest?: readonly RuleSuggestion[];
+}
+export interface RuleContext {
+    readonly filename: string;
+    readonly options: readonly unknown[];
+    readonly settings: Readonly<Record<string, unknown>>;
+    readonly sourceCode: RuleSourceCode;
+    report(descriptor: RuleReport): void;
+}
+//# sourceMappingURL=rule-context.d.ts.map

package/dist/eslint-rules/rule-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-context.d.ts","sourceRoot":"","sources":["../../eslint-rules/rule-context.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,2DAA2D;AAC3D,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAElC,4FAA4F;AAC5F,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,uFAAuF;IACvF,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;IACpB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;IACpC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAChC;AAED,oEAAoE;AACpE,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,SAAS;IACxB,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAC1E,qBAAqB,CACnB,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,EAChC,IAAI,EAAE,MAAM,GACX,OAAO,CAAC;CACZ;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;IAC1D,GAAG,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC;QAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;KAAE,CAAC;IAC1D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;IAC1D,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,OAAO,CAAC;IAC7C,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,SAAS,OAAO,EAAE,CAAC;IACrC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACrD,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;IACpC,MAAM,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;CACtC"}

package/dist/eslint-rules/rule-context.js

@@ -0,0 +1,9 @@
+/**
+ * The slice of ESLint's rule API the rules in this directory use.
+ *
+ * These rules run on three languages (JavaScript, markdown and the `.tex` language next door),
+ * and ESLint's own `Rule.RuleContext` is the JavaScript one. So the rules are typed against what
+ * they actually touch, the way `src/venue-rules.ts` and `src/reference-rules.ts` already are.
+ */
+export {};
+//# sourceMappingURL=rule-context.js.map

package/dist/eslint-rules/rule-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule-context.js","sourceRoot":"","sources":["../../eslint-rules/rule-context.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}