paperlint 10.2.0 → 10.4.0

package/dist/study-modes.d.ts

@@ -0,0 +1,45 @@
+import type { StudyMode } from "./domain/study-mode.ts";
+import type { NotAFile } from "./domain/decide-first.ts";
+import { type PlanTextField, type Study } from "./domain/study-registry.ts";
+import type { Files } from "./ports/files.ts";
+import type { StudyRegistryCodec } from "./ports/study-registry-codec.ts";
+import type { ListEntries } from "./ports/list-entries.ts";
+import type { ListDir } from "./ports/talk-media.ts";
+/** What reading a paper's studies needs: the disk, its listings with and without kinds, and the parsers. */
+export interface StudyDeps {
+    readonly files: Files;
+    readonly listDir: ListDir;
+    readonly entries: ListEntries;
+    readonly codec: StudyRegistryCodec;
+}
+/** What a decision path names on disk: a file, nothing, or something git cannot vouch for. */
+export type OnDisk = "file" | "absent" | NotAFile;
+/**
+ * What `p` is on disk, read from its directory's entries without following a link: a decision must
+ * be a regular file — git answers for a directory with the commits of anything under it, and for a
+ * link with the link, not the file it points to.
+ */
+export declare const onDisk: (p: string, deps: Pick<StudyDeps, "entries">) => OnDisk;
+/**
+ * Every file under `dir`, relative to it, `/`-separated; none when it is not a directory. A symbolic
+ * link is listed as a file — git stores it as one — and never followed: a link to the folder itself
+ * would recurse forever, and one to a tree outside would bring its files into the study.
+ */
+export declare const filesUnder: (dir: string, deps: Pick<StudyDeps, "entries">, prefix?: string) => readonly string[];
+/**
+ * A study whose plan parsed with a mode: its row, the plan's path in its folder, the mode, and the
+ * plan's empty texts — none when it is ready. Only a ready plan's mode decides anything: a draft may
+ * name no outputs, or an empty decision file.
+ */
+export interface ModeStudy {
+    readonly row: Study;
+    readonly plan: string;
+    readonly mode: StudyMode;
+    readonly empty: readonly PlanTextField[];
+}
+/**
+ * Every study of the paper folder `paper` whose plan declares a mode, in registry order. A plan that
+ * does not parse is `repro/study-registered`'s to report; here it declares nothing.
+ */
+export declare const modeStudies: (paper: string, deps: Pick<StudyDeps, "files" | "codec" | "entries">) => readonly ModeStudy[];
+//# sourceMappingURL=study-modes.d.ts.map

package/dist/study-modes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"study-modes.d.ts","sourceRoot":"","sources":["../src/study-modes.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAEL,KAAK,aAAa,EAClB,KAAK,KAAK,EACX,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAY,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGrD,4GAA4G;AAC5G,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;CACpC;AAED,8FAA8F;AAC9F,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAQlD;;;;GAIG;AACH,eAAO,MAAM,MAAM,GAAI,GAAG,MAAM,EAAE,MAAM,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,KAAG,MAKpE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GACrB,KAAK,MAAM,EACX,MAAM,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,EAChC,eAAW,KACV,SAAS,MAAM,EAId,CAAC;AAEL;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,SAAS,aAAa,EAAE,CAAC;CAC1C;AA6BD;;;GAGG;AACH,eAAO,MAAM,WAAW,GACtB,OAAO,MAAM,EACb,MAAM,IAAI,CAAC,SAAS,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC,KACnD,SAAS,SAAS,EAOpB,CAAC"}

package/dist/study-modes.js

