paperlint 9.0.0 → 10.0.0

package/dist/domain/paper-layout.js

@@ -0,0 +1,259 @@
+/**
+ * THE PAPER FOLDER'S LAYOUT — what may stand at the root of a paper folder, and nothing else.
+ *
+ * A paper folder collects files the way a desk does: plans, mails, three drafts of the PDF, a corpus,
+ * an old attempt's checklist. Each was put there for a reason, and after a few months nobody can say
+ * which file is current, which folder holds the evidence, or where a new thing goes. A strict root is
+ * the answer every build tool gives (Cargo's `src/`, a Maven layout): the root holds a small, known
+ * set, every known kind of material has one folder, and ONE escape hatch, `extra/`, takes the rest
+ * without judging it.
+ *
+ * ── WHERE THE SET COMES FROM ─────────────────────────────────────────────────────
+ * Each entry is a file or folder paperlint itself writes or reads, or one its skills name at the
+ * paper root (each carries its note below, which the drawing of the layout shows):
+ *   - what `paperlint new` scaffolds: `PIPELINE-STATUS.md`, `paper.tex`, `paperlint.json`;
+ *   - what the build writes: `paper.pdf` and `_build/`, and TeX's own byproducts beside `paper.tex`
+ *     (pdflatex runs in the paper folder without `-output-directory`), which are never reported;
+ *   - what the rules read: `versions/` (`paper/stages`), `reviews/` (`review/frontmatter`),
+ *     `siblings/` (`sibling/frontmatter`), `talk/` (the `talk/` rules' default folder);
+ *   - what the skills read or write at the root: `README.md`, `CLAUDE.md`, `CLAIMS.md`, `NOTES.md`,
+ *     `SUBMIT-CHECKLIST.md`, `research/`, `repro/`, `figures/`, `submission/`;
+ *   - where the paper's own body lives when it is split: `sections/` (README's `\input{sections/intro}`);
+ *   - the files TeX and bibtex look up in the folder they run in: `*.tex`, `*.bib`, `*.cls`, `*.sty`,
+ *     `*.bst`.
+ * A venue's corpus of accepted papers is NOT here: it is shared by every paper for that venue and
+ * lives outside paper folders, in `<papers>/venues/<venue>/`.
+ *
+ * ── WHAT THE PAPER DECLARES ──────────────────────────────────────────────────────
+ * A paper's settings may move three of these: `pdf` (the built PDF under another name), `talk.dir`
+ * (another talk folder) and a preset file of its own named by `extends`. What the settings name at the
+ * root is allowed beside the fixed set (`Declared.roots`); this module does not read settings.
+ */
+import { basename, extname } from "node:path";
+import { leaf, renderTree } from "./layout-tree.js";
+import { REPRO_DIR, REPRO_NODES } from "./repro-layout.js";
+export const NOTHING_DECLARED = { roots: [] };
+/** The one folder whose content is not judged. */
+export const ESCAPE_HATCH = "extra";
+/** The files the root may hold, by exact name, each with what it is for. */
+export const ROOT_FILE_NOTES = [
+    {
+        name: "PIPELINE-STATUS.md",
+        note: "the paper's one live-state file: stages, plan, scorecard",
+    },
+    { name: "paper.tex", note: "the source; `paperlint build` compiles it" },
+    { name: "paperlint.json", note: "the paper's settings" },
+    { name: "README.md", note: "what the paper is" },
+    { name: "CLAUDE.md", note: "the paper's agent rules" },
+    { name: "CLAIMS.md", note: "the claims ledger" },
+    {
+        name: "NOTES.md",
+        note: "each number in the paper → the data it comes from",
+    },
+    {
+        name: "SUBMIT-CHECKLIST.md",
+        note: "the venue's format and submission mechanics",
+    },
+    { name: ".gitignore", note: "keeps the build's byproducts out of git" },
+    { name: "paper.pdf", note: "the built PDF" },
+];
+/** The files the root may hold, by exact name. */
+export const ROOT_FILES = ROOT_FILE_NOTES.map((f) => f.name);
+/** The folders the root may hold, by exact name, each with what it holds. */
+export const ROOT_DIR_NOTES = [
+    { name: "_build", note: "the facts `paperlint build` writes" },
+    { name: "versions", note: "each stage's frozen PDF and source" },
+    { name: "reviews", note: "dated reviews and pass reports" },
+    { name: "siblings", note: "the cards of competing papers" },
+    { name: "research", note: "dated research and decision records" },
+    { name: REPRO_DIR, note: "the reproduction artifact" },
+    { name: "figures", note: "graphics and their sources" },
+    { name: "sections", note: "the body, when it is split" },
+    { name: "talk", note: "the talk's files" },
+    {
+        name: "submission",
+        note: "forms, portal records, mail with the venue, the anonymized upload",
+    },
+    { name: ESCAPE_HATCH, note: "anything; never judged" },
+];
+/** The folders the root may hold, by exact name. */
+export const ROOT_DIRS = ROOT_DIR_NOTES.map((d) => d.name);
+/**
+ * The files TeX and bibtex look up in the folder they run in, which is the paper's root: a fragment
+ * `\input` names, a database, a class, a package, a bibliography style.
+ */
+export const TEX_INPUT_EXTENSIONS = [
+    ".tex",
+    ".bib",
+    ".cls",
+    ".sty",
+    ".bst",
+];
+/**
+ * The extensions of what a TeX run writes next to its main file, named after the job. The list is
+ * the union of latexmk's clean lists (`@generated_exts`, `$clean_ext` and `$clean_full_ext` in the
+ * latexmk documentation, the files `latexmk -c` and `-C` delete) and the outputs of the tools
+ * `paperlint build` and a hand run use on the same job: pdflatex (`aux log out toc lof lot lol fls
+ * xdv dvi`, `synctex.gz` with `-synctex`), the algorithm packages' `\listofalgorithms` (`loa`),
+ * bibtex (`bbl blg`), makeindex (`idx ind ilg`), glossaries and nomencl (`glo gls glg acn acr alg ist
+ * nlo nls`), biber and biblatex (`bcf run.xml`), beamer (`nav snm vrb`), and latexmk's own
+ * `fdb_latexmk`. A missing extension is added here, not
+ * special-cased where the rule is judged.
+ */
+const BYPRODUCT_EXTENSIONS = [
+    "aux",
+    "log",
+    "out",
+    "toc",
+    "lof",
+    "lot",
+    "lol",
+    "loa",
+    "fls",
+    "xdv",
+    "dvi",
+    "synctex.gz",
+    "bbl",
+    "blg",
+    "idx",
+    "ind",
+    "ilg",
+    "glo",
+    "gls",
+    "glg",
+    "acn",
+    "acr",
+    "alg",
+    "ist",
+    "nlo",
+    "nls",
+    "bcf",
+    "run.xml",
+    "nav",
+    "snm",
+    "vrb",
+    "fdb_latexmk",
+];
+/**
+ * What a `paperlint build` leaves beside `paper.tex`: pdflatex and bibtex run in the paper folder and
+ * name every output after the job, `paper`, so only `paper.<extension>` is the build's. Never
+ * reported — they are the build's, not the author's. Another job name (`draft.aux`) is the author's.
+ */
+export const BUILD_BYPRODUCTS = BYPRODUCT_EXTENSIONS.map((ext) => `paper.${ext}`);
+/** Files the operating system writes into any folder it shows. Never reported. */
+export const OS_FILES = [".DS_Store", "Thumbs.db"];
+/** The live state of a paper — its stages, its plan, its scorecard — is one file. */
+const STATUS_SECTIONS = 'a section of PIPELINE-STATUS.md — the paper\'s one live-state file holds its stages, its plan ("Plan / now") and its scorecard; move what is still live there and delete the file';
+/** The shared corpus of a venue's accepted papers. */
+const VENUE_CORPUS = "<papers-root>/venues/<venue>/, outside the paper folder: one corpus per venue, shared by every paper that targets it";
+/**
+ * Names met in real paper folders, each with its one destination. Matched ignoring case, a file's
+ * name against files and a folder's against folders.
+ */
+export const KNOWN_CURES = [
+    { name: "PLAN.md", kind: "file", cure: STATUS_SECTIONS },
+    { name: "plans", kind: "dir", cure: STATUS_SECTIONS },
+    { name: "DECISION-LOG.md", kind: "file", cure: "research/ (a dated record)" },
+    {
+        name: "EMAILS.md",
+        kind: "file",
+        cure: "submission/ (mail with the venue is about submitting)",
+    },
+    {
+        name: "data",
+        kind: "dir",
+        cure: "repro/data/ (the data behind the numbers)",
+    },
+    {
+        name: "artifact",
+        kind: "dir",
+        cure: "repro/ — its scripts in repro/tools/, its data in repro/data/; the anonymized copy uploaded for review is about submitting and goes in submission/",
+    },
+    {
+        name: "archive",
+        kind: "dir",
+        cure: "versions/ for frozen PDFs, submission/ for an earlier attempt's forms, mails and checklists, extra/ for the rest",
+    },
+    { name: "venue-corpus", kind: "dir", cure: VENUE_CORPUS },
+    { name: "venues", kind: "dir", cure: VENUE_CORPUS },
+];
+/** For a name nobody listed: the choice by what the material is. */
+export const CURE_BY_KIND = "decide by what it is — a record or research → research/; about submitting (forms, mails, checklists, portal records) → submission/; live state of the paper (plan, status) → a section of PIPELINE-STATUS.md; reproduction (scripts, data, the artifact) → repro/; a frozen PDF of a stage → versions/; unclear → extra/, which is never judged";
+const isAllowedFile = (name, declared) => ROOT_FILES.includes(name) ||
+    TEX_INPUT_EXTENSIONS.includes(extname(name)) ||
+    BUILD_BYPRODUCTS.includes(name) ||
+    OS_FILES.includes(name) ||
+    declared.roots.includes(name);
+const isAllowed = (e, declared) => e.kind === "dir"
+    ? ROOT_DIRS.includes(e.name) || declared.roots.includes(e.name)
+    : isAllowedFile(e.name, declared);
+/** Where material like `e` belongs: its listed destination, else the choice by what it is. */
+function cureFor(e) {
+    const known = KNOWN_CURES.find((c) => c.kind === e.kind && c.name.toLowerCase() === e.name.toLowerCase());
+    return known === undefined ? CURE_BY_KIND : known.cure;
+}
+/** The root entries that are not part of the layout, in the order given. Pure. */
+export function judgeLayout(entries, declared) {
+    // `\include{chapter}` makes pdflatex write chapter.aux beside chapter.tex, under that file's own
+    // name, not the job's: the build's for every source at the root, the author's without one.
+    const includeAux = entries
+        .filter((e) => e.kind === "file" && extname(e.name) === ".tex")
+        .map((e) => `${basename(e.name, ".tex")}.aux`);
+    return entries
+        .filter((e) => !isAllowed(e, declared) &&
+        !(e.kind === "file" && includeAux.includes(e.name)))
+        .map((e) => ({
+        name: e.kind === "dir" ? `${e.name}/` : e.name,
+        kind: e.kind,
+        cure: cureFor(e),
+    }));
+}
+/** The paper folder's layout, entry by entry, `repro/` drawn with its own layout inside. */
+export const PAPER_NODES = [
+    ...ROOT_FILE_NOTES.map((f) => leaf(f.name, f.note)),
+    leaf(TEX_INPUT_EXTENSIONS.map((e) => `*${e}`).join(" "), "what TeX and bibtex look up beside paper.tex"),
+    ...ROOT_DIR_NOTES.map((d) => ({
+        name: `${d.name}/`,
+        note: d.note,
+        children: d.name === REPRO_DIR ? REPRO_NODES : [],
+    })),
+];
+/** The drawing of the paper folder's layout: the rule's message, the hook's refusal, the rule's page. */
+export const PAPER_LAYOUT_TREE = renderTree("<paper>/", PAPER_NODES);
+/** The folder beside the paper folders that holds one corpus of accepted papers per venue. */
+export const VENUES_DIR = "venues";
+/**
+ * The papers directory as the README and `docs/layout.md` draw it: the venues' corpora beside the
+ * paper folders, and each paper folder with its layout. Only the paper folder's part is enforced (by
+ * the two layout rules); `venues/` is drawn so a reader sees where a corpus goes, and no rule reads it.
+ */
+export const PAPERS_NODES = [
+    {
+        name: `${VENUES_DIR}/`,
+        note: "outside every paper folder: one folder per venue",
+        children: [
+            leaf("<venue>/", "that venue's accepted papers, shared by every paper aimed at it"),
+        ],
+    },
+    {
+        name: "<paper>/",
+        note: "one folder per paper, named after the work; its root holds only what is below",
+        children: PAPER_NODES,
+    },
+];
+/** The drawing of the papers directory: the README's and `docs/layout.md`'s map of where things live. */
+export const PAPERS_LAYOUT_TREE = renderTree("<papers-root>/", PAPERS_NODES);
+/**
+ * The one text a stray entry is reported with, by the rule `paper/allowed-files-only` and by the hook that
+ * refuses to create such an entry. It stands alone: where the entry goes, and the whole layout drawn,
+ * for a reader who knows nothing of paperlint.
+ */
+export function strayMessage(s) {
+    return [
+        `\`${s.name}\` is at the root of a paper folder (the folder holding PIPELINE-STATUS.md), and that root holds only paperlint's layout. Where it goes: ${s.cure}.`,
+        `The layout (${ESCAPE_HATCH}/ takes anything and is never judged; the build's paper.* byproducts are never reported):`,
+        PAPER_LAYOUT_TREE,
+        `Rule paper/allowed-files-only: https://github.com/zernie/paperlint/blob/main/docs/rules/paper/allowed-files-only.md`,
+    ].join("\n");
+}
+//# sourceMappingURL=paper-layout.js.map

