paperlint 10.1.1 → 10.3.0

package/dist/ports/study-registry-codec.d.ts

@@ -0,0 +1,15 @@
+/**
+ * How a `repro/studies.json`, and a study's `plan.json`, become values: its text parsed once, where it enters, against the schema
+ * of `StudyRegistry` (`src/domain/study-registry.ts`). The one implementation is
+ * `src/adapters/study-registry/` (zod); `src/cli.ts` wires it.
+ */
+import type { ParsedPlan, ParsedRegistry } from "../domain/study-registry.ts";
+export interface StudyRegistryCodec {
+    /** A `studies.json`'s text: the registry, or the one reason it is not one of this schema. */
+    readonly parse: (text: string) => ParsedRegistry;
+    /** A study's `plan.json` text, strict: ready, a draft naming its empty texts, or why it is no plan. */
+    readonly parsePlan: (text: string) => ParsedPlan;
+    /** A plan still named `prereg.json`, loose: the same three outcomes. */
+    readonly parseLegacyPlan: (text: string) => ParsedPlan;
+}
+//# sourceMappingURL=study-registry-codec.d.ts.map

package/dist/ports/study-registry-codec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"study-registry-codec.d.ts","sourceRoot":"","sources":["../../src/ports/study-registry-codec.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE9E,MAAM,WAAW,kBAAkB;IACjC,6FAA6F;IAC7F,QAAQ,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,cAAc,CAAC;IACjD,uGAAuG;IACvG,QAAQ,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,UAAU,CAAC;IACjD,wEAAwE;IACxE,QAAQ,CAAC,eAAe,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,UAAU,CAAC;CACxD"}

package/dist/ports/study-registry-codec.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=study-registry-codec.js.map

package/dist/ports/study-registry-codec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"study-registry-codec.js","sourceRoot":"","sources":["../../src/ports/study-registry-codec.ts"],"names":[],"mappings":""}

package/dist/repro-layout-rule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"repro-layout-rule.d.ts","sourceRoot":"","sources":["../src/repro-layout-rule.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EAEV,gBAAgB,EACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAkB5D;;;GAGG;AACH,eAAO,MAAM,UAAU,GACrB,KAAK,MAAM,EACX,SAAS,SAAS,WAAW,EAAE,EAC/B,OAAO,KAAK,KACX,SAAS,MAAM,EAC6C,CAAC;AAEhE,kGAAkG;AAClG,eAAO,MAAM,cAAc,GACzB,KAAK,MAAM,EACX,MAAM,gBAAgB,KACrB,SAAS,WAAW,EAMlB,CAAC;AAgBN,mDAAmD;AACnD,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,gBAAgB,GACrB,QAAQ,CAAC,MAAM,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CAAC,CAwB1D;AAED,+FAA+F;AAC/F,eAAO,MAAM,wBAAwB,EAAE,QAAQ,CAC7C,MAAM,CAAC,0BAA0B,EAAE,OAAO,CAAC,CACF,CAAC"}
+{"version":3,"file":"repro-layout-rule.d.ts","sourceRoot":"","sources":["../src/repro-layout-rule.ts"],"names":[],"mappings":"AA4BA,OAAO,KAAK,EAEV,gBAAgB,EACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAkB5D;;;GAGG;AACH,eAAO,MAAM,UAAU,GACrB,KAAK,MAAM,EACX,SAAS,SAAS,WAAW,EAAE,EAC/B,OAAO,KAAK,KACX,SAAS,MAAM,EAC6C,CAAC;AAEhE,kGAAkG;AAClG,eAAO,MAAM,cAAc,GACzB,KAAK,MAAM,EACX,MAAM,gBAAgB,KACrB,SAAS,WAAW,EAMlB,CAAC;AAgBN,mDAAmD;AACnD,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,gBAAgB,GACrB,QAAQ,CAAC,MAAM,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CAAC,CAwB1D;AAED,+FAA+F;AAC/F,eAAO,MAAM,wBAAwB,EAAE,QAAQ,CAC7C,MAAM,CAAC,0BAA0B,EAAE,OAAO,CAAC,CACF,CAAC"}

package/dist/repro-layout-rule.js