@@ -0,0 +1,70 @@
+/**
+ * Reading a paper's studies with their modes: each registered study whose `plan.json` parses with a
+ * `mode`, and the files under a study's folder. What `repro/outputs-before-decision`, `studies gate`
+ * and the index's mode columns read with (docs/design/study-modes.md). A row whose folder is not one
+ * folder inside `repro/` is never read through.
+ */
+import { basename, dirname, join } from "node:path";
+import { callerPath } from "./caller-path.js";
+import { REPRO_DIR } from "./domain/repro-layout.js";
+import { isInside, } from "./domain/study-registry.js";
+import { readableFolders, registryOf, textAt } from "./study-registry-rule.js";
+const ON_DISK = {
+    file: "file",
+    dir: "directory",
+    symlink: "symbolic link",
+};
+/**
+ * What `p` is on disk, read from its directory's entries without following a link: a decision must
+ * be a regular file — git answers for a directory with the commits of anything under it, and for a
+ * link with the link, not the file it points to.
+ */
+export const onDisk = (p, deps) => {
+    const e = deps
+        .entries(callerPath(dirname(p)))
+        .find((x) => x.name === basename(p));
+    return e === undefined ? "absent" : ON_DISK[e.kind];
+};
+/**
+ * Every file under `dir`, relative to it, `/`-separated; none when it is not a directory. A symbolic
+ * link is listed as a file — git stores it as one — and never followed: a link to the folder itself
+ * would recurse forever, and one to a tree outside would bring its files into the study.
+ */
+export const filesUnder = (dir, deps, prefix = "") => deps.entries(callerPath(dir)).flatMap(({ name, kind }) => {
+    const rel = prefix === "" ? name : `${prefix}/${name}`;
+    return kind === "dir" ? filesUnder(join(dir, name), deps, rel) : [rel];
+});
+/**
+ * The study `s`'s plan, when it is a plan inside a folder every reader may read through
+ * (`readableFolders`), by the registry rule's own containment test (`isInside`), that parsed with a
+ * mode; else null.
+ */
+const modeStudyOf = (paper, s, deps, readable) => {
+    const plan = s.plan;
+    const text = plan === undefined ||
+        !readable(s.folder) ||
+        !isInside(plan) ||
+        plan.includes("\0")
+        ? null
+        : textAt(deps.files, join(paper, REPRO_DIR, s.folder, plan));
+    if (plan === undefined || text === null)
+        return null;
+    const parsed = deps.codec.parsePlan(text, s.kind);
+    if (parsed.kind === "unreadable" || parsed.plan.mode === undefined)
+        return null;
+    const empty = parsed.kind === "draft" ? parsed.empty : [];
+    return { row: s, plan, mode: parsed.plan.mode, empty };
+};
+/**
+ * Every study of the paper folder `paper` whose plan declares a mode, in registry order. A plan that
+ * does not parse is `repro/study-registered`'s to report; here it declares nothing.
+ */
+export const modeStudies = (paper, deps) => {
+    const r = registryOf(paper, deps);
+    const readable = readableFolders(paper, deps);
+    return (r.kind === "read" ? r.registry.studies : []).flatMap((s) => {
+        const m = modeStudyOf(paper, s, deps, readable);
+        return m === null ? [] : [m];
+    });
+};
+//# sourceMappingURL=study-modes.js.map

