paperlint 12.0.0 → 13.0.0

package/dist/eslint-rules/cycle-stage.js

@@ -1,119 +0,0 @@
-/**
- * `cycle/stage` — a declared stage names the ATTEMPT it belongs to, and that attempt exists.
- *
- * With `cycles` in the paper's `paperlint.json`, a `stages` entry in the scorecard's frontmatter
- * says `cycle: <id>` instead of a free `venue:` string: the venue's name is then the cycle's
- * preset's, spelled once, and a consumer can tell which rows of the scorecard belong to which
- * attempt. Three things can be wrong, each an error:
- *
- *   noCycle        `cycles` is declared and a stage names no `cycle`
- *   unknownCycle   the stage's `cycle` is no declared cycle's id
- *   porting        a `submitted` or `camera-ready` stage in a cycle whose phase is still `porting` —
- *                  a PDF was sent while the record says the source is in the previous venue's template
- *
- * Without `cycles` (the flat form) the rule is silent: `venue:` stays what it was. The settings file
- * is read here only for the cycles' ids and phases; `cycle/record` (src/cycle-rules.ts) judges the
- * whole record.
- */
-import { existsSync, readFileSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { load } from "js-yaml";
-import { z } from "zod";
-const SETTINGS_FILE = "paperlint.json";
-/** What this rule reads of a cycle: its id and phase. `cycle/record` parses the rest. */
-const CycleHead = z.looseObject({
-    id: z.string(),
-    phase: z.string().optional(),
-});
-const Settings = z.looseObject({
-    cycles: z.array(CycleHead.catch({ id: "" })).optional(),
-});
-const Frontmatter = z.looseObject({ stages: z.unknown().optional() }).catch({});
-const Stage = z
-    .looseObject({
-    stage: z.unknown().optional(),
-    cycle: z.unknown().optional(),
-    date: z.unknown().optional(),
-})
-    .catch({});
-/** The stages that send a PDF to the venue: a cycle still porting cannot have one. */
-const SENT = ["submitted", "camera-ready"];
-/** The declared cycles' heads, or null when the paper has no `cycles` (or no readable settings). */
-function cyclesOf(dir) {
-    const file = join(dir, SETTINGS_FILE);
-    if (!existsSync(file))
-        return null;
-    try {
-        const s = Settings.safeParse(JSON.parse(readFileSync(file, "utf8")));
-        return s.success && s.data.cycles !== undefined
-            ? s.data.cycles.map((c) => ({ id: c.id, phase: c.phase ?? "prepared" }))
-            : null;
-    }
-    catch {
-        return null;
-    }
-}
-const text = (v) => typeof v === "string" ? v : v === undefined ? "" : JSON.stringify(v);
-/** A YAML date without quotes is a `Date`; shown as the day it names, as `paper/stages` does. */
-const dateText = (v) => v instanceof Date ? v.toISOString().slice(0, 10) : text(v);
-/** Each stage against the declared cycles. Pure. */
-export function judgeStages(stages, cycles) {
-    const known = cycles.map((c) => c.id).join(" · ") || "(none)";
-    return stages.flatMap((entry) => {
-        const s = Stage.parse(entry);
-        const stage = text(s.stage);
-        const date = dateText(s.date);
-        if (s.cycle === undefined)
-            return [{ messageId: "noCycle", data: { stage, date, known } }];
-        const id = text(s.cycle);
-        const cycle = cycles.find((c) => c.id === id);
-        if (cycle === undefined)
-            return [{ messageId: "unknownCycle", data: { stage, date, id, known } }];
-        return SENT.includes(stage) && cycle.phase === "porting"
-            ? [{ messageId: "porting", data: { stage, date, id } }]
-            : [];
-    });
-}
-export default {
-    rules: {
-        stage: {
-            meta: {
-                type: "problem",
-                docs: {
-                    description: "with `cycles` declared, every stage names the cycle it belongs to, and no PDF is sent from a cycle still porting",
-                    url: "https://github.com/zernie/paperlint/blob/main/docs/rules/cycle/stage.md",
-                },
-                schema: [],
-                messages: {
-                    noCycle: "the «{{stage}}» stage ({{date}}) names no `cycle` — this paper declares `cycles` in paperlint.json, so each stage says which attempt it belongs to: `cycle: <id>`, one of {{known}}",
-                    unknownCycle: "the «{{stage}}» stage ({{date}}) names the cycle «{{id}}», which paperlint.json does not declare — the declared ids: {{known}}",
-                    porting: "the «{{stage}}» stage ({{date}}) belongs to the cycle «{{id}}», whose phase is still `porting`: a PDF was sent while the record says the source is in the previous venue's template. Finish the port and drop the phase, or the stage is wrong",
-                },
-            },
-            create(context) {
-                const cycles = cyclesOf(dirname(context.filename));
-                if (cycles === null)
-                    return {};
-                return {
-                    yaml(node) {
-                        const data = (() => {
-                            try {
-                                return load(node.value);
-                            }
-                            catch {
-                                return undefined; // `paper/stages` reports the unreadable YAML
-                            }
-                        })();
-                        const stages = Frontmatter.parse(data).stages;
-                        if (!Array.isArray(stages))
-                            return;
-                        judgeStages(stages, cycles).forEach((f) => {
-                            context.report({ node, messageId: f.messageId, data: f.data });
-                        });
-                    },
-                };
-            },
-        },
-    },
-};
-//# sourceMappingURL=cycle-stage.js.map

package/dist/eslint-rules/cycle-stage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cycle-stage.js","sourceRoot":"","sources":["../../eslint-rules/cycle-stage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,aAAa,GAAG,gBAAgB,CAAC;AAEvC,yFAAyF;AACzF,MAAM,SAAS,GAAG,CAAC,CAAC,WAAW,CAAC;IAC9B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC;AACH,MAAM,QAAQ,GAAG,CAAC,CAAC,WAAW,CAAC;IAC7B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACxD,CAAC,CAAC;AACH,MAAM,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAChF,MAAM,KAAK,GAAG,CAAC;KACZ,WAAW,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7B,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC;KACD,KAAK,CAAC,EAAE,CAAC,CAAC;AAEb,sFAAsF;AACtF,MAAM,IAAI,GAAsB,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;AAO9D,oGAAoG;AACpG,SAAS,QAAQ,CAAC,GAAW;IAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IACtC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACnC,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACrE,OAAO,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS;YAC7C,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,IAAI,UAAU,EAAE,CAAC,CAAC;YACxE,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,IAAI,GAAG,CAAC,CAAU,EAAU,EAAE,CAClC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAEvE,iGAAiG;AACjG,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAU,EAAE,CACtC,CAAC,YAAY,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAO7D,oDAAoD;AACpD,MAAM,UAAU,WAAW,CACzB,MAA0B,EAC1B,MAAuB;IAEvB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC;IAC9D,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAsB,EAAE;QAClD,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC5B,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS;YACvB,OAAO,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAClE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAC9C,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;YACtD,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC;YACvD,CAAC,CAAC,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;AACL,CAAC;AAED,eAAe;IACb,KAAK,EAAE;QACL,KAAK,EAAE;YACL,IAAI,EAAE;gBACJ,IAAI,EAAE,SAAkB;gBACxB,IAAI,EAAE;oBACJ,WAAW,EACT,kHAAkH;oBACpH,GAAG,EAAE,yEAAyE;iBAC/E;gBACD,MAAM,EAAE,EAAE;gBACV,QAAQ,EAAE;oBACR,OAAO,EACL,qLAAqL;oBACvL,YAAY,EACV,gIAAgI;oBAClI,OAAO,EACL,gPAAgP;iBACnP;aACF;YACD,MAAM,CAAC,OAAoB;gBACzB,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACnD,IAAI,MAAM,KAAK,IAAI;oBAAE,OAAO,EAAE,CAAC;gBAC/B,OAAO;oBACL,IAAI,CAAC,IAAgC;wBACnC,MAAM,IAAI,GAAG,CAAC,GAAY,EAAE;4BAC1B,IAAI,CAAC;gCACH,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;4BAC1B,CAAC;4BAAC,MAAM,CAAC;gCACP,OAAO,SAAS,CAAC,CAAC,6CAA6C;4BACjE,CAAC;wBACH,CAAC,CAAC,EAAE,CAAC;wBACL,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;wBAC9C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;4BAAE,OAAO;wBACnC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;4BACxC,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;wBACjE,CAAC,CAAC,CAAC;oBACL,CAAC;iBACF,CAAC;YACJ,CAAC;SACF;KACF;CACF,CAAC"}

package/docs/rules/cycle/stage.md

@@ -1,85 +0,0 @@
-# cycle/stage
-
-**Level:** error · **Reads:** the paper's `PIPELINE-STATUS.md` frontmatter (`stages`) and its
-`paperlint.json` (`cycles`) · **Reported on:** the frontmatter of `PIPELINE-STATUS.md`
-
-## What it catches
-
-With `cycles` declared in the paper's `paperlint.json`, a `stages` entry in the scorecard's
-frontmatter must say which attempt it belongs to, `cycle: <id>`, and that attempt must exist. Three
-things can be wrong:
-
-- a stage names no `cycle`;
-- a stage names a `cycle` no declared cycle has as its `id`;
-- a `submitted` or `camera-ready` stage belongs to a cycle whose `phase` is still `porting` — a PDF
-  was sent to the venue while the record says the source is still in the previous venue's template.
-
-Without `cycles` (the flat form) the rule is silent and `venue:` stays what it was.
-
-## Why
-
-A paper's attempts are recorded once, in `paperlint.json`; the scorecard's stages are the evidence
-— which PDF, how many bytes, when. A stage that names its cycle says which attempt the evidence
-belongs to, and the venue's name is then spelled once, in the preset, instead of as a free string
-retyped per stage (`REALM @ EMNLP 2026`, `AISec 2026 @ ACM CCS`, …). A stage whose cycle does not
-exist is evidence of nothing.
-
-The `porting` case is the other half of a declaration: `"phase": "porting"` silences the venue's
-format rules because the source is, by declaration, not yet in the venue's template. A PDF sent
-from such a cycle contradicts that declaration — either the port is done and the phase is stale, or
-the stage is wrong.
-
-## Examples
-
-Failing — `paperlint.json` declares one cycle, `open-2027`, and `PIPELINE-STATUS.md` has
-
-```yaml
----
-stages:
-  - stage: submitted
-    date: 2026-07-22
-    pdf: versions/a.pdf
-    bytes: 1
----
-```
-
-```text
-papers/my-paper/PIPELINE-STATUS.md
-  1:1  error  the «submitted» stage (2026-07-22) names no `cycle` — this paper declares `cycles` in
-              paperlint.json, so each stage says which attempt it belongs to: `cycle: <id>`, one of
-              open-2027  cycle/stage
-```
-
-Passing:
-
-```yaml
----
-stages:
-  - stage: submitted
-    cycle: open-2027
-    date: 2026-07-22
-    pdf: versions/a.pdf
-    bytes: 1
----
-```
-
-Also passing: a paper without `cycles`, whatever its stages say.
-
-## Options / preset fields
-
-No rule options.
-
-## What it does not check
-
-- The PDF, its bytes, or the frozen source — [`paper/stages`](../../rules.md) and `paper/source`
-  do.
-- Whether a stage's `date` falls inside its cycle (after `opened`, before the outcome's `date`).
-- Whether a cycle without any `submitted` stage was in fact submitted; that is the portal's record
-  (`paperlint submission`), not the scorecard's.
-- The rest of the cycle record — [`cycle/record`](record.md) does.
-
-## How to fix
-
-Add `cycle: <id>` to each stage, with the id of the cycle the PDF was sent in. For a stage whose
-cycle is still `porting`: if the port is done, remove `"phase": "porting"` from the cycle
-([`cycle/port-done`](port-done.md) says when); if no PDF was sent, remove the stage.