package/dist/domain/paper-layout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paper-layout.js","sourceRoot":"","sources":["../../src/domain/paper-layout.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,UAAU,EAAiB,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAa3D,MAAM,CAAC,MAAM,gBAAgB,GAAa,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;AAWxD,kDAAkD;AAClD,MAAM,CAAC,MAAM,YAAY,GAAG,OAAO,CAAC;AAQpC,4EAA4E;AAC5E,MAAM,CAAC,MAAM,eAAe,GAAqB;IAC/C;QACE,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,0DAA0D;KACjE;IACD,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,2CAA2C,EAAE;IACxE,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,sBAAsB,EAAE;IACxD,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,mBAAmB,EAAE;IAChD,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,yBAAyB,EAAE;IACtD,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,mBAAmB,EAAE;IAChD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,mDAAmD;KAC1D;IACD;QACE,IAAI,EAAE,qBAAqB;QAC3B,IAAI,EAAE,6CAA6C;KACpD;IACD,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,yCAAyC,EAAE;IACvE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,eAAe,EAAE;CAC7C,CAAC;AAEF,kDAAkD;AAClD,MAAM,CAAC,MAAM,UAAU,GAAsB,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAEhF,6EAA6E;AAC7E,MAAM,CAAC,MAAM,cAAc,GAAqB;IAC9C,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,oCAAoC,EAAE;IAC9D,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,oCAAoC,EAAE;IAChE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,gCAAgC,EAAE;IAC3D,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,+BAA+B,EAAE;IAC3D,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,qCAAqC,EAAE;IACjE,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,2BAA2B,EAAE;IACtD,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,4BAA4B,EAAE;IACvD,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,4BAA4B,EAAE;IACxD,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE;IAC1C;QACE,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,mEAAmE;KAC1E;IACD,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,wBAAwB,EAAE;CACvD,CAAC;AAEF,oDAAoD;AACpD,MAAM,CAAC,MAAM,SAAS,GAAsB,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAE9E;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAsB;IACrD,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;CACP,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,oBAAoB,GAAsB;IAC9C,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,YAAY;IACZ,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,KAAK;IACL,SAAS;IACT,KAAK;IACL,KAAK;IACL,KAAK;IACL,aAAa;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAsB,oBAAoB,CAAC,GAAG,CACzE,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,GAAG,EAAE,CACxB,CAAC;AAEF,kFAAkF;AAClF,MAAM,CAAC,MAAM,QAAQ,GAAsB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AAEtE,qFAAqF;AACrF,MAAM,eAAe,GACnB,mLAAmL,CAAC;AAEtL,sDAAsD;AACtD,MAAM,YAAY,GAChB,sHAAsH,CAAC;AAEzH;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAIlB;IACJ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE;IACxD,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE;IACrD,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,EAAE;IAC7E;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,uDAAuD;KAC9D;IACD;QACE,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,2CAA2C;KAClD;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,oJAAoJ;KAC3J;IACD;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,kHAAkH;KACzH;IACD,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE;IACzD,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE;CACpD,CAAC;AAEF,oEAAoE;AACpE,MAAM,CAAC,MAAM,YAAY,GACvB,iVAAiV,CAAC;AAEpV,MAAM,aAAa,GAAG,CAAC,IAAY,EAAE,QAAkB,EAAW,EAAE,CAClE,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;IACzB,oBAAoB,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC/B,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAEhC,MAAM,SAAS,GAAG,CAAC,CAAc,EAAE,QAAkB,EAAW,EAAE,CAChE,CAAC,CAAC,IAAI,KAAK,KAAK;IACd,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/D,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AAEtC,8FAA8F;AAC9F,SAAS,OAAO,CAAC,CAAc;IAC7B,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAC5B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAC1E,CAAC;IACF,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;AACzD,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,WAAW,CACzB,OAA+B,EAC/B,QAAkB;IAElB,iGAAiG;IACjG,2FAA2F;IAC3F,MAAM,UAAU,GAAG,OAAO;SACvB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;SAC9D,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACjD,OAAO,OAAO;SACX,MAAM,CACL,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,CAAC;QACvB,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CACtD;SACA,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACX,IAAI,EAAE,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;QAC9C,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;KACjB,CAAC,CAAC,CAAC;AACR,CAAC;AAED,4FAA4F;AAC5F,MAAM,CAAC,MAAM,WAAW,GAAwB;IAC9C,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IACnD,IAAI,CACF,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAClD,8CAA8C,CAC/C;IACD,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5B,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,GAAG;QAClB,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,QAAQ,EAAE,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;KAClD,CAAC,CAAC;CACJ,CAAC;AAEF,yGAAyG;AACzG,MAAM,CAAC,MAAM,iBAAiB,GAAW,UAAU,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;AAE7E,8FAA8F;AAC9F,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC;AAEnC;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAwB;IAC/C;QACE,IAAI,EAAE,GAAG,UAAU,GAAG;QACtB,IAAI,EAAE,kDAAkD;QACxD,QAAQ,EAAE;YACR,IAAI,CACF,UAAU,EACV,iEAAiE,CAClE;SACF;KACF;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,+EAA+E;QACrF,QAAQ,EAAE,WAAW;KACtB;CACF,CAAC;AAEF,yGAAyG;AACzG,MAAM,CAAC,MAAM,kBAAkB,GAAW,UAAU,CAClD,gBAAgB,EAChB,YAAY,CACb,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,CAAQ;IACnC,OAAO;QACL,KAAK,CAAC,CAAC,IAAI,4IAA4I,CAAC,CAAC,IAAI,GAAG;QAChK,eAAe,YAAY,2FAA2F;QACtH,iBAAiB;QACjB,qHAAqH;KACtH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC"}