package/dist/study-modes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"study-modes.js","sourceRoot":"","sources":["../src/study-modes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAGrD,OAAO,EACL,QAAQ,GAGT,MAAM,4BAA4B,CAAC;AAKpC,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAa/E,MAAM,OAAO,GAA+C;IAC1D,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,WAAW;IAChB,OAAO,EAAE,eAAe;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAS,EAAE,IAAgC,EAAU,EAAE;IAC5E,MAAM,CAAC,GAAG,IAAI;SACX,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;SAC/B,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,GAAW,EACX,IAAgC,EAChC,MAAM,GAAG,EAAE,EACQ,EAAE,CACrB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE;IACvD,MAAM,GAAG,GAAG,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;IACvD,OAAO,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACzE,CAAC,CAAC,CAAC;AAcL;;;;GAIG;AACH,MAAM,WAAW,GAAG,CAClB,KAAa,EACb,CAAQ,EACR,IAAwC,EACxC,QAAqC,EACnB,EAAE;IACpB,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;IACpB,MAAM,IAAI,GACR,IAAI,KAAK,SAAS;QAClB,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;QACnB,CAAC,QAAQ,CAAC,IAAI,CAAC;QACf,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QACjB,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IACjE,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACrD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS;QAChE,OAAO,IAAI,CAAC;IACd,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,OAAO,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;AACzD,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,KAAa,EACb,IAAoD,EAC9B,EAAE;IACxB,MAAM,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAClC,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC9C,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACjE,MAAM,CAAC,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAChD,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/study-registry-rule.d.ts

@@ -1,17 +1,40 @@
-import { type RegistryState, type StudyFinding } from "./domain/study-registry.ts";
+import { type PlanState, type RegistryState, type StudyFinding } from "./domain/study-registry.ts";
 import type { FolderLayoutDeps } from "./folder-layout-rule.ts";
 import type { FolderRuleModule } from "./folder-venue-rule.ts";
+import type { Files } from "./ports/files.ts";
+import type { ListEntries } from "./ports/list-entries.ts";
 import type { StudyRegistryCodec } from "./ports/study-registry-codec.ts";
 /** What the rule reads with: the disk, its listings, and the registry's parser. */
 export interface StudyRegistryDeps extends FolderLayoutDeps {
     readonly codec: StudyRegistryCodec;
+    /** `repro/`'s entries, links not followed: a study folder that is a link is never read through. */
+    readonly entries: ListEntries;
 }
+/**
+ * The test every reader of a study's folder passes a row through: its folder is one folder name
+ * inside `repro/` (`isFolderName`) and not a symbolic link, which would lead the reads anywhere.
+ */
+export declare const readableFolders: (dir: string, deps: Pick<StudyRegistryDeps, "entries">) => ((folder: string) => boolean);
+/** The text of the file at `p`; null when there is none, or a directory sits there. */
+export declare const textAt: (files: Files, p: string) => string | null;
 /** The registry of the paper folder `dir`: absent, unreadable with why, or read. */
 export declare function registryOf(dir: string, deps: Pick<StudyRegistryDeps, "files" | "codec">): RegistryState;
-/** Every finding of the paper folder `dir`'s study registry — THE function behind the rule. */
+/**
+ * The plan each row of `r` names, read and parsed, by `<folder>/<plan>`; a plan not there is left out.
+ * A plan still named `prereg.json` is parsed by the loose schema of its old name.
+ */
+export declare const plansOf: (dir: string, r: RegistryState, deps: Pick<StudyRegistryDeps, "files" | "codec">, readable: (folder: string) => boolean) => ReadonlyMap<string, PlanState>;
+/** Every finding of the paper folder `dir`'s study registry — THE function behind both rules. */
 export declare function studyFindings(dir: string, deps: StudyRegistryDeps): readonly StudyFinding[];
-/** The rule, reading the folder through `deps`. */
-export declare function studyRegistryRules(deps: StudyRegistryDeps): Readonly<Record<"study-registered", FolderRuleModule>>;
-/** The level it is on at in paperlint's own config, for every paper's `PIPELINE-STATUS.md`. */
-export declare const STUDY_REGISTRY_RULE_LEVELS: Readonly<Record<"repro/study-registered", "error">>;
+/**
+ * The two rules, reading the folder through `deps`: `study-registered`, the registry's errors, and
+ * `study-plan-name`, a warning for a plan still named `prereg.json` — read as the plan, so a paper
+ * that wrote one before `plan.json` existed is not broken, and told the name to move to.
+ */
+export declare function studyRegistryRules(deps: StudyRegistryDeps): Readonly<Record<"study-registered" | "study-plan-name", FolderRuleModule>>;
+/** The levels they are on at in paperlint's own config, for every paper's `PIPELINE-STATUS.md`. */
+export declare const STUDY_REGISTRY_RULE_LEVELS: Readonly<{
+    "repro/study-registered": "error";
+    "repro/study-plan-name": "warn";
+}>;
 //# sourceMappingURL=study-registry-rule.d.ts.map

package/dist/study-registry-rule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"study-registry-rule.d.ts","sourceRoot":"","sources":["../src/study-registry-rule.ts"],"names":[],"mappings":"AA0BA,OAAO,EAIL,KAAK,aAAa,EAClB,KAAK,YAAY,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAEV,gBAAgB,EACjB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAM1E,mFAAmF;AACnF,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;CACpC;AAQD,oFAAoF;AACpF,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,OAAO,CAAC,GAC/C,aAAa,CAOf;AAgCD,+FAA+F;AAC/F,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,iBAAiB,GACtB,SAAS,YAAY,EAAE,CAQzB;AA+BD,mDAAmD;AACnD,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,iBAAiB,GACtB,QAAQ,CAAC,MAAM,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC,CAqBxD;AAED,+FAA+F;AAC/F,eAAO,MAAM,0BAA0B,EAAE,QAAQ,CAC/C,MAAM,CAAC,wBAAwB,EAAE,OAAO,CAAC,CACF,CAAC"}
+{"version":3,"file":"study-registry-rule.d.ts","sourceRoot":"","sources":["../src/study-registry-rule.ts"],"names":[],"mappings":"AA2BA,OAAO,EAQL,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,YAAY,EAClB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAEV,gBAAgB,EACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAM1E,mFAAmF;AACnF,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;IACnC,mGAAmG;IACnG,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;CAC/B;AAcD;;;GAGG;AACH,eAAO,MAAM,eAAe,GAC1B,KAAK,MAAM,EACX,MAAM,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,KACvC,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAG9B,CAAC;AAEF,uFAAuF;AACvF,eAAO,MAAM,MAAM,GAAI,OAAO,KAAK,EAAE,GAAG,MAAM,KAAG,MAAM,GAAG,IAGzD,CAAC;AAEF,oFAAoF;AACpF,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,OAAO,CAAC,GAC/C,aAAa,CAOf;AAmCD;;;GAGG;AACH,eAAO,MAAM,OAAO,GAClB,KAAK,MAAM,EACX,GAAG,aAAa,EAChB,MAAM,IAAI,CAAC,iBAAiB,EAAE,OAAO,GAAG,OAAO,CAAC,EAChD,UAAU,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,KACpC,WAAW,CAAC,MAAM,EAAE,SAAS,CAkB7B,CAAC;AAEJ,iGAAiG;AACjG,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,iBAAiB,GACtB,SAAS,YAAY,EAAE,CAUzB;AA+DD;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,iBAAiB,GACtB,QAAQ,CAAC,MAAM,CAAC,kBAAkB,GAAG,iBAAiB,EAAE,gBAAgB,CAAC,CAAC,CAqB5E;AAED,mGAAmG;AACnG,eAAO,MAAM,0BAA0B,EAAE,QAAQ,CAAC;IAChD,wBAAwB,EAAE,OAAO,CAAC;IAClC,uBAAuB,EAAE,MAAM,CAAC;CACjC,CAA0E,CAAC"}

