paperlint 2.0.0

package/src/types.ts

@@ -0,0 +1,106 @@
+import type { RuleBlock } from "./rules-config.ts";
+
+/**
+ * The shapes the CLI commands exchange. Before the move to TypeScript this was all `{}` and lived
+ * in someone's head: a typo in a config key read as "field not set", not as an error.
+ */
+
+/** The contents of the consumer's `rpp.json`. */
+export interface RppConfig {
+  /** 🔴 REQUIRED. The paper director(ies), relative to the config file ITSELF. The field name is
+   * `PAPERS_DIR_FIELD` in lib/paper-config.mjs; code reads it through `papersDirOf()` in cli.ts. */
+  papersDir?: string | string[];
+  /** The command that prints the author list from .bib — each corpus has its own. */
+  authorListCommand?: string;
+  /** Per-paper typography debt: how many findings already exist; the number may only go down. */
+  typographyDebt?: Record<string, Record<string, number>>;
+  /** Frontmatter fields required for review notes, and the permitted values of each. */
+  docFields?: Record<string, { values: string[] }>;
+  /** Ignore review findings older than this date. */
+  reviewSince?: string;
+  /** How many findings a cold read must produce to count as a cold read. */
+  minFindings?: number;
+  /** The word with which review notes introduce the cause. */
+  causeMarker?: string;
+  /** Which files a paper directory must carry; `false` turns the check off entirely. */
+  structure?: StructureConfig | false;
+  /** REMOVED — `paperlint build` compiles the paper itself. Still typed so a leftover key can be named. */
+  buildScripts?: unknown;
+  /** ESLint config blocks appended after rpp's own — PARSED by `parseSettings` in cli.ts. */
+  rules?: readonly RuleBlock[];
+}
+
+export interface StructureConfig {
+  /** These files are what IDENTIFY a directory as a paper. Detection is generous. */
+  markers?: string[];
+  /** These files must exist. The requirements are strict. */
+  require?: string[];
+  /** At least one from each group. */
+  requireOneOf?: string[][];
+  /** Directories exempted from the check by name. */
+  ignore?: string[];
+}
+
+/** The parsed command line. */
+export interface Args {
+  cmd: string | null;
+  paths: string[];
+  config: string | null;
+  json: boolean;
+  all: boolean;
+  dryRun: boolean;
+  /** `--check`: `toolchain` reports what is missing and changes nothing. */
+  check: boolean;
+  maxWarnings: number;
+  /** `--yes` / `-y`: take every default, ask nothing. */
+  yes: boolean;
+  /** `--no-hooks`: `init` does not touch `.claude/settings.json`. */
+  noHooks: boolean;
+  /** `--paper <name>`: `init` creates this paper. */
+  paper: string | null;
+  /** `--format tex|md` for `new` and `init --paper`. Validated by the command, not here. */
+  format: string | null;
+  /** `--hooks=<mode>` — parsed only so it can be REFUSED by name rather than read as a path. */
+  hooksMode: string | null;
+  help?: boolean;
+  /** A flag that turned out to have no value. A non-empty field is a REFUSAL, not a default. */
+  missingValue?: string;
+}
+
+/** A finding about the PRESENCE of a file — what an ESLint rule cannot express. */
+export interface StructureFinding {
+  file: string;
+  message: string;
+}
+
+/** One line of a build plan: a step, whether it applies to this paper, and why. */
+export interface PlanLine {
+  step: string;
+  applies: boolean;
+  /** A required step that does not apply refuses the build instead of being skipped. */
+  required: boolean;
+  why: string;
+}
+
+/**
+ * The build outcome for one paper. `no-source` — there is no `paper.tex` to compile — is a
+ * REFUSAL, not a skip: "nothing to build" and "built" must never look alike.
+ */
+export interface BuildResult {
+  dir: string;
+  status: "built" | "failed" | "no-source";
+  plan: PlanLine[];
+  /** `--dry-run`: the plan was printed and nothing ran. */
+  dry?: boolean;
+  /** The step that failed and what to show for it. */
+  failure?: { step: string; lines: string[] };
+  /** What the steps reported on success: pass counts, undefined-reference warnings. */
+  notes?: string[];
+  /** A paper.pdf from an earlier run was on disk and `buildPapers` removed it before building. */
+  staleRemoved?: boolean;
+}
+
+/** The result of reading the config: either data, or the exit code the caller exits with. */
+export type ConfigRead =
+  | { opts: RppConfig; configPath: string | null; code?: undefined }
+  | { code: number; opts?: undefined; configPath?: undefined };

package/templates/paper/PIPELINE-STATUS.md