package/dist/domain/repro-layout.d.ts

@@ -0,0 +1,80 @@
+import { type TreeNode } from "./layout-tree.ts";
+/** The folder this layout governs, at the paper folder's root. */
+export declare const REPRO_DIR = "repro";
+/** The index at the top of `repro/`, and the file every study folder holds. */
+export declare const README = "README.md";
+/** The files `repro/` may hold at its top, by exact name. */
+export declare const REPRO_FILE_NOTES: readonly {
+    readonly name: string;
+    readonly note: string;
+}[];
+export declare const REPRO_FILES: readonly string[];
+/** The shared folders `repro/` may hold besides its study folders. */
+export declare const TOOLS_DIR = "tools";
+export declare const DATA_DIR = "data";
+export declare const REPRO_DIR_NOTES: readonly {
+    readonly name: string;
+    readonly note: string;
+}[];
+export declare const REPRO_DIRS: readonly string[];
+/** The layout of `repro/`, entry by entry. */
+export declare const REPRO_NODES: readonly TreeNode[];
+/** The drawing of `repro/`'s layout: the rule's message, the hook's refusal, the rule's page. */
+export declare const REPRO_LAYOUT_TREE: string;
+/**
+ * What interpreters, package managers, test runners and the operating system write into the folder
+ * they run in. Never reported, whether a file or a folder.
+ */
+export declare const REPRO_BYPRODUCTS: readonly string[];
+/** Whether `name` is a study folder's: `<slug>-YYYY-MM-DD` or `<slug>-YYYY-MM`, a real date. */
+export declare function isStudyName(name: string): boolean;
+/**
+ * The study name to suggest for a folder named `name`: its name as a slug, with the date to fill in.
+ * A name that becomes a study name once lowercased and hyphenated is suggested as it is.
+ */
+export declare function suggestedStudyName(name: string): string;
+/** The extensions of a script: what a study or the paper's build runs. */
+export declare const SCRIPT_EXTENSIONS: readonly string[];
+/** Names without a script's extension that still say how the tools run. */
+export declare const TOOL_FILES: readonly string[];
+/** The extensions of data: tables, records, caches, archives, raw output. */
+export declare const DATA_EXTENSIONS: readonly string[];
+/** The extensions of a note. */
+export declare const NOTE_EXTENSIONS: readonly string[];
+/** Where a script goes. */
+export declare const SCRIPT_CURE = "repro/tools/ \u2014 the scripts used across the paper (numbers, figures, the anonymity check, harnesses); a script only one study runs goes in that study's folder instead";
+/** Where data goes. */
+export declare const DATA_CURE = "repro/data/ \u2014 the data shared across the paper (tables, caches); what one study's run produced goes in that study's folder instead";
+/** Where a note goes. */
+export declare const NOTE_CURE = "the dated folder of the study it is about (repro/<slug>-YYYY-MM-DD/), or the paper's research/ when it is research or a decision rather than the record of a run";
+/** Where a file of any other kind goes. */
+export declare const FILE_CURE_BY_KIND = "decide by what it is \u2014 a script \u2192 repro/tools/; data \u2192 repro/data/; a note \u2192 the dated folder of its study, or the paper's research/; what one study produced \u2192 that study's folder";
+/** The files paperlint itself once kept at the top of `repro/`, each with where it is read now. */
+export declare const MOVED_FILES: readonly {
+    readonly name: string;
+    readonly cure: string;
+}[];
+/** An entry at the top of `repro/`: a file or a folder, and for a folder whether it holds a README.md. */
+export interface ReproEntry {
+    readonly name: string;
+    readonly kind: "file" | "dir";
+    readonly hasReadme: boolean;
+}
+/** What is wrong with an entry at the top of `repro/`. */
+export interface ReproFinding {
+    /** The entry's path from the paper folder; a folder's ends in a slash. */
+    readonly path: string;
+    /** `stray`: not part of the layout. `no-readme`: a study folder without its README.md. */
+    readonly problem: "stray" | "no-readme";
+    /** Where it goes, or what to add. */
+    readonly cure: string;
+}
+/** The entries at the top of `repro/` that are out of place, at most one finding each, in order. Pure. */
+export declare function judgeRepro(entries: readonly ReproEntry[]): readonly ReproFinding[];
+/**
+ * The one text a finding is reported with, by the rule `repro/allowed-files-only` and by the hook that fires
+ * when such an entry is written. It stands alone: what is wrong, where the entry goes, and what
+ * `repro/` holds, for a reader who knows nothing of paperlint.
+ */
+export declare function reproMessage(f: ReproFinding): string;
+//# sourceMappingURL=repro-layout.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"repro-layout.d.ts","sourceRoot":"","sources":["../../src/domain/repro-layout.ts"],"names":[],"mappings":"AA6BA,OAAO,EAAoB,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEnE,kEAAkE;AAClE,eAAO,MAAM,SAAS,UAAU,CAAC;AAEjC,+EAA+E;AAC/E,eAAO,MAAM,MAAM,cAAc,CAAC;AAElC,6DAA6D;AAC7D,eAAO,MAAM,gBAAgB,EAAE,SAAS;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,EAGA,CAAC;AACF,eAAO,MAAM,WAAW,EAAE,SAAS,MAAM,EAExC,CAAC;AAEF,sEAAsE;AACtE,eAAO,MAAM,SAAS,UAAU,CAAC;AACjC,eAAO,MAAM,QAAQ,SAAS,CAAC;AAC/B,eAAO,MAAM,eAAe,EAAE,SAAS;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,EAMA,CAAC;AACF,eAAO,MAAM,UAAU,EAAE,SAAS,MAAM,EAAuC,CAAC;AAWhF,8CAA8C;AAC9C,eAAO,MAAM,WAAW,EAAE,SAAS,QAAQ,EAI1C,CAAC;AAEF,iGAAiG;AACjG,eAAO,MAAM,iBAAiB,EAAE,MAG/B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAU7C,CAAC;AAYF,gGAAgG;AAChG,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAOjD;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQvD;AAED,0EAA0E;AAC1E,eAAO,MAAM,iBAAiB,EAAE,SAAS,MAAM,EAkB9C,CAAC;AAEF,2EAA2E;AAC3E,eAAO,MAAM,UAAU,EAAE,SAAS,MAAM,EAQvC,CAAC;AAEF,6EAA6E;AAC7E,eAAO,MAAM,eAAe,EAAE,SAAS,MAAM,EAqB5C,CAAC;AAEF,gCAAgC;AAChC,eAAO,MAAM,eAAe,EAAE,SAAS,MAAM,EAAyB,CAAC;AAEvE,2BAA2B;AAC3B,eAAO,MAAM,WAAW,+KACiJ,CAAC;AAE1K,uBAAuB;AACvB,eAAO,MAAM,SAAS,4IACgH,CAAC;AAEvI,yBAAyB;AACzB,eAAO,MAAM,SAAS,qKAC8I,CAAC;AAErK,2CAA2C;AAC3C,eAAO,MAAM,iBAAiB,iNACyJ,CAAC;AAExL,mGAAmG;AACnG,eAAO,MAAM,WAAW,EAAE,SAAS;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,EAaA,CAAC;AAkBF,0GAA0G;AAC1G,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IAC9B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC7B;AAED,0DAA0D;AAC1D,MAAM,WAAW,YAAY;IAC3B,0EAA0E;IAC1E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0FAA0F;IAC1F,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAAC;IACxC,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AA0BD,0GAA0G;AAC1G,wBAAgB,UAAU,CACxB,OAAO,EAAE,SAAS,UAAU,EAAE,GAC7B,SAAS,YAAY,EAAE,CAEzB;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,YAAY,GAAG,MAAM,CAWpD"}