@@ -1,6 +1,7 @@
 /**
- * `repro/allowed-files-only` — the top of a paper's `repro/` holds an index, the shared `tools/` and
- * `data/`, and one dated folder per study, each with a `README.md`.
+ * `repro/allowed-files-only` — the top of a paper's `repro/` holds an index, the study registry, the
+ * shared `tools/` and `data/`, and one folder per study, each with a `README.md`. Whether each study
+ * folder has its row in the registry is `repro/study-registered`'s (src/study-registry-rule.ts).
  *
  * What may stand there, and why, is `src/domain/repro-layout.ts` and docs/rules/repro/allowed-files-only.md.
  * This file lists the folder and reports.
@@ -42,7 +43,7 @@ export const reproEntriesOf = (dir, deps) => [...deps.listDir(callerPath(join(di
 const META = {
     type: "suggestion",
     docs: {
-        description: "the top of a paper's repro/ holds README.md, .gitignore, tools/, data/ and one <slug>-YYYY-MM-DD folder per study, each with a README.md",
+        description: "the top of a paper's repro/ holds README.md, studies.json, .gitignore, tools/, data/ and one <id>-<slug> (or <slug>-YYYY-MM-DD) folder per study, each with a README.md",
         url: rulePageUrl("repro/allowed-files-only"),
     },
     schema: [],

package/dist/repro-layout-rule.js.map

@@ -1 +1 @@
-{"version":3,"file":"repro-layout-rule.js","sourceRoot":"","sources":["../src/repro-layout-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,SAAS,EACT,UAAU,EACV,YAAY,GAEb,MAAM,0BAA0B,CAAC;AAQlC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAEzC,kFAAkF;AAClF,MAAM,UAAU,GAAG,CACjB,GAAW,EACX,OAA+B,EAC/B,KAAY,EACW,EAAE,CACzB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAClB,GAAG,CAAC;IACJ,SAAS,EACP,CAAC,CAAC,IAAI,KAAK,KAAK;QAChB,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;CACjE,CAAC,CAAC,CAAC;AAEN;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,GAAW,EACX,OAA+B,EAC/B,KAAY,EACO,EAAE,CACrB,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAEhE,kGAAkG;AAClG,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,GAAW,EACX,IAAsB,EACE,EAAE,CAC1B,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACxE,IAAI;IACJ,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,MAAM;QACR,CAAC,CAAC,KAAK;CACV,CAAC,CAAC,CAAC;AAEN,MAAM,IAAI,GAA6B;IACrC,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE;QACJ,WAAW,EACT,0IAA0I;QAC5I,GAAG,EAAE,WAAW,CAAC,0BAA0B,CAAC;KAC7C;IACD,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE;QACR,6FAA6F;QAC7F,SAAS,EAAE,UAAU;KACtB;CACF,CAAC;AAEF,mDAAmD;AACnD,MAAM,UAAU,gBAAgB,CAC9B,IAAsB;IAEtB,OAAO;QACL,oBAAoB,EAAE;YACpB,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,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;wBACtC,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;wBACjD,UAAU,CAAC,GAAG,EAAE,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAC5D,CAAC,IAAI,EAAE,EAAE;4BACP,OAAO,CAAC,MAAM,CAAC;gCACb,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;gCAC3B,SAAS,EAAE,WAAW;gCACtB,IAAI,EAAE,EAAE,IAAI,EAAE;6BACf,CAAC,CAAC;wBACL,CAAC,CACF,CAAC;oBACJ,CAAC;iBACF,CAAC;YACJ,CAAC;SACF;KACF,CAAC;AACJ,CAAC;AAED,+FAA+F;AAC/F,MAAM,CAAC,MAAM,wBAAwB,GAEjC,EAAE,0BAA0B,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"repro-layout-rule.js","sourceRoot":"","sources":["../src/repro-layout-rule.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;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,SAAS,EACT,UAAU,EACV,YAAY,GAEb,MAAM,0BAA0B,CAAC;AAQlC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAEzC,kFAAkF;AAClF,MAAM,UAAU,GAAG,CACjB,GAAW,EACX,OAA+B,EAC/B,KAAY,EACW,EAAE,CACzB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAClB,GAAG,CAAC;IACJ,SAAS,EACP,CAAC,CAAC,IAAI,KAAK,KAAK;QAChB,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;CACjE,CAAC,CAAC,CAAC;AAEN;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,GAAW,EACX,OAA+B,EAC/B,KAAY,EACO,EAAE,CACrB,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAEhE,kGAAkG;AAClG,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,GAAW,EACX,IAAsB,EACE,EAAE,CAC1B,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACxE,IAAI;IACJ,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,MAAM;QACR,CAAC,CAAC,KAAK;CACV,CAAC,CAAC,CAAC;AAEN,MAAM,IAAI,GAA6B;IACrC,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE;QACJ,WAAW,EACT,yKAAyK;QAC3K,GAAG,EAAE,WAAW,CAAC,0BAA0B,CAAC;KAC7C;IACD,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE;QACR,6FAA6F;QAC7F,SAAS,EAAE,UAAU;KACtB;CACF,CAAC;AAEF,mDAAmD;AACnD,MAAM,UAAU,gBAAgB,CAC9B,IAAsB;IAEtB,OAAO;QACL,oBAAoB,EAAE;YACpB,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,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;wBACtC,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;wBACjD,UAAU,CAAC,GAAG,EAAE,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAC5D,CAAC,IAAI,EAAE,EAAE;4BACP,OAAO,CAAC,MAAM,CAAC;gCACb,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;gCAC3B,SAAS,EAAE,WAAW;gCACtB,IAAI,EAAE,EAAE,IAAI,EAAE;6BACf,CAAC,CAAC;wBACL,CAAC,CACF,CAAC;oBACJ,CAAC;iBACF,CAAC;YACJ,CAAC;SACF;KACF,CAAC;AACJ,CAAC;AAED,+FAA+F;AAC/F,MAAM,CAAC,MAAM,wBAAwB,GAEjC,EAAE,0BAA0B,EAAE,OAAO,EAAE,CAAC"}

package/dist/studies.d.ts

@@ -0,0 +1,27 @@
+import type { Files } from "./ports/files.ts";
+import type { StudyRegistryCodec } from "./ports/study-registry-codec.ts";
+import type { ListDir } from "./ports/talk-media.ts";
+/** What one `studies` run was asked, after the command line. */
+export interface StudiesArgs {
+    readonly sub: string | undefined;
+    readonly paperDir: string | undefined;
+    /** `new`'s title; for `index`, an argument too many. */
+    readonly title: string | undefined;
+    /** Positional arguments past the title: refused. */
+    readonly extra: readonly string[];
+    /** `--kind <kind>`; null: the default. */
+    readonly kind: string | null;
+}
+export interface StudiesDeps {
+    readonly files: Files;
+    readonly listDir: ListDir;
+    readonly codec: StudyRegistryCodec;
+    readonly cwd: string;
+    /** Today, `YYYY-MM-DD`: the root reads the clock. */
+    readonly today: string;
+    readonly log: (line: string) => void;
+    readonly err: (line: string) => void;
+}
+/** The run: 0 done, 1 refused by the paper's state, 2 refused by the command line. */
+export declare function runStudies(a: StudiesArgs, deps: StudiesDeps): number;
+//# sourceMappingURL=studies.d.ts.map