package/eslint-rules/cycle-stage.test.mjs

@@ -1,131 +0,0 @@
-/**
- * `cycle/stage` on a scorecard's frontmatter beside a settings file: a stage names its cycle, the
- * cycle exists, and no PDF was sent from a cycle still porting. Silent on the flat form.
- */
-import assert from "node:assert/strict";
-import { join } from "node:path";
-import markdown from "@eslint/markdown";
-import { Linter } from "eslint";
-import { test } from "vitest";
-import { useTempDir, writeTree } from "../test/support.ts";
-import cycleStage from "./cycle-stage.ts";
-
-const root = useTempDir("cycle-stage-");
-const linter = new Linter({ cwd: root });
-
-const SETTINGS = JSON.stringify({
-  cycles: [
-    {
-      id: "alpha-2026",
-      venue: { kind: "preset", extends: "paperlint:acm-sigconf" },
-      opened: "2026-07-01",
-      outcome: { kind: "rejected", date: "2026-09-08", evidence: "r.md" },
-    },
-    {
-      id: "beta-2027",
-      venue: { kind: "preset", extends: "paperlint:ieee-conference" },
-      opened: "2026-09-09",
-      phase: "porting",
-    },
-  ],
-});
-
-/** The messages of the rule on a PIPELINE-STATUS.md with `frontmatter`, beside `settings`. */
-function lint(name, frontmatter, settings = SETTINGS) {
-  const dir = writeTree(join(root, name), {
-    ...(settings === null ? {} : { "paperlint.json": settings }),
-  });
-  const msgs = linter.verify(
-    `---\n${frontmatter}\n---\n\n# Status\n`,
-    [
-      {
-        files: ["**/*.md"],
-        plugins: { markdown, cycle: cycleStage },
-        language: "markdown/gfm",
-        languageOptions: { frontmatter: "yaml" },
-        rules: { "cycle/stage": "error" },
-      },
-    ],
-    join(dir, "PIPELINE-STATUS.md"),
-  );
-  assert.deepEqual(
-    msgs.filter((m) => m.fatal),
-    [],
-    `${name}: the rule threw`,
-  );
-  return msgs.map((m) => m.message);
-}
-
-const SUBMITTED = (cycle) =>
-  `stages:\n  - stage: submitted\n    ${cycle}\n    date: 2026-08-06\n    pdf: versions/a.pdf\n    bytes: 1`;
-
-test("a stage naming a declared cycle: silent", () => {
-  assert.deepEqual(lint("ok", SUBMITTED("cycle: alpha-2026")), []);
-});
-
-test("the flat form (no `cycles`), no settings file, or no stages: silent", () => {
-  const flat = JSON.stringify({ extends: "paperlint:aidc" });
-  assert.deepEqual(lint("flat", SUBMITTED("venue: Somewhere"), flat), []);
-  assert.deepEqual(lint("none", SUBMITTED("venue: Somewhere"), null), []);
-  assert.deepEqual(lint("empty", "stages: []"), []);
-});
-
-test("a stage with no `cycle` names the declared ids; one naming an unknown id names it", () => {
-  assert.deepEqual(lint("no-cycle", SUBMITTED("venue: Somewhere")), [
-    "the «submitted» stage (2026-08-06) names no `cycle` — this paper declares `cycles` in paperlint.json, so each stage says which attempt it belongs to: `cycle: <id>`, one of alpha-2026 · beta-2027",
-  ]);
-  assert.deepEqual(lint("unknown", SUBMITTED("cycle: gamma-2028")), [
-    "the «submitted» stage (2026-08-06) names the cycle «gamma-2028», which paperlint.json does not declare — the declared ids: alpha-2026 · beta-2027",
-  ]);
-});
-
-test("a PDF sent from a cycle still porting is named; a stage that sends none is not", () => {
-  assert.deepEqual(lint("porting", SUBMITTED("cycle: beta-2027")), [
-    "the «submitted» stage (2026-08-06) belongs to the cycle «beta-2027», whose phase is still `porting`: a PDF was sent while the record says the source is in the previous venue's template. Finish the port and drop the phase, or the stage is wrong",
-  ]);
-  assert.deepEqual(
-    lint(
-      "arxiv-porting",
-      SUBMITTED("cycle: beta-2027").replace("submitted", "arxiv"),
-    ),
-    [],
-  );
-});
-
-test("a settings file that is not JSON, or frontmatter that is not YAML: silent — other rules report those", () => {
-  assert.deepEqual(lint("not-json", SUBMITTED("venue: X"), "{ not json"), []);
-  assert.deepEqual(lint("not-yaml", "stages: [unclosed"), []);
-});
-
-test("`cycles: []` declared: a stage without a cycle is told there are none to name", () => {
-  const [msg] = lint(
-    "no-cycles",
-    SUBMITTED("venue: X"),
-    JSON.stringify({ cycles: [] }),
-  );
-  assert.match(msg, /one of \(none\)$/);
-});
-
-test("a stage and a cycle that are not strings, and a quoted date, are shown as written", () => {
-  const [msg] = lint(
-    "numbers",
-    'stages:\n  - stage: 5\n    cycle: 7\n    date: "2026-08-06"\n    pdf: versions/a.pdf\n    bytes: 1',
-  );
-  assert.match(msg, /the «5» stage \(2026-08-06\) names the cycle «7»/);
-});
-
-test("a stage entry with no `stage` key is shown as an empty name", () => {
-  const [msg] = lint(
-    "no-stage",
-    "stages:\n  - cycle: gamma-2028\n    date: 2026-08-06\n    pdf: versions/a.pdf\n    bytes: 1",
-  );
-  assert.match(
-    msg,
-    /^the «» stage \(2026-08-06\) names the cycle «gamma-2028»/,
-  );
-});
-
-test("a YAML date without quotes is still a date in the message", () => {
-  const [msg] = lint("yaml-date", SUBMITTED("venue: X"));
-  assert.match(msg, /\(2026-08-06\)/);
-});