package/dist/domain/repro-layout.js

@@ -0,0 +1,247 @@
+/**
+ * THE LAYOUT OF A PAPER'S `repro/` — what may stand at its top, and nothing else.
+ *
+ * `repro/` is where a paper's evidence lives, and it fills up the way a desk does: one real paper had
+ * 120 entries at its top, about 70 study folders (some with no date) and about 50 loose scripts, data
+ * files and notes. Nobody could say which script produces which number, which study is current, or
+ * where a new run goes. The layout gives each kind of material one place:
+ *
+ *   repro/
+ *   ├── README.md              the index: one line per study
+ *   ├── <slug>-YYYY-MM-DD/     one folder per study or spike, with a README.md inside
+ *   ├── tools/                 scripts used across the paper (numbers, figures, anonymity check, harnesses)
+ *   └── data/                  shared data (tables, caches)
+ *
+ * plus `.gitignore`. A loose note belongs in its study's folder or in the paper's `research/`.
+ *
+ * ── THE DATE IN A STUDY'S NAME ────────────────────────────────────────────────────
+ * `<slug>-YYYY-MM-DD` is the day the study began. `<slug>-YYYY-MM` is accepted too: a study that ran
+ * over weeks (labelling, a reading of a corpus) has a month as its honest date, and both forms sort
+ * by time. The date must be a real one (no month 13, no 30 February). The slug is lowercase letters
+ * and digits in words joined by single hyphens.
+ *
+ * ── NEVER REPORTED ───────────────────────────────────────────────────────────────
+ * What interpreters, package managers and the operating system leave in any folder they run in
+ * (`__pycache__/`, `node_modules/`, `.DS_Store`, …): the scripts' byproducts, not the author's.
+ *
+ * Pure: the caller lists the folder and says which study folders hold a `README.md`.
+ */
+import { extname } from "node:path";
+import { leaf, renderTree } from "./layout-tree.js";
+/** The folder this layout governs, at the paper folder's root. */
+export const REPRO_DIR = "repro";
+/** The index at the top of `repro/`, and the file every study folder holds. */
+export const README = "README.md";
+/** The files `repro/` may hold at its top, by exact name. */
+export const REPRO_FILE_NOTES = [
+    { name: README, note: "the index: one line per study" },
+    { name: ".gitignore", note: "keeps the scripts' byproducts out of git" },
+];
+export const REPRO_FILES = REPRO_FILE_NOTES.map((f) => f.name);
+/** The shared folders `repro/` may hold besides its study folders. */
+export const TOOLS_DIR = "tools";
+export const DATA_DIR = "data";
+export const REPRO_DIR_NOTES = [
+    {
+        name: TOOLS_DIR,
+        note: "scripts used across the paper (numbers, figures, anonymity check, harnesses)",
+    },
+    { name: DATA_DIR, note: "shared data (tables, caches)" },
+];
+export const REPRO_DIRS = REPRO_DIR_NOTES.map((d) => d.name);
+/** The study folder as the layout draws it: the name pattern, and the README.md it must hold. */
+const STUDY_NODE = {
+    name: "<slug>-YYYY-MM-DD/",
+    note: "one folder per study or spike (<slug>-YYYY-MM for one that ran over weeks)",
+    children: [
+        leaf(README, "required: what it asks, how to run it, what it found"),
+    ],
+};
+/** The layout of `repro/`, entry by entry. */
+export const REPRO_NODES = [
+    ...REPRO_FILE_NOTES.map((f) => leaf(f.name, f.note)),
+    ...REPRO_DIR_NOTES.map((d) => leaf(`${d.name}/`, d.note)),
+    STUDY_NODE,
+];
+/** The drawing of `repro/`'s layout: the rule's message, the hook's refusal, the rule's page. */
+export const REPRO_LAYOUT_TREE = renderTree(`${REPRO_DIR}/`, REPRO_NODES);
+/**
+ * What interpreters, package managers, test runners and the operating system write into the folder
+ * they run in. Never reported, whether a file or a folder.
+ */
+export const REPRO_BYPRODUCTS = [
+    "__pycache__",
+    ".pytest_cache",
+    ".mypy_cache",
+    ".ruff_cache",
+    ".ipynb_checkpoints",
+    "node_modules",
+    ".venv",
+    ".DS_Store",
+    "Thumbs.db",
+];
+/** A study's name: a slug, then the year, the month, and optionally the day it began. */
+const STUDY_NAME = /^([a-z0-9]+(?:-[a-z0-9]+)*)-(\d{4})-(\d{2})(?:-(\d{2}))?$/u;
+const isLeapYear = (y) => (y % 4 === 0 && y % 100 !== 0) || y % 400 === 0;
+/** The days in month `m` (1–12) of year `y`. */
+const daysIn = (y, m) => m === 2 ? (isLeapYear(y) ? 29 : 28) : [4, 6, 9, 11].includes(m) ? 30 : 31;
+/** Whether `name` is a study folder's: `<slug>-YYYY-MM-DD` or `<slug>-YYYY-MM`, a real date. */
+export function isStudyName(name) {
+    const m = STUDY_NAME.exec(name);
+    if (m === null)
+        return false;
+    const year = Number(m[2]);
+    const month = Number(m[3]);
+    const day = m[4] === undefined ? 1 : Number(m[4]);
+    return month >= 1 && month <= 12 && day >= 1 && day <= daysIn(year, month);
+}
+/**
+ * The study name to suggest for a folder named `name`: its name as a slug, with the date to fill in.
+ * A name that becomes a study name once lowercased and hyphenated is suggested as it is.
+ */
+export function suggestedStudyName(name) {
+    const slug = name
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/gu, "-")
+        .replace(/^-+|-+$/gu, "");
+    if (isStudyName(slug))
+        return slug;
+    const base = slug.replace(/(?:^|-)\d{4}(?:-\d{1,2}){0,2}$/u, "");
+    return `${base === "" ? "<slug>" : base}-YYYY-MM-DD`;
+}
+/** The extensions of a script: what a study or the paper's build runs. */
+export const SCRIPT_EXTENSIONS = [
+    ".py",
+    ".ipynb",
+    ".sh",
+    ".bash",
+    ".zsh",
+    ".js",
+    ".mjs",
+    ".cjs",
+    ".ts",
+    ".mts",
+    ".cts",
+    ".r",
+    ".jl",
+    ".rb",
+    ".pl",
+    ".awk",
+    ".sql",
+];
+/** Names without a script's extension that still say how the tools run. */
+export const TOOL_FILES = [
+    "Makefile",
+    "Dockerfile",
+    "requirements.txt",
+    "pyproject.toml",
+    "uv.lock",
+    "package.json",
+    "package-lock.json",
+];
+/** The extensions of data: tables, records, caches, archives, raw output. */
+export const DATA_EXTENSIONS = [
+    ".tsv",
+    ".csv",
+    ".json",
+    ".jsonl",
+    ".ndjson",
+    ".yaml",
+    ".yml",
+    ".xml",
+    ".txt",
+    ".log",
+    ".parquet",
+    ".sqlite",
+    ".db",
+    ".xlsx",
+    ".npy",
+    ".npz",
+    ".pkl",
+    ".gz",
+    ".zip",
+    ".tar",
+];
+/** The extensions of a note. */
+export const NOTE_EXTENSIONS = [".md", ".markdown"];
+/** Where a script goes. */
+export const SCRIPT_CURE = "repro/tools/ — the scripts used across the paper (numbers, figures, the anonymity check, harnesses); a script only one study runs goes in that study's folder instead";
+/** Where data goes. */
+export const DATA_CURE = "repro/data/ — the data shared across the paper (tables, caches); what one study's run produced goes in that study's folder instead";
+/** Where a note goes. */
+export const NOTE_CURE = "the dated folder of the study it is about (repro/<slug>-YYYY-MM-DD/), or the paper's research/ when it is research or a decision rather than the record of a run";
+/** Where a file of any other kind goes. */
+export const FILE_CURE_BY_KIND = "decide by what it is — a script → repro/tools/; data → repro/data/; a note → the dated folder of its study, or the paper's research/; what one study produced → that study's folder";
+/** The files paperlint itself once kept at the top of `repro/`, each with where it is read now. */
+export const MOVED_FILES = [
+    {
+        name: "references-cache.json",
+        cure: "repro/data/references-cache.json, where `paperlint build` reads and writes the citation services' answers (`git mv repro/references-cache.json repro/data/`); until it is moved, the next build asks every service again",
+    },
+    {
+        name: "refs-cache.json",
+        cure: "repro/data/refs-cache.json, where the paper-pipeline's extract-ref-facts script keeps its raw answers (`git mv repro/refs-cache.json repro/data/`)",
+    },
+    {
+        name: "generated-code-grandfathered.txt",
+        cure: "repro/tools/generated-code-grandfathered.txt, where the paper-pipeline's generated-code check reads it (`git mv repro/generated-code-grandfathered.txt repro/tools/`)",
+    },
+];
+/** Where a stray file goes: a file paperlint moved, else by the kind its name says. */
+function fileCure(name) {
+    const moved = MOVED_FILES.find((f) => f.name === name);
+    if (moved !== undefined)
+        return moved.cure;
+    const ext = extname(name).toLowerCase();
+    if (TOOL_FILES.includes(name) || SCRIPT_EXTENSIONS.includes(ext))
+        return SCRIPT_CURE;
+    if (DATA_EXTENSIONS.includes(ext))
+        return DATA_CURE;
+    if (NOTE_EXTENSIONS.includes(ext))
+        return NOTE_CURE;
+    return FILE_CURE_BY_KIND;
+}
+/** Where a folder with no study name goes: renamed as a study, or emptied into the shared folders. */
+const folderCure = (name) => `rename it to \`${suggestedStudyName(name)}\`, one folder per study or spike, named for what it is and the date it began — the date of its first commit is a fine default (\`git log --reverse --format=%as -- repro/${name} | head -1\`, run in the paper folder) — and give it a README.md; if it holds scripts or data shared across the paper instead, move them into repro/tools/ or repro/data/`;
+const isAllowed = (e) => REPRO_BYPRODUCTS.includes(e.name) ||
+    (e.kind === "file"
+        ? REPRO_FILES.includes(e.name)
+        : REPRO_DIRS.includes(e.name) || isStudyName(e.name));
+/** The one finding for `e`, or null when it is in its place. */
+function judgeEntry(e) {
+    const path = `${REPRO_DIR}/${e.name}${e.kind === "dir" ? "/" : ""}`;
+    if (!isAllowed(e))
+        return {
+            path,
+            problem: "stray",
+            cure: e.kind === "dir" ? folderCure(e.name) : fileCure(e.name),
+        };
+    if (e.kind === "dir" && isStudyName(e.name) && !e.hasReadme)
+        return {
+            path,
+            problem: "no-readme",
+            cure: `add ${path}${README} — what the study asks, how to run it, what it found — and a line for it in repro/${README}`,
+        };
+    return null;
+}
+/** The entries at the top of `repro/` that are out of place, at most one finding each, in order. Pure. */
+export function judgeRepro(entries) {
+    return entries.map(judgeEntry).filter((f) => f !== null);
+}
+/**
+ * The one text a finding is reported with, by the rule `repro/allowed-files-only` and by the hook that fires
+ * when such an entry is written. It stands alone: what is wrong, where the entry goes, and what
+ * `repro/` holds, for a reader who knows nothing of paperlint.
+ */
+export function reproMessage(f) {
+    const head = f.problem === "stray"
+        ? `\`${f.path}\` is loose at the top of the paper's repro/ folder, which holds only an index, the shared tools and data, and one dated folder per study. Where it goes: ${f.cure}.`
+        : `\`${f.path}\` is a study folder without a ${README}, and every study in repro/ has one. What to do: ${f.cure}.`;
+    return [
+        head,
+        "What repro/ holds (what interpreters and package managers leave there, like __pycache__/ and node_modules/, is never reported):",
+        REPRO_LAYOUT_TREE,
+        `Rule repro/allowed-files-only: https://github.com/zernie/paperlint/blob/main/docs/rules/repro/allowed-files-only.md`,
+    ].join("\n");
+}
+//# sourceMappingURL=repro-layout.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"repro-layout.js","sourceRoot":"","sources":["../../src/domain/repro-layout.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAiB,MAAM,kBAAkB,CAAC;AAEnE,kEAAkE;AAClE,MAAM,CAAC,MAAM,SAAS,GAAG,OAAO,CAAC;AAEjC,+EAA+E;AAC/E,MAAM,CAAC,MAAM,MAAM,GAAG,WAAW,CAAC;AAElC,6DAA6D;AAC7D,MAAM,CAAC,MAAM,gBAAgB,GAGvB;IACJ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,EAAE;IACvD,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,0CAA0C,EAAE;CACzE,CAAC;AACF,MAAM,CAAC,MAAM,WAAW,GAAsB,gBAAgB,CAAC,GAAG,CAChE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CACd,CAAC;AAEF,sEAAsE;AACtE,MAAM,CAAC,MAAM,SAAS,GAAG,OAAO,CAAC;AACjC,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC;AAC/B,MAAM,CAAC,MAAM,eAAe,GAGtB;IACJ;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,8EAA8E;KACrF;IACD,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,8BAA8B,EAAE;CACzD,CAAC;AACF,MAAM,CAAC,MAAM,UAAU,GAAsB,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAEhF,iGAAiG;AACjG,MAAM,UAAU,GAAa;IAC3B,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,4EAA4E;IAClF,QAAQ,EAAE;QACR,IAAI,CAAC,MAAM,EAAE,sDAAsD,CAAC;KACrE;CACF,CAAC;AAEF,8CAA8C;AAC9C,MAAM,CAAC,MAAM,WAAW,GAAwB;IAC9C,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IACpD,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;IACzD,UAAU;CACX,CAAC;AAEF,iGAAiG;AACjG,MAAM,CAAC,MAAM,iBAAiB,GAAW,UAAU,CACjD,GAAG,SAAS,GAAG,EACf,WAAW,CACZ,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAsB;IACjD,aAAa;IACb,eAAe;IACf,aAAa;IACb,aAAa;IACb,oBAAoB;IACpB,cAAc;IACd,OAAO;IACP,WAAW;IACX,WAAW;CACZ,CAAC;AAEF,yFAAyF;AACzF,MAAM,UAAU,GAAG,4DAA4D,CAAC;AAEhF,MAAM,UAAU,GAAG,CAAC,CAAS,EAAW,EAAE,CACxC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC;AAElD,gDAAgD;AAChD,MAAM,MAAM,GAAG,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE,CAC9C,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AAE5E,gGAAgG;AAChG,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3B,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,OAAO,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC7E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,MAAM,IAAI,GAAG,IAAI;SACd,WAAW,EAAE;SACb,OAAO,CAAC,cAAc,EAAE,GAAG,CAAC;SAC5B,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAC5B,IAAI,WAAW,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACnC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,iCAAiC,EAAE,EAAE,CAAC,CAAC;IACjE,OAAO,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC;AACvD,CAAC;AAED,0EAA0E;AAC1E,MAAM,CAAC,MAAM,iBAAiB,GAAsB;IAClD,KAAK;IACL,QAAQ;IACR,KAAK;IACL,OAAO;IACP,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;IACN,IAAI;IACJ,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;CACP,CAAC;AAEF,2EAA2E;AAC3E,MAAM,CAAC,MAAM,UAAU,GAAsB;IAC3C,UAAU;IACV,YAAY;IACZ,kBAAkB;IAClB,gBAAgB;IAChB,SAAS;IACT,cAAc;IACd,mBAAmB;CACpB,CAAC;AAEF,6EAA6E;AAC7E,MAAM,CAAC,MAAM,eAAe,GAAsB;IAChD,MAAM;IACN,MAAM;IACN,OAAO;IACP,QAAQ;IACR,SAAS;IACT,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,UAAU;IACV,SAAS;IACT,KAAK;IACL,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;CACP,CAAC;AAEF,gCAAgC;AAChC,MAAM,CAAC,MAAM,eAAe,GAAsB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;AAEvE,2BAA2B;AAC3B,MAAM,CAAC,MAAM,WAAW,GACtB,uKAAuK,CAAC;AAE1K,uBAAuB;AACvB,MAAM,CAAC,MAAM,SAAS,GACpB,oIAAoI,CAAC;AAEvI,yBAAyB;AACzB,MAAM,CAAC,MAAM,SAAS,GACpB,kKAAkK,CAAC;AAErK,2CAA2C;AAC3C,MAAM,CAAC,MAAM,iBAAiB,GAC5B,qLAAqL,CAAC;AAExL,mGAAmG;AACnG,MAAM,CAAC,MAAM,WAAW,GAGlB;IACJ;QACE,IAAI,EAAE,uBAAuB;QAC7B,IAAI,EAAE,0NAA0N;KACjO;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,oJAAoJ;KAC3J;IACD;QACE,IAAI,EAAE,kCAAkC;QACxC,IAAI,EAAE,uKAAuK;KAC9K;CACF,CAAC;AAEF,uFAAuF;AACvF,SAAS,QAAQ,CAAC,IAAY;IAC5B,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACvD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC;IAC3C,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;IACxC,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC;QAC9D,OAAO,WAAW,CAAC;IACrB,IAAI,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACpD,IAAI,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IACpD,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED,sGAAsG;AACtG,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE,CAC1C,kBAAkB,kBAAkB,CAAC,IAAI,CAAC,6KAA6K,IAAI,2KAA2K,CAAC;AAmBzY,MAAM,SAAS,GAAG,CAAC,CAAa,EAAW,EAAE,CAC3C,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IACjC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM;QAChB,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9B,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AAE1D,gEAAgE;AAChE,SAAS,UAAU,CAAC,CAAa;IAC/B,MAAM,IAAI,GAAG,GAAG,SAAS,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACpE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QACf,OAAO;YACL,IAAI;YACJ,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;SAC/D,CAAC;IACJ,IAAI,CAAC,CAAC,IAAI,KAAK,KAAK,IAAI,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QACzD,OAAO;YACL,IAAI;YACJ,OAAO,EAAE,WAAW;YACpB,IAAI,EAAE,OAAO,IAAI,GAAG,MAAM,qFAAqF,MAAM,EAAE;SACxH,CAAC;IACJ,OAAO,IAAI,CAAC;AACd,CAAC;AAED,0GAA0G;AAC1G,MAAM,UAAU,UAAU,CACxB,OAA8B;IAE9B,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAqB,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;AAC9E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,CAAe;IAC1C,MAAM,IAAI,GACR,CAAC,CAAC,OAAO,KAAK,OAAO;QACnB,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,6JAA6J,CAAC,CAAC,IAAI,GAAG;QACnL,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,kCAAkC,MAAM,oDAAoD,CAAC,CAAC,IAAI,GAAG,CAAC;IACvH,OAAO;QACL,IAAI;QACJ,iIAAiI;QACjI,iBAAiB;QACjB,qHAAqH;KACtH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC"}