package/dist/studies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"studies.d.ts","sourceRoot":"","sources":["../src/studies.ts"],"names":[],"mappings":"AAoCA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGrD,gEAAgE;AAChE,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,wDAAwD;IACxD,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,oDAAoD;IACpD,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;IACnC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,qDAAqD;IACrD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CACtC;AA6LD,sFAAsF;AACtF,wBAAgB,UAAU,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,GAAG,MAAM,CAepE"}

package/dist/studies.js

@@ -0,0 +1,163 @@
+/**
+ * `paperlint studies new|index <paper-dir>` — the two commands that write a paper's study registry,
+ * `repro/studies.json`, and its index in `repro/README.md` (docs/design/study-registry.md).
+ *
+ *   new <paper-dir> "<title>" [--kind <kind>]
+ *            the next id; `repro/<id>-<slug>/README.md` with the id and title in its frontmatter, and
+ *            `plan.json`, the plan's template; the row, `status: designing`, today's date, its `plan`;
+ *            the index regenerated
+ *   index <paper-dir>
+ *            the index block of `repro/README.md`, regenerated from the registry
+ *
+ * Nothing else changes a row: a study's status, result and `in_paper` are edited in `studies.json`, and
+ * `repro/study-registered` checks them. The prefix is the paper's own choice, so a paper without a
+ * registry is refused with the file to write rather than given a guessed one.
+ */
+import { join, relative, resolve } from "node:path";
+import { callerPath } from "./caller-path.js";
+import { README, REPRO_DIR } from "./domain/repro-layout.js";
+import { DEFAULT_KIND, PLAN_FILE, STUDIES_FILE, STUDY_KINDS, addStudy, indexInSync, isStudyKind, planTemplate, planText, registryText, studyReadme, withIndex, } from "./domain/study-registry.js";
+import { registryOf } from "./study-registry-rule.js";
+const NEW_USAGE = 'npx paperlint studies new <paper-dir> "<title>" [--kind <kind>]';
+const INDEX_USAGE = "npx paperlint studies index <paper-dir>";
+const SUBS = `new or index — ${NEW_USAGE} · ${INDEX_USAGE}`;
+const STATUS_FILE = "PIPELINE-STATUS.md";
+const refuse = (code, line) => ({ code, line });
+/** The paper folder's registry, or the refusal naming why there is none to write to. */
+function registryIn(p, deps) {
+    const r = registryOf(p.dir, deps);
+    const file = `${p.shown}/${REPRO_DIR}/${STUDIES_FILE}`;
+    switch (r.kind) {
+        case "absent":
+            return refuse(1, `${file} does not exist. Its prefix is the paper's own choice — a capital letter, then capitals or digits, one per paper (P1) — so write the file, then run this again:\n\n{ "prefix": "P1", "studies": [] }`);
+        case "unreadable":
+            return refuse(1, `${file} is not a study registry: ${r.why}`);
+        case "read":
+            return r.registry;
+    }
+}
+const isRefusal = (v) => typeof v === "object" && v !== null && "code" in v && "line" in v;
+const text = (s) => new TextEncoder().encode(s);
+/** The README's text; null when there is none. */
+const readmeOf = (dir, files) => {
+    const b = files.readBytes(callerPath(join(dir, REPRO_DIR, README)));
+    return b === null ? null : new TextDecoder().decode(b);
+};
+const studiesCount = (r) => `${String(r.studies.length)} ${r.studies.length === 1 ? "study" : "studies"}`;
+/**
+ * Write the index of `r` into the README; whether it wrote. A block already in sync is left as it
+ * is, so the padding a formatter gave the table is never undone.
+ */
+function writeIndex(dir, r, files) {
+    const before = readmeOf(dir, files);
+    if (indexInSync(before, r))
+        return false;
+    files.writeAtomic(callerPath(join(dir, REPRO_DIR, README)), text(withIndex(before, r)));
+    return true;
+}
+/** The refusal when something that is not a file sits where `repro/README.md` goes; null when none. */
+function readmeBlocked(p, deps) {
+    const listed = deps.listDir(callerPath(join(p.dir, REPRO_DIR)));
+    const path = callerPath(join(p.dir, REPRO_DIR, README));
+    return listed.includes(README) && !deps.files.isFile(path)
+        ? refuse(1, `${p.shown}/${REPRO_DIR}/${README} is not a file, so the index cannot be written there. Move it, then run this again.`)
+        : null;
+}
+/** `studies index`: the README's block regenerated from the registry. */
+function runIndex(p, a, deps) {
+    const [surplus] = [...(a.title === undefined ? [] : [a.title]), ...a.extra];
+    if (surplus !== undefined)
+        return refuse(2, `studies index takes only the paper's folder — \`${surplus}\` is one argument too many`);
+    const r = registryIn(p, deps);
+    if (isRefusal(r))
+        return r;
+    const blocked = readmeBlocked(p, deps);
+    if (blocked !== null)
+        return blocked;
+    const readme = `${p.shown}/${REPRO_DIR}/${README}`;
+    return [
+        writeIndex(p.dir, r, deps.files)
+            ? `wrote the index of ${studiesCount(r)} in ${readme}`
+            : `the index in ${readme} is in sync with ${studiesCount(r)}`,
+    ];
+}
+/** `new`'s title and kind from the command line, or the refusal. */
+function newArgs(a) {
+    if (a.title === undefined)
+        return refuse(2, `studies new needs the study's title: ${NEW_USAGE}`);
+    const [surplus] = a.extra;
+    if (surplus !== undefined)
+        return refuse(2, `studies new takes the paper's folder and one title — \`${surplus}\` is one argument too many (quote a title of several words)`);
+    const kind = a.kind ?? DEFAULT_KIND;
+    return isStudyKind(kind)
+        ? { title: a.title, kind }
+        : refuse(2, `--kind ${kind} is not a kind of study: one of ${STUDY_KINDS.join(", ")}`);
+}
+/** Write a new study's README.md and plan.json, the registry, and the index; the lines that say so. */
+function writeStudy(p, added, files) {
+    const { study, registry } = added;
+    const at = (...names) => callerPath(join(p.dir, REPRO_DIR, ...names));
+    files.writeAtomic(at(study.folder, README), text(studyReadme(study)));
+    files.writeAtomic(at(study.folder, PLAN_FILE), text(planText(planTemplate())));
+    files.writeAtomic(at(STUDIES_FILE), text(registryText(registry)));
+    writeIndex(p.dir, registry, files);
+    const repro = `${p.shown}/${REPRO_DIR}`;
+    return [
+        `created ${repro}/${study.folder}/${README}`,
+        `created ${repro}/${study.folder}/${PLAN_FILE}, the study's plan: its fields are there to fill in before the first run`,
+        `added ${study.id} to ${repro}/${STUDIES_FILE}: kind ${study.kind}, status ${study.status}, ${study.date}`,
+        `wrote the index of ${studiesCount(registry)} in ${repro}/${README}`,
+        `Next: write the study's one-sentence question in its row (\`question\`) and in its README.md. When it ends, set \`status\`, \`result\`, \`result_file\` and \`in_paper\` in its row, then run \`npx paperlint studies index ${p.shown}\`.`,
+    ];
+}
+/** `studies new`: the folder, its README.md, the row, the index. */
+function runNew(p, a, deps) {
+    const args = newArgs(a);
+    if (isRefusal(args))
+        return args;
+    const r = registryIn(p, deps);
+    if (isRefusal(r))
+        return r;
+    const blocked = readmeBlocked(p, deps);
+    if (blocked !== null)
+        return blocked;
+    const added = addStudy(r, { ...args, date: deps.today });
+    if (!added.ok)
+        return refuse(2, added.why);
+    const folder = added.study.folder;
+    return deps.listDir(callerPath(join(p.dir, REPRO_DIR))).includes(folder)
+        ? refuse(1, `${p.shown}/${REPRO_DIR}/${folder}/ already exists; it is never overwritten. Register it by hand, or remove it and run this again.`)
+        : writeStudy(p, added, deps.files);
+}
+/** The paper folder the command line names, or the refusal. */
+function paperOf(a, deps) {
+    if (a.sub === undefined)
+        return refuse(2, `studies needs a subcommand: ${SUBS}`);
+    if (a.sub !== "new" && a.sub !== "index")
+        return refuse(2, `unknown subcommand \`studies ${a.sub}\`: ${SUBS}`);
+    if (a.paperDir === undefined)
+        return refuse(2, `studies ${a.sub} needs the paper's folder: ${a.sub === "new" ? NEW_USAGE : INDEX_USAGE}`);
+    const dir = resolve(deps.cwd, a.paperDir);
+    const shown = relative(deps.cwd, dir) || ".";
+    return deps.files.isFile(callerPath(join(dir, STATUS_FILE)))
+        ? { dir, shown }
+        : refuse(2, `${shown} is not a paper folder: it has no ${STATUS_FILE}`);
+}
+/** The run: 0 done, 1 refused by the paper's state, 2 refused by the command line. */
+export function runStudies(a, deps) {
+    const p = paperOf(a, deps);
+    const out = isRefusal(p)
+        ? p
+        : a.sub === "new"
+            ? runNew(p, a, deps)
+            : runIndex(p, a, deps);
+    if (isRefusal(out)) {
+        deps.err(out.line);
+        return out.code;
+    }
+    out.forEach((line) => {
+        deps.log(line);
+    });
+    return 0;
+}
+//# sourceMappingURL=studies.js.map