package/dist/study-registry-rule.js

@@ -1,10 +1,11 @@
 /**
  * `repro/study-registered` — every study folder at the top of a paper's `repro/` has exactly one row in
- * `repro/studies.json`, every row names a folder that exists, and the index in `repro/README.md` is the
- * one the registry generates.
+ * `repro/studies.json`, every row names a folder that exists, a row's measurement and plan hold
+ * together, and the index in `repro/README.md` is the one the registry generates. Beside it,
+ * `repro/study-plan-name`, a warning: a plan still named `prereg.json`.
  *
  * What is judged, and why, is `src/domain/study-registry.ts` and docs/rules/repro/study-registered.md.
- * This file lists `repro/`, reads the registry, the README and the result files, and reports.
+ * This file lists `repro/`, reads the registry, the README, the result files and the plans, and reports.
  *
  * ── WHY A RULE OF ITS OWN, NOT MORE OF `repro/allowed-files-only` ─────────────────────
  * `repro/allowed-files-only` judges what may stand at the top of `repro/`, by name, and accepts the
@@ -16,15 +17,28 @@
  * `PIPELINE-STATUS.md`, first line, like the layout rules: every paper has it, and ESLint lints no
  * file in `repro/`.
  */
-import { basename, dirname, join } from "node:path";
+import { basename, dirname, join, posix } from "node:path";
 import { callerPath } from "./caller-path.js";
 import { README, REPRO_BYPRODUCTS, REPRO_DIR, REPRO_DIRS, } from "./domain/repro-layout.js";
-import { STUDIES_FILE, judgeStudies, studyMessage, } from "./domain/study-registry.js";
+import { LEGACY_PLAN_FILE, PLAN_NAME_PROBLEMS, STUDIES_FILE, isFolderName, judgeStudies, planRefs, studyMessage, } from "./domain/study-registry.js";
 import { reproEntriesOf } from "./repro-layout-rule.js";
 import { rulePageUrl } from "./venue-rules.js";
 const STATUS_FILE = "PIPELINE-STATUS.md";
+/** The names at the top of `<dir>/repro/` that are symbolic links. */
+const linksIn = (dir, deps) => new Set(deps
+    .entries(callerPath(join(dir, REPRO_DIR)))
+    .filter((e) => e.kind === "symlink")
+    .map((e) => e.name));
+/**
+ * The test every reader of a study's folder passes a row through: its folder is one folder name
+ * inside `repro/` (`isFolderName`) and not a symbolic link, which would lead the reads anywhere.
+ */
+export const readableFolders = (dir, deps) => {
+    const links = linksIn(dir, deps);
+    return (folder) => isFolderName(folder) && !links.has(folder);
+};
 /** The text of the file at `p`; null when there is none, or a directory sits there. */