package/dist/domain/scaffold-layout.d.ts

@@ -0,0 +1,28 @@
+/** The placeholder git needs to keep an otherwise empty folder. */
+export declare const GITKEEP = ".gitkeep";
+/**
+ * The folders of the layout that `paperlint new` does not create, each with why. A folder here is
+ * allowed at the root all the same; it appears when the work needs it.
+ */
+export declare const NOT_SCAFFOLDED: readonly {
+    readonly name: string;
+    readonly why: string;
+}[];
+/** The folders at the paper's root that a new paper holds from the first commit, in layout order. */
+export declare const SCAFFOLD_DIRS: readonly string[];
+/**
+ * The stub index of `repro/`: it makes the folder non-empty (no `.gitkeep`) and says what the rule
+ * asks of it. A line per study is added when the first study is.
+ */
+export declare const REPRO_INDEX_STUB = "# Reproduction index\n\nOne line per study: `<slug>-YYYY-MM-DD/` \u2014 what it asks and what it found. Scripts used across the\npaper go in `tools/`, shared data in `data/`.\n";
+/** A file `paperlint new` writes into a new paper folder, with its path from that folder. */
+export interface ScaffoldFile {
+    readonly path: string;
+    readonly text: string;
+}
+/**
+ * Every file of the layout scaffold, relative to the paper folder, in a fixed order: a `.gitkeep` in
+ * each empty folder, and `repro/README.md` where `repro/` would otherwise hold only folders.
+ */
+export declare const SCAFFOLD_FILES: readonly ScaffoldFile[];
+//# sourceMappingURL=scaffold-layout.d.ts.map

package/dist/domain/scaffold-layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold-layout.d.ts","sourceRoot":"","sources":["../../src/domain/scaffold-layout.ts"],"names":[],"mappings":"AAiCA,mEAAmE;AACnE,eAAO,MAAM,OAAO,aAAa,CAAC;AAElC;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,SAAS;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB,EAqBA,CAAC;AAEF,qGAAqG;AACrG,eAAO,MAAM,aAAa,EAAE,SAAS,MAAM,EAEqB,CAAC;AAEjE;;;GAGG;AACH,eAAO,MAAM,gBAAgB,qLAI5B,CAAC;AAEF,6FAA6F;AAC7F,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,SAAS,YAAY,EAYjD,CAAC"}