package/dist/studies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"studies.js","sourceRoot":"","sources":["../src/studies.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EACL,YAAY,EACZ,SAAS,EACT,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,WAAW,EACX,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,SAAS,GAIV,MAAM,4BAA4B,CAAC;AAIpC,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAyBtD,MAAM,SAAS,GACb,iEAAiE,CAAC;AACpE,MAAM,WAAW,GAAG,yCAAyC,CAAC;AAC9D,MAAM,IAAI,GAAG,kBAAkB,SAAS,MAAM,WAAW,EAAE,CAAC;AAE5D,MAAM,WAAW,GAAG,oBAAoB,CAAC;AAWzC,MAAM,MAAM,GAAG,CAAC,IAAW,EAAE,IAAY,EAAW,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;AAExE,wFAAwF;AACxF,SAAS,UAAU,CAAC,CAAQ,EAAE,IAAiB;IAC7C,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAClC,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,KAAK,IAAI,SAAS,IAAI,YAAY,EAAE,CAAC;IACvD,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,MAAM,CACX,CAAC,EACD,GAAG,IAAI,sMAAsM,CAC9M,CAAC;QACJ,KAAK,YAAY;YACf,OAAO,MAAM,CAAC,CAAC,EAAE,GAAG,IAAI,6BAA6B,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QAChE,KAAK,MAAM;YACT,OAAO,CAAC,CAAC,QAAQ,CAAC;IACtB,CAAC;AACH,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,CAAU,EAAgB,EAAE,CAC7C,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,MAAM,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC;AAEpE,MAAM,IAAI,GAAG,CAAC,CAAS,EAAc,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAEpE,kDAAkD;AAClD,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,KAAY,EAAiB,EAAE;IAC5D,MAAM,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACpE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,CAAgB,EAAU,EAAE,CAChD,GAAG,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;AAEhF;;;GAGG;AACH,SAAS,UAAU,CAAC,GAAW,EAAE,CAAgB,EAAE,KAAY;IAC7D,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACpC,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC,KAAK,CAAC,WAAW,CACf,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,EACxC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAC3B,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC;AAED,uGAAuG;AACvG,SAAS,aAAa,CAAC,CAAQ,EAAE,IAAiB;IAChD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAChE,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IACxD,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;QACxD,CAAC,CAAC,MAAM,CACJ,CAAC,EACD,GAAG,CAAC,CAAC,KAAK,IAAI,SAAS,IAAI,MAAM,qFAAqF,CACvH;QACH,CAAC,CAAC,IAAI,CAAC;AACX,CAAC;AAED,yEAAyE;AACzE,SAAS,QAAQ,CACf,CAAQ,EACR,CAAc,EACd,IAAiB;IAEjB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;IAC5E,IAAI,OAAO,KAAK,SAAS;QACvB,OAAO,MAAM,CACX,CAAC,EACD,mDAAmD,OAAO,6BAA6B,CACxF,CAAC;IACJ,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9B,IAAI,SAAS,CAAC,CAAC,CAAC;QAAE,OAAO,CAAC,CAAC;IAC3B,MAAM,OAAO,GAAG,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACvC,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,OAAO,CAAC;IACrC,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;IACnD,OAAO;QACL,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;YAC9B,CAAC,CAAC,sBAAsB,YAAY,CAAC,CAAC,CAAC,OAAO,MAAM,EAAE;YACtD,CAAC,CAAC,gBAAgB,MAAM,oBAAoB,YAAY,CAAC,CAAC,CAAC,EAAE;KAChE,CAAC;AACJ,CAAC;AAED,oEAAoE;AACpE,SAAS,OAAO,CACd,CAAc;IAEd,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS;QACvB,OAAO,MAAM,CAAC,CAAC,EAAE,wCAAwC,SAAS,EAAE,CAAC,CAAC;IACxE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC;IAC1B,IAAI,OAAO,KAAK,SAAS;QACvB,OAAO,MAAM,CACX,CAAC,EACD,0DAA0D,OAAO,8DAA8D,CAChI,CAAC;IACJ,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,IAAI,YAAY,CAAC;IACpC,OAAO,WAAW,CAAC,IAAI,CAAC;QACtB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE;QAC1B,CAAC,CAAC,MAAM,CACJ,CAAC,EACD,UAAU,IAAI,mCAAmC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC1E,CAAC;AACR,CAAC;AAED,uGAAuG;AACvG,SAAS,UAAU,CACjB,CAAQ,EACR,KAAkE,EAClE,KAAY;IAEZ,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IAClC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAwB,EAAgB,EAAE,CACvD,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAC/C,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtE,KAAK,CAAC,WAAW,CACf,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,EAC3B,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAC/B,CAAC;IACF,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAClE,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,KAAK,IAAI,SAAS,EAAE,CAAC;IACxC,OAAO;QACL,WAAW,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,MAAM,EAAE;QAC5C,WAAW,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,SAAS,0EAA0E;QACvH,SAAS,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,YAAY,UAAU,KAAK,CAAC,IAAI,YAAY,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,EAAE;QAC1G,sBAAsB,YAAY,CAAC,QAAQ,CAAC,OAAO,KAAK,IAAI,MAAM,EAAE;QACpE,+NAA+N,CAAC,CAAC,KAAK,KAAK;KAC5O,CAAC;AACJ,CAAC;AAED,oEAAoE;AACpE,SAAS,MAAM,CACb,CAAQ,EACR,CAAc,EACd,IAAiB;IAEjB,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,SAAS,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACjC,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC9B,IAAI,SAAS,CAAC,CAAC,CAAC;QAAE,OAAO,CAAC,CAAC;IAC3B,MAAM,OAAO,GAAG,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACvC,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,OAAO,CAAC;IACrC,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,EAAE,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IACzD,IAAI,CAAC,KAAK,CAAC,EAAE;QAAE,OAAO,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;IAClC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtE,CAAC,CAAC,MAAM,CACJ,CAAC,EACD,GAAG,CAAC,CAAC,KAAK,IAAI,SAAS,IAAI,MAAM,kGAAkG,CACpI;QACH,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;AACvC,CAAC;AAED,+DAA+D;AAC/D,SAAS,OAAO,CAAC,CAAc,EAAE,IAAiB;IAChD,IAAI,CAAC,CAAC,GAAG,KAAK,SAAS;QACrB,OAAO,MAAM,CAAC,CAAC,EAAE,+BAA+B,IAAI,EAAE,CAAC,CAAC;IAC1D,IAAI,CAAC,CAAC,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO;QACtC,OAAO,MAAM,CAAC,CAAC,EAAE,gCAAgC,CAAC,CAAC,GAAG,OAAO,IAAI,EAAE,CAAC,CAAC;IACvE,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS;QAC1B,OAAO,MAAM,CACX,CAAC,EACD,WAAW,CAAC,CAAC,GAAG,8BAA8B,CAAC,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE,CAC1F,CAAC;IACJ,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC;IAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC;QAC1D,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE;QAChB,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,KAAK,qCAAqC,WAAW,EAAE,CAAC,CAAC;AAC5E,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,UAAU,CAAC,CAAc,EAAE,IAAiB;IAC1D,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3B,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,KAAK;YACf,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC;YACpB,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3B,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;QACnB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IACD,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACnB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,CAAC;AACX,CAAC"}

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