package/eslint-rules/cycle-stage.ts

@@ -1,141 +0,0 @@
-/**
- * `cycle/stage` — a declared stage names the ATTEMPT it belongs to, and that attempt exists.
- *
- * With `cycles` in the paper's `paperlint.json`, a `stages` entry in the scorecard's frontmatter
- * says `cycle: <id>` instead of a free `venue:` string: the venue's name is then the cycle's
- * preset's, spelled once, and a consumer can tell which rows of the scorecard belong to which
- * attempt. Three things can be wrong, each an error:
- *
- *   noCycle        `cycles` is declared and a stage names no `cycle`
- *   unknownCycle   the stage's `cycle` is no declared cycle's id
- *   porting        a `submitted` or `camera-ready` stage in a cycle whose phase is still `porting` —
- *                  a PDF was sent while the record says the source is in the previous venue's template
- *
- * Without `cycles` (the flat form) the rule is silent: `venue:` stays what it was. The settings file
- * is read here only for the cycles' ids and phases; `cycle/record` (src/cycle-rules.ts) judges the
- * whole record.
- */
-import { existsSync, readFileSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { load } from "js-yaml";
-import { z } from "zod";
-import type { RuleContext } from "./rule-context.ts";
-
-const SETTINGS_FILE = "paperlint.json";
-
-/** What this rule reads of a cycle: its id and phase. `cycle/record` parses the rest. */
-const CycleHead = z.looseObject({
-  id: z.string(),
-  phase: z.string().optional(),
-});
-const Settings = z.looseObject({
-  cycles: z.array(CycleHead.catch({ id: "" })).optional(),
-});
-const Frontmatter = z.looseObject({ stages: z.unknown().optional() }).catch({});
-const Stage = z
-  .looseObject({
-    stage: z.unknown().optional(),
-    cycle: z.unknown().optional(),
-    date: z.unknown().optional(),
-  })
-  .catch({});
-
-/** The stages that send a PDF to the venue: a cycle still porting cannot have one. */
-const SENT: readonly string[] = ["submitted", "camera-ready"];
-
-interface Head {
-  readonly id: string;
-  readonly phase: string;
-}
-
-/** The declared cycles' heads, or null when the paper has no `cycles` (or no readable settings). */
-function cyclesOf(dir: string): readonly Head[] | null {
-  const file = join(dir, SETTINGS_FILE);
-  if (!existsSync(file)) return null;
-  try {
-    const s = Settings.safeParse(JSON.parse(readFileSync(file, "utf8")));
-    return s.success && s.data.cycles !== undefined
-      ? s.data.cycles.map((c) => ({ id: c.id, phase: c.phase ?? "prepared" }))
-      : null;
-  } catch {
-    return null;
-  }
-}
-
-const text = (v: unknown): string =>
-  typeof v === "string" ? v : v === undefined ? "" : JSON.stringify(v);
-
-/** A YAML date without quotes is a `Date`; shown as the day it names, as `paper/stages` does. */
-const dateText = (v: unknown): string =>
-  v instanceof Date ? v.toISOString().slice(0, 10) : text(v);
-
-interface Finding {
-  readonly messageId: "noCycle" | "unknownCycle" | "porting";
-  readonly data: Readonly<Record<string, string>>;
-}
-
-/** Each stage against the declared cycles. Pure. */
-export function judgeStages(
-  stages: readonly unknown[],
-  cycles: readonly Head[],
-): readonly Finding[] {
-  const known = cycles.map((c) => c.id).join(" · ") || "(none)";
-  return stages.flatMap((entry): readonly Finding[] => {
-    const s = Stage.parse(entry);
-    const stage = text(s.stage);
-    const date = dateText(s.date);
-    if (s.cycle === undefined)
-      return [{ messageId: "noCycle", data: { stage, date, known } }];
-    const id = text(s.cycle);
-    const cycle = cycles.find((c) => c.id === id);
-    if (cycle === undefined)
-      return [{ messageId: "unknownCycle", data: { stage, date, id, known } }];
-    return SENT.includes(stage) && cycle.phase === "porting"
-      ? [{ messageId: "porting", data: { stage, date, id } }]
-      : [];
-  });
-}
-
-export default {
-  rules: {
-    stage: {
-      meta: {
-        type: "problem" as const,
-        docs: {
-          description:
-            "with `cycles` declared, every stage names the cycle it belongs to, and no PDF is sent from a cycle still porting",
-          url: "https://github.com/zernie/paperlint/blob/main/docs/rules/cycle/stage.md",
-        },
-        schema: [],
-        messages: {
-          noCycle:
-            "the «{{stage}}» stage ({{date}}) names no `cycle` — this paper declares `cycles` in paperlint.json, so each stage says which attempt it belongs to: `cycle: <id>`, one of {{known}}",
-          unknownCycle:
-            "the «{{stage}}» stage ({{date}}) names the cycle «{{id}}», which paperlint.json does not declare — the declared ids: {{known}}",
-          porting:
-            "the «{{stage}}» stage ({{date}}) belongs to the cycle «{{id}}», whose phase is still `porting`: a PDF was sent while the record says the source is in the previous venue's template. Finish the port and drop the phase, or the stage is wrong",
-        },
-      },
-      create(context: RuleContext) {
-        const cycles = cyclesOf(dirname(context.filename));
-        if (cycles === null) return {};
-        return {
-          yaml(node: { readonly value: string }) {
-            const data = ((): unknown => {
-              try {
-                return load(node.value);
-              } catch {
-                return undefined; // `paper/stages` reports the unreadable YAML
-              }
-            })();
-            const stages = Frontmatter.parse(data).stages;
-            if (!Array.isArray(stages)) return;
-            judgeStages(stages, cycles).forEach((f) => {
-              context.report({ node, messageId: f.messageId, data: f.data });
-            });
-          },
-        };
-      },
-    },
-  },
-};