-const textAt = (files, p) => {
+export const textAt = (files, p) => {
     const b = files.isFile(callerPath(p)) ? files.readBytes(callerPath(p)) : null;
     return b === null ? null : new TextDecoder().decode(b);
 };
@@ -45,22 +59,47 @@ const studyFolders = (dir, deps) => reproEntriesOf(dir, deps)
     !REPRO_BYPRODUCTS.includes(e.name))
     .map((e) => e.name);
 /** Each `<folder>/<result_file>` of `r` that is a file. */
-const existingResults = (dir, r, files) => new Set((r.kind === "read" ? r.registry.studies : [])
+const existingResults = (dir, r, files, readable) => new Set((r.kind === "read" ? r.registry.studies : [])
+    // A row whose folder is not one inside `repro/`, or is a link, is never read through.
+    .filter((s) => readable(s.folder))
     .flatMap((s) => s.result_file === undefined ? [] : [`${s.folder}/${s.result_file}`])
     // A NUL is no path the disk can hold, and probing one throws: such a row reads as missing.
     .filter((p) => !p.includes("\0") &&
     files.isFile(callerPath(join(dir, REPRO_DIR, p)))));
-/** Every finding of the paper folder `dir`'s study registry — THE function behind the rule. */
+/**
+ * The plan each row of `r` names, read and parsed, by `<folder>/<plan>`; a plan not there is left out.
+ * A plan still named `prereg.json` is parsed by the loose schema of its old name.
+ */
+export const plansOf = (dir, r, deps, readable) => new Map((r.kind === "read" ? planRefs(r.registry) : [])
+    // A NUL is no path the disk can hold, and probing one throws: such a plan reads as missing. A
+    // folder that is a link is never read through.
+    .filter(({ key, folder }) => !key.includes("\0") && readable(folder))
+    .flatMap(({ key, kind }) => {
+    const text = textAt(deps.files, join(dir, REPRO_DIR, key));
+    if (text === null)
+        return [];
+    return [
+        [
+            key,
+            posix.basename(key) === LEGACY_PLAN_FILE
+                ? deps.codec.parseLegacyPlan(text)
+                : deps.codec.parsePlan(text, kind),
+        ],
+    ];
+}));
+/** Every finding of the paper folder `dir`'s study registry — THE function behind both rules. */
 export function studyFindings(dir, deps) {
+    const readable = readableFolders(dir, deps);
     const registry = registryOf(dir, deps);
     return judgeStudies({
         folders: studyFolders(dir, deps),
         registry,
         readme: textAt(deps.files, join(dir, REPRO_DIR, README)),
-        existingResults: existingResults(dir, registry, deps.files),
+        existingResults: existingResults(dir, registry, deps.files, readable),
+        plans: plansOf(dir, registry, deps, readable),
     });
 }
-/** The problems a finding can be, each its own message id; the text is `studyMessage`. */
+/** The problems `repro/study-registered` reports, each its own message id; the text is `studyMessage`. */
 const PROBLEMS = [
     "no-registry",
     "unreadable",
@@ -75,41 +114,53 @@ const PROBLEMS = [
     "result-file",
     "no-successor",
     "stale-index",
+    "unknown-measurement",
+    "empty-measurement",
+    "unknown-requirement",
+    "headline-approval",
+    "bad-plan",
+    "author-check",
 ];
-const META = {
+/** A rule's meta: its page, and a message id per problem, the whole text being `studyMessage`. */
+const metaOf = (name, description, problems) => ({
     type: "suggestion",
-    docs: {
-        description: "every study folder at the top of a paper's repro/ has exactly one row in repro/studies.json, every row names a folder that exists, and repro/README.md's index is the one the registry generates",
-        url: rulePageUrl("repro/study-registered"),
-    },
+    docs: { description, url: rulePageUrl(name) },
     schema: [],
-    // The whole text is `studyMessage` (src/domain/study-registry.ts).
-    messages: Object.fromEntries(PROBLEMS.map((p) => [p, "{{text}}"])),
-};
-/** The rule, reading the folder through `deps`. */
+    messages: Object.fromEntries(problems.map((p) => [p, "{{text}}"])),
+});
+/** A rule that reports the findings of `problems`, reading the folder through `deps`. */
+const ruleOf = (meta, problems, deps) => ({
+    meta,
+    create(context) {
+        if (basename(context.filename) !== STATUS_FILE)
+            return {};
+        return {
+            root() {
+                const at = context.sourceCode.getLocFromIndex(0);
+                studyFindings(dirname(context.filename), deps)
+                    .filter((f) => problems.includes(f.problem))
+                    .forEach((f) => {
+                    context.report({
+                        loc: { start: at, end: at },
+                        messageId: f.problem,
+                        data: { text: studyMessage(f) },
+                    });
+                });
+            },
+        };
+    },
+});
+/**
+ * The two rules, reading the folder through `deps`: `study-registered`, the registry's errors, and
+ * `study-plan-name`, a warning for a plan still named `prereg.json` — read as the plan, so a paper
+ * that wrote one before `plan.json` existed is not broken, and told the name to move to.
+ */
 export function studyRegistryRules(deps) {
     return {
-        "study-registered": {
-            meta: META,
-            create(context) {
-                if (basename(context.filename) !== STATUS_FILE)
-                    return {};
-                return {
-                    root() {
-                        const at = context.sourceCode.getLocFromIndex(0);
-                        studyFindings(dirname(context.filename), deps).forEach((f) => {
-                            context.report({
-                                loc: { start: at, end: at },
-                                messageId: f.problem,
-                                data: { text: studyMessage(f) },
-                            });
-                        });
-                    },
-                };
-            },
-        },
+        "study-registered": ruleOf(metaOf("repro/study-registered", "every study folder at the top of a paper's repro/ has exactly one row in repro/studies.json, every row names a folder that exists, its measurement and its plan hold together, and repro/README.md's index is the one the registry generates", PROBLEMS), PROBLEMS, deps),
+        "study-plan-name": ruleOf(metaOf("repro/study-plan-name", "a study's plan is named plan.json, not prereg.json", PLAN_NAME_PROBLEMS), PLAN_NAME_PROBLEMS, deps),
     };
 }
-/** The level it is on at in paperlint's own config, for every paper's `PIPELINE-STATUS.md`. */
-export const STUDY_REGISTRY_RULE_LEVELS = { "repro/study-registered": "error" };
+/** The levels they are on at in paperlint's own config, for every paper's `PIPELINE-STATUS.md`. */
+export const STUDY_REGISTRY_RULE_LEVELS = { "repro/study-registered": "error", "repro/study-plan-name": "warn" };
 //# sourceMappingURL=study-registry-rule.js.map

package/dist/study-registry-rule.js.map

@@ -1 +1 @@
-{"version":3,"file":"study-registry-rule.js","sourceRoot":"","sources":["../src/study-registry-rule.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,MAAM,EACN,gBAAgB,EAChB,SAAS,EACT,UAAU,GACX,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,YAAY,GAGb,MAAM,4BAA4B,CAAC;AAQpC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAOzC,uFAAuF;AACvF,MAAM,MAAM,GAAG,CAAC,KAAY,EAAE,CAAS,EAAiB,EAAE;IACxD,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9E,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,oFAAoF;AACpF,MAAM,UAAU,UAAU,CACxB,GAAW,EACX,IAAgD;IAEhD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;IACpE,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC,EAAE;QACd,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE;QAC7C,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;AAC9C,CAAC;AAED,2GAA2G;AAC3G,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,IAAsB,EAAqB,EAAE,CAC9E,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC;KACtB,MAAM,CACL,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,IAAI,KAAK,KAAK;IAChB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5B,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CACrC;KACA,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAExB,2DAA2D;AAC3D,MAAM,eAAe,GAAG,CACtB,GAAW,EACX,CAAgB,EAChB,KAAY,EACS,EAAE,CACvB,IAAI,GAAG,CACL,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1C,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CACb,CAAC,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,CACpE;IACD,2FAA2F;KAC1F,MAAM,CACL,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IACjB,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CACpD,CACJ,CAAC;AAEJ,+FAA+F;AAC/F,MAAM,UAAU,aAAa,CAC3B,GAAW,EACX,IAAuB;IAEvB,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACvC,OAAO,YAAY,CAAC;QAClB,OAAO,EAAE,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC;QAChC,QAAQ;QACR,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QACxD,eAAe,EAAE,eAAe,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC;KAC5D,CAAC,CAAC;AACL,CAAC;AAED,0FAA0F;AAC1F,MAAM,QAAQ,GAAuC;IACnD,aAAa;IACb,YAAY;IACZ,cAAc;IACd,WAAW;IACX,UAAU;IACV,QAAQ;IACR,cAAc;IACd,aAAa;IACb,YAAY;IACZ,WAAW;IACX,aAAa;IACb,cAAc;IACd,aAAa;CACd,CAAC;AAEF,MAAM,IAAI,GAA6B;IACrC,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE;QACJ,WAAW,EACT,kMAAkM;QACpM,GAAG,EAAE,WAAW,CAAC,wBAAwB,CAAC;KAC3C;IACD,MAAM,EAAE,EAAE;IACV,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;CACnE,CAAC;AAEF,mDAAmD;AACnD,MAAM,UAAU,kBAAkB,CAChC,IAAuB;IAEvB,OAAO;QACL,kBAAkB,EAAE;YAClB,IAAI,EAAE,IAAI;YACV,MAAM,CAAC,OAA0B;gBAC/B,IAAI,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,WAAW;oBAAE,OAAO,EAAE,CAAC;gBAC1D,OAAO;oBACL,IAAI;wBACF,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;wBACjD,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;4BAC3D,OAAO,CAAC,MAAM,CAAC;gCACb,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;gCAC3B,SAAS,EAAE,CAAC,CAAC,OAAO;gCACpB,IAAI,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE;6BAChC,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;oBACL,CAAC;iBACF,CAAC;YACJ,CAAC;SACF;KACF,CAAC;AACJ,CAAC;AAED,+FAA+F;AAC/F,MAAM,CAAC,MAAM,0BAA0B,GAEnC,EAAE,wBAAwB,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"study-registry-rule.js","sourceRoot":"","sources":["../src/study-registry-rule.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,MAAM,EACN,gBAAgB,EAChB,SAAS,EACT,UAAU,GACX,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,YAAY,GAIb,MAAM,4BAA4B,CAAC;AASpC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,WAAW,GAAG,oBAAoB,CAAC;AASzC,sEAAsE;AACtE,MAAM,OAAO,GAAG,CACd,GAAW,EACX,IAAwC,EACnB,EAAE,CACvB,IAAI,GAAG,CACL,IAAI;KACD,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;KACzC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC;KACnC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACtB,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,GAAW,EACX,IAAwC,EACT,EAAE;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACjC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF,uFAAuF;AACvF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAY,EAAE,CAAS,EAAiB,EAAE;IAC/D,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9E,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,oFAAoF;AACpF,MAAM,UAAU,UAAU,CACxB,GAAW,EACX,IAAgD;IAEhD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC;IACpE,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC7C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACtC,OAAO,MAAM,CAAC,EAAE;QACd,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE;QAC7C,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;AAC9C,CAAC;AAED,2GAA2G;AAC3G,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,IAAsB,EAAqB,EAAE,CAC9E,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC;KACtB,MAAM,CACL,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,IAAI,KAAK,KAAK;IAChB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5B,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CACrC;KACA,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAExB,2DAA2D;AAC3D,MAAM,eAAe,GAAG,CACtB,GAAW,EACX,CAAgB,EAChB,KAAY,EACZ,QAAqC,EAChB,EAAE,CACvB,IAAI,GAAG,CACL,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3C,sFAAsF;KACrF,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;KACjC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CACb,CAAC,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,CACpE;IACD,2FAA2F;KAC1F,MAAM,CACL,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IACjB,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CACpD,CACJ,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,GAAW,EACX,CAAgB,EAChB,IAAgD,EAChD,QAAqC,EACL,EAAE,CAClC,IAAI,GAAG,CACL,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7C,8FAA8F;IAC9F,+CAA+C;KAC9C,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;KACpE,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAA6C,EAAE;IACpE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3D,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,EAAE,CAAC;IAC7B,OAAO;QACL;YACE,GAAG;YACH,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,gBAAgB;gBACtC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC;gBAClC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC;SACrC;KACF,CAAC;AACJ,CAAC,CAAC,CACL,CAAC;AAEJ,iGAAiG;AACjG,MAAM,UAAU,aAAa,CAC3B,GAAW,EACX,IAAuB;IAEvB,MAAM,QAAQ,GAAG,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACvC,OAAO,YAAY,CAAC;QAClB,OAAO,EAAE,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC;QAChC,QAAQ;QACR,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QACxD,eAAe,EAAE,eAAe,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC;QACrE,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC;KAC9C,CAAC,CAAC;AACL,CAAC;AAED,0GAA0G;AAC1G,MAAM,QAAQ,GAAuC;IACnD,aAAa;IACb,YAAY;IACZ,cAAc;IACd,WAAW;IACX,UAAU;IACV,QAAQ;IACR,cAAc;IACd,aAAa;IACb,YAAY;IACZ,WAAW;IACX,aAAa;IACb,cAAc;IACd,aAAa;IACb,qBAAqB;IACrB,mBAAmB;IACnB,qBAAqB;IACrB,mBAAmB;IACnB,UAAU;IACV,cAAc;CACf,CAAC;AAEF,kGAAkG;AAClG,MAAM,MAAM,GAAG,CACb,IAAY,EACZ,WAAmB,EACnB,QAA4C,EAClB,EAAE,CAAC,CAAC;IAC9B,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE;IAC7C,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;CACnE,CAAC,CAAC;AAEH,yFAAyF;AACzF,MAAM,MAAM,GAAG,CACb,IAA8B,EAC9B,QAA4C,EAC5C,IAAuB,EACL,EAAE,CAAC,CAAC;IACtB,IAAI;IACJ,MAAM,CAAC,OAA0B;QAC/B,IAAI,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,WAAW;YAAE,OAAO,EAAE,CAAC;QAC1D,OAAO;YACL,IAAI;gBACF,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;gBACjD,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC;qBAC3C,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;qBAC3C,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBACb,OAAO,CAAC,MAAM,CAAC;wBACb,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;wBAC3B,SAAS,EAAE,CAAC,CAAC,OAAO;wBACpB,IAAI,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE;qBAChC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAuB;IAEvB,OAAO;QACL,kBAAkB,EAAE,MAAM,CACxB,MAAM,CACJ,wBAAwB,EACxB,8OAA8O,EAC9O,QAAQ,CACT,EACD,QAAQ,EACR,IAAI,CACL;QACD,iBAAiB,EAAE,MAAM,CACvB,MAAM,CACJ,uBAAuB,EACvB,oDAAoD,EACpD,kBAAkB,CACnB,EACD,kBAAkB,EAClB,IAAI,CACL;KACF,CAAC;AACJ,CAAC;AAED,mGAAmG;AACnG,MAAM,CAAC,MAAM,0BAA0B,GAGlC,EAAE,wBAAwB,EAAE,OAAO,EAAE,uBAAuB,EAAE,MAAM,EAAE,CAAC"}

package/dist/study-run.d.ts

@@ -0,0 +1,19 @@
+/** What a `paperlint studies` command on one study comes to: the lines it prints, or its refusal. */
+/** A refusal: the exit code, and the line that explains it. */
+export interface StudyRefusal {
+    readonly code: 1 | 2;
+    readonly line: string;
+}
+/** What a run came to: the lines it printed, or the refusal. */
+export type StudyRun = {
+    readonly ok: true;
+    readonly lines: readonly string[];
+} | {
+    readonly ok: false;
+    readonly refusal: StudyRefusal;
+};
+/** A refusal for the paper's state: exit 1. */
+export declare const refusal: (line: string) => StudyRefusal;
+/** The run that is `r`. */
+export declare const refused: (r: StudyRefusal) => StudyRun;
+//# sourceMappingURL=study-run.d.ts.map

package/dist/study-run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"study-run.d.ts","sourceRoot":"","sources":["../src/study-run.ts"],"names":[],"mappings":"AAAA,qGAAqG;AAErG,+DAA+D;AAC/D,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,gEAAgE;AAChE,MAAM,MAAM,QAAQ,GAChB;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GACxD;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAA;CAAE,CAAC;AAE3D,+CAA+C;AAC/C,eAAO,MAAM,OAAO,GAAI,MAAM,MAAM,KAAG,YAAmC,CAAC;AAE3E,2BAA2B;AAC3B,eAAO,MAAM,OAAO,GAAI,GAAG,YAAY,KAAG,QAGxC,CAAC"}

package/dist/study-run.js

@@ -0,0 +1,9 @@
+/** What a `paperlint studies` command on one study comes to: the lines it prints, or its refusal. */
+/** A refusal for the paper's state: exit 1. */
+export const refusal = (line) => ({ code: 1, line });
+/** The run that is `r`. */
+export const refused = (r) => ({
+    ok: false,
+    refusal: r,
+});
+//# sourceMappingURL=study-run.js.map

package/dist/study-run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"study-run.js","sourceRoot":"","sources":["../src/study-run.ts"],"names":[],"mappings":"AAAA,qGAAqG;AAarG,+CAA+C;AAC/C,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAY,EAAgB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAE3E,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAe,EAAY,EAAE,CAAC,CAAC;IACrD,EAAE,EAAE,KAAK;IACT,OAAO,EAAE,CAAC;CACX,CAAC,CAAC"}