@@ -0,0 +1,24 @@
+import { 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 { 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;
+}
+/** 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 both rules. */
+export declare function studyFindings(dir: string, deps: StudyRegistryDeps): readonly StudyFinding[];
+/**
+ * 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

@@ -0,0 +1 @@
+{"version":3,"file":"study-registry-rule.d.ts","sourceRoot":"","sources":["../src/study-registry-rule.ts"],"names":[],"mappings":"AA2BA,OAAO,EAQL,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;AAwDD,iGAAiG;AACjG,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,iBAAiB,GACtB,SAAS,YAAY,EAAE,CASzB;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

@@ -0,0 +1,145 @@
+/**
+ * `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, 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, 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
+ * dated `<slug>-YYYY-MM-DD` folders of a paper that predates the registry. This rule judges the
+ * registry against the folders. A paper that keeps its dated folders turns this one off and keeps
+ * its layout judged.
+ *
+ * ── WHICH FILE IT REPORTS ON ─────────────────────────────────────────────────────
+ * `PIPELINE-STATUS.md`, first line, like the layout rules: every paper has it, and ESLint lints no
+ * file in `repro/`.
+ */
+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 { LEGACY_PLAN_FILE, PLAN_NAME_PROBLEMS, STUDIES_FILE, judgeStudies, planKeys, 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 text of the file at `p`; null when there is none, or a directory sits there. */
+const textAt = (files, p) => {
+    const b = files.isFile(callerPath(p)) ? files.readBytes(callerPath(p)) : null;
+    return b === null ? null : new TextDecoder().decode(b);
+};
+/** The registry of the paper folder `dir`: absent, unreadable with why, or read. */
+export function registryOf(dir, deps) {
+    const text = textAt(deps.files, join(dir, REPRO_DIR, STUDIES_FILE));
+    if (text === null)
+        return { kind: "absent" };
+    const parsed = deps.codec.parse(text);
+    return parsed.ok
+        ? { kind: "read", registry: parsed.registry }
+        : { kind: "unreadable", why: parsed.why };
+}
+/** The study folders at the top of `<dir>/repro/`: every folder but the shared ones and the byproducts. */
+const studyFolders = (dir, deps) => reproEntriesOf(dir, deps)
+    .filter((e) => e.kind === "dir" &&
+    !REPRO_DIRS.includes(e.name) &&
+    !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 : [])
+    .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)))));
+/**
+ * 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.
+ */
+const plansOf = (dir, r, deps) => new Map((r.kind === "read" ? planKeys(r.registry) : [])
+    // A NUL is no path the disk can hold, and probing one throws: such a plan reads as missing.
+    .filter((key) => !key.includes("\0"))
+    .flatMap((key) => {
+    const text = textAt(deps.files, join(dir, REPRO_DIR, key));
+    if (text === null)
+        return [];
+    const parse = posix.basename(key) === LEGACY_PLAN_FILE
+        ? deps.codec.parseLegacyPlan
+        : deps.codec.parsePlan;
+    return [[key, parse(text)]];
+}));
+/** Every finding of the paper folder `dir`'s study registry — THE function behind both rules. */
+export function studyFindings(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),
+        plans: plansOf(dir, registry, deps),
+    });
+}
+/** The problems `repro/study-registered` reports, each its own message id; the text is `studyMessage`. */
+const PROBLEMS = [
+    "no-registry",
+    "unreadable",
+    "unregistered",
+    "no-folder",
+    "two-rows",
+    "bad-id",
+    "duplicate-id",
+    "folder-name",
+    "long-title",
+    "no-result",
+    "result-file",
+    "no-successor",
+    "stale-index",
+    "unknown-measurement",
+    "empty-measurement",
+    "unknown-requirement",
+    "headline-approval",
+    "bad-plan",
+    "author-check",
+];
+/** 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, url: rulePageUrl(name) },
+    schema: [],
+    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": 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 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

@@ -0,0 +1 @@
+{"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,QAAQ,EACR,YAAY,GAIb,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;;;GAGG;AACH,MAAM,OAAO,GAAG,CACd,GAAW,EACX,CAAgB,EAChB,IAAgD,EAChB,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,4FAA4F;KAC3F,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;KACpC,OAAO,CAAC,CAAC,GAAG,EAA6C,EAAE;IAC1D,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,MAAM,KAAK,GACT,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,gBAAgB;QACtC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe;QAC5B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;IAC3B,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC9B,CAAC,CAAC,CACL,CAAC;AAEJ,iGAAiG;AACjG,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;QAC3D,KAAK,EAAE,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC;KACpC,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"}