@@ -0,0 +1,72 @@
+---
+# Created by `paperlint new` — from <papers>/.template/ when the project keeps one, else from the package.
+#
+# researchQuestion — the paper's question, one sentence, written the way it appears in the paper.
+# `paper/research-question` reads it once the paper has shipped a stage. Empty until you have it.
+researchQuestion: ""
+#
+# There is no `stages` field yet, on purpose: a new paper has shipped nothing and owes nothing.
+# When it reaches a stage, add the record — its shape is in docs/rules.md of the package.
+---
+
+# PIPELINE-STATUS — {{name}}
+
+Venue: <venue> · Deadline: <ISO date, AoE converted to the author's own zone> · Blind: <double/single> · State: <drafting/submitted #N/accepted>
+Updated: <ISO>
+
+**Readiness verdict:** <one line — submit-ready? if not, the WORST failing gate first. Any failing
+gate caps "ready"; an accept probability alone is not a verdict.>
+
+**Gates at a glance (worst first — mark any failing gate ✗):** readability(persona stalls) <density/verdict> · structure(tighten-paper) <verdict> · claims-honest(claims) <clean?> · defects(panel) <accept-prob/decision> · writing <NN/60> · content(venue bar) <run?/levers>
+
+### SETUP
+
+| id         | Work                              | Skill                 | Status | Date | Result                                                                                            | Open      |
+| ---------- | --------------------------------- | --------------------- | ------ | ---- | ------------------------------------------------------------------------------------------------- | --------- |
+| idea       | Validate idea                     | research-ideate       | ☐      | —    | —                                                                                                 | —         |
+| priorwork  | Map competitors                   | map-prior-work        | ☐      | —    | —                                                                                                 | siblings/ |
+| venue      | Pick venue                        | find-venue            | ☐      | —    | —                                                                                                 | —         |
+| venuebar   | Venue bar / levers                | study-accepted-papers | ☐      | —    | —                                                                                                 | —         |
+| **access** | 🔴 **Can you physically submit?** | plan-paper-timeline   | ☐      | —    | account · profile ACTIVE since <ISO> · portal reachable · form fields known · artifact host known | —         |
+| schedule   | Schedule + calendar               | plan-paper-timeline   | ☐      | —    | —                                                                                                 | —         |
+| **frame**  | **Claim stated before the runs**  | argument-arc (frame)  | ☐      | —    | one paragraph: what will this paper claim?                                                        | —         |
+
+### LOOP
+
+| id    | Work             | Skill           | Status | Date | Result | Open |
+| ----- | ---------------- | --------------- | ------ | ---- | ------ | ---- |
+| study | Study + artifact | build-benchmark | ☐      | —    | —      | —    |
+| draft | Draft            | draft-paper     | ☐      | —    | —      | —    |
+| arc   | Argument arc     | argument-arc    | ☐      | —    | —      | —    |
+
+### CONTINUOUS
+
+Date = when it last ran. If that predates the current text, the pass is stale — the checker says so.
+
+| id         | Trigger               | Skill                     | Status | Date | Result                | Open      |
+| ---------- | --------------------- | ------------------------- | ------ | ---- | --------------------- | --------- |
+| cites      | any \cite added/moved | verify-citations          | ☐      | —    | —                     | —         |
+| siblings   | a sibling surfaces    | analyze-sibling-paper     | ☐      | —    | —                     | siblings/ |
+| priordelta | framing moved         | map-prior-work (delta)    | ☐      | —    | —                     | —         |
+| render     | any source edit       | render-paper + page count | ☐      | —    | <N> pages / limit <M> | —         |
+
+### GATES
+
+| id        | Gate               | Skill               | Requires                                     | Status | Date | Result | Open |
+| --------- | ------------------ | ------------------- | -------------------------------------------- | ------ | ---- | ------ | ---- |
+| structure | Structure          | tighten-paper       | render, arc                                  | ☐      | —    | —      | —    |
+| writing   | Writing craft      | grade-paper-writing | draft, arc, structure                        | ☐      | —    | —      | —    |
+| panel     | Review decision    | pc-panel-review     | structure, writing                           | ☐      | —    | —      | —    |
+| claims    | Claim preservation | Fable diff          | draft, writing                               | ☐      | —    | —      | —    |
+| harden    | Harden (all axes)  | harden-paper        | panel, structure, writing, cites, priordelta | ☐      | —    | —      | —    |
+| submit    | Submit             | submit-paper        | harden, access                               | ☐      | —    | —      | —    |
+
+**Harden sub-axes** (`harden` is an orchestrator — track its axes so `◐` is legible):
+structure(=structure) ☐ · threat-model ☐ · ethics/dual-use ☐ · page/word-fit ☐ · de-anon hygiene ☐ · citability ☐ · artifact-runs-clean ☐ · writing(=writing) ☐
+
+### AFTER
+
+| id          | Work         | Skill        | Status | Date | Result          | Open |
+| ----------- | ------------ | ------------ | ------ | ---- | --------------- | ---- |
+| cameraready | Camera-ready | camera-ready | n/a    | —    | pre-acceptance  | —    |
+| extend      | Extend       | extend-paper | n/a    | —    | post-acceptance | —    |

package/templates/paper/paper.md

@@ -0,0 +1,4 @@
+# Working title for {{name}}
+
+Created by `paperlint new`. A stub: replace all of it. The only thing `paperlint lint` needs is that this file
+exists. New papers are written in `paper.tex`, which `paperlint build` compiles.

package/templates/paper/paper.tex

@@ -0,0 +1,8 @@
+% Created by `paperlint new`. A stub: replace all of it. The only thing `paperlint lint` needs is that
+% this file exists; the document class is yours. `paperlint build` compiles it to paper.pdf.
+\documentclass{article}
+\title{Working title for {{name}}}
+\begin{document}
+\maketitle
+Write the paper here.
+\end{document}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "ES2023",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "lib": ["ES2023"],
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": false,
+    "skipLibCheck": true,
+    "verbatimModuleSyntax": false,
+    "types": ["node"],
+    "allowImportingTsExtensions": true,
+    "rewriteRelativeImportExtensions": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.test.ts"]
+}