paperlint 10.3.0 → 10.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/ci.yml +15 -4
- package/README.md +1 -0
- package/dist/CLAUDE.md.spec.d.ts.map +1 -1
- package/dist/CLAUDE.md.spec.js +6 -3
- package/dist/CLAUDE.md.spec.js.map +1 -1
- package/dist/adapters/git/index.d.ts +10 -0
- package/dist/adapters/git/index.d.ts.map +1 -0
- package/dist/adapters/git/index.js +151 -0
- package/dist/adapters/git/index.js.map +1 -0
- package/dist/adapters/latex/captions.d.ts +9 -0
- package/dist/adapters/latex/captions.d.ts.map +1 -0
- package/dist/adapters/latex/captions.js +40 -0
- package/dist/adapters/latex/captions.js.map +1 -0
- package/dist/adapters/latex/index.d.ts +1 -0
- package/dist/adapters/latex/index.d.ts.map +1 -1
- package/dist/adapters/latex/index.js +1 -0
- package/dist/adapters/latex/index.js.map +1 -1
- package/dist/adapters/latex/parse.d.ts.map +1 -1
- package/dist/adapters/latex/parse.js +6 -0
- package/dist/adapters/latex/parse.js.map +1 -1
- package/dist/adapters/memory/index.d.ts +6 -0
- package/dist/adapters/memory/index.d.ts.map +1 -1
- package/dist/adapters/memory/index.js +8 -0
- package/dist/adapters/memory/index.js.map +1 -1
- package/dist/adapters/node/index.d.ts +1 -0
- package/dist/adapters/node/index.d.ts.map +1 -1
- package/dist/adapters/node/index.js +1 -0
- package/dist/adapters/node/index.js.map +1 -1
- package/dist/adapters/node/list-entries.io.d.ts +3 -0
- package/dist/adapters/node/list-entries.io.d.ts.map +1 -0
- package/dist/adapters/node/list-entries.io.js +26 -0
- package/dist/adapters/node/list-entries.io.js.map +1 -0
- package/dist/adapters/study-registry/index.d.ts +70 -10
- package/dist/adapters/study-registry/index.d.ts.map +1 -1
- package/dist/adapters/study-registry/index.js +84 -10
- package/dist/adapters/study-registry/index.js.map +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +33 -3
- package/dist/cli.js.map +1 -1
- package/dist/domain/decide-first.d.ts +110 -0
- package/dist/domain/decide-first.d.ts.map +1 -0
- package/dist/domain/decide-first.js +108 -0
- package/dist/domain/decide-first.js.map +1 -0
- package/dist/domain/index-columns.d.ts +45 -0
- package/dist/domain/index-columns.d.ts.map +1 -0
- package/dist/domain/index-columns.js +64 -0
- package/dist/domain/index-columns.js.map +1 -0
- package/dist/domain/study-mode.d.ts +37 -0
- package/dist/domain/study-mode.d.ts.map +1 -0
- package/dist/domain/study-mode.js +45 -0
- package/dist/domain/study-mode.js.map +1 -0
- package/dist/domain/study-registry.d.ts +116 -12
- package/dist/domain/study-registry.d.ts.map +1 -1
- package/dist/domain/study-registry.js +164 -44
- package/dist/domain/study-registry.js.map +1 -1
- package/dist/outputs-before-decision-rule.d.ts +17 -0
- package/dist/outputs-before-decision-rule.d.ts.map +1 -0
- package/dist/outputs-before-decision-rule.js +94 -0
- package/dist/outputs-before-decision-rule.js.map +1 -0
- package/dist/ports/git-history.d.ts +44 -0
- package/dist/ports/git-history.d.ts.map +1 -0
- package/dist/ports/git-history.js +2 -0
- package/dist/ports/git-history.js.map +1 -0
- package/dist/ports/list-entries.d.ts +20 -0
- package/dist/ports/list-entries.d.ts.map +1 -0
- package/dist/ports/list-entries.js +2 -0
- package/dist/ports/list-entries.js.map +1 -0
- package/dist/ports/study-deps.d.ts +14 -0
- package/dist/ports/study-deps.d.ts.map +1 -0
- package/dist/ports/study-deps.js +2 -0
- package/dist/ports/study-deps.js.map +1 -0
- package/dist/ports/study-folder.d.ts +43 -0
- package/dist/ports/study-folder.d.ts.map +1 -0
- package/dist/ports/study-folder.js +2 -0
- package/dist/ports/study-folder.js.map +1 -0
- package/dist/ports/study-registry-codec.d.ts +6 -3
- package/dist/ports/study-registry-codec.d.ts.map +1 -1
- package/dist/presets.d.ts +1 -2
- package/dist/presets.d.ts.map +1 -1
- package/dist/presets.js +1 -2
- package/dist/presets.js.map +1 -1
- package/dist/studies.d.ts +4 -0
- package/dist/studies.d.ts.map +1 -1
- package/dist/studies.js +52 -21
- package/dist/studies.js.map +1 -1
- package/dist/study-folder.d.ts +14 -0
- package/dist/study-folder.d.ts.map +1 -0
- package/dist/study-folder.js +123 -0
- package/dist/study-folder.js.map +1 -0
- package/dist/study-gate.d.ts +14 -0
- package/dist/study-gate.d.ts.map +1 -0
- package/dist/study-gate.js +132 -0
- package/dist/study-gate.js.map +1 -0
- package/dist/study-index-input.d.ts +5 -0
- package/dist/study-index-input.d.ts.map +1 -0
- package/dist/study-index-input.js +18 -0
- package/dist/study-index-input.js.map +1 -0
- package/dist/study-modes.d.ts +56 -0
- package/dist/study-modes.d.ts.map +1 -0
- package/dist/study-modes.js +59 -0
- package/dist/study-modes.js.map +1 -0
- package/dist/study-registry-rule.d.ts +13 -1
- package/dist/study-registry-rule.d.ts.map +1 -1
- package/dist/study-registry-rule.js +33 -21
- package/dist/study-registry-rule.js.map +1 -1
- package/dist/study-run.d.ts +19 -0
- package/dist/study-run.d.ts.map +1 -0
- package/dist/study-run.js +9 -0
- package/dist/study-run.js.map +1 -0
- package/docs/design/study-modes.md +265 -0
- package/docs/design/study-registry.md +6 -0
- package/docs/e2e.md +8 -4
- package/docs/layout.md +22 -19
- package/docs/rules/repro/outputs-before-decision.md +122 -0
- package/docs/rules/repro/study-registered.md +49 -15
- package/docs/rules/tex/heading-case.md +1 -1
- package/docs/rules.md +54 -53
- package/docs/testing.md +1 -0
- package/eslint.config.mjs +36 -24
- package/package.json +2 -1
- package/scripts/check.ts +6 -0
- package/skills/camera-ready/SKILL.md +6 -1
- package/skills/camera-ready/SKILL.md.spec.ts +5 -0
- package/skills/draft-paper/SKILL.md +11 -3
- package/skills/draft-paper/SKILL.md.spec.ts +10 -2
- package/skills/grade-paper-writing/SKILL.md +4 -2
- package/skills/grade-paper-writing/SKILL.md.spec.ts +3 -1
- package/skills/grade-paper-writing/__snapshots__/prose-lint.test.ts.snap +16 -3
- package/skills/grade-paper-writing/prose-lint.mjs +127 -95
- package/skills/grade-paper-writing/prose-lint.test.ts +119 -10
- package/skills/harden-paper/SKILL.md +12 -2
- package/skills/harden-paper/SKILL.md.spec.ts +11 -1
- package/skills/osf-artifact-upload/SKILL.md +7 -1
- package/skills/osf-artifact-upload/SKILL.md.spec.ts +6 -0
- package/skills/pc-panel-review/SKILL.md +10 -3
- package/skills/pc-panel-review/SKILL.md.spec.ts +9 -2
- package/skills/tighten-paper/SKILL.md +5 -1
- package/skills/tighten-paper/SKILL.md.spec.ts +4 -0
- package/src/CLAUDE.md +7 -4
- package/src/CLAUDE.md.spec.ts +6 -3
- package/src/adapters/git/history.test.ts +121 -0
- package/src/adapters/git/index.test.ts +268 -0
- package/src/adapters/git/index.ts +227 -0
- package/src/adapters/latex/captions.test.ts +57 -0
- package/src/adapters/latex/captions.ts +56 -0
- package/src/adapters/latex/index.ts +1 -0
- package/src/adapters/latex/parse.ts +7 -0
- package/src/adapters/memory/index.test.ts +15 -1
- package/src/adapters/memory/index.ts +13 -0
- package/src/adapters/node/index.ts +1 -0
- package/src/adapters/node/list-entries.io.ts +27 -0
- package/src/adapters/node/list-entries.test.ts +61 -0
- package/src/adapters/study-registry/index.test.ts +12 -9
- package/src/adapters/study-registry/index.ts +130 -24
- package/src/adapters/study-registry/mode.test.ts +162 -0
- package/src/cli.ts +47 -3
- package/src/domain/decide-first.test.ts +291 -0
- package/src/domain/decide-first.ts +258 -0
- package/src/domain/index-columns.test.ts +261 -0
- package/src/domain/index-columns.ts +107 -0
- package/src/domain/study-measurements.test.ts +16 -8
- package/src/domain/study-mode.test.ts +55 -0
- package/src/domain/study-mode.ts +78 -0
- package/src/domain/study-registry.test.ts +72 -37
- package/src/domain/study-registry.ts +281 -50
- package/src/new-paper.test.ts +5 -1
- package/src/outputs-before-decision-rule.test.ts +251 -0
- package/src/outputs-before-decision-rule.ts +133 -0
- package/src/ports/git-history.ts +44 -0
- package/src/ports/list-entries.ts +21 -0
- package/src/ports/study-deps.ts +14 -0
- package/src/ports/study-folder.ts +38 -0
- package/src/ports/study-registry-codec.ts +10 -3
- package/src/presets.ts +1 -2
- package/src/rule-cases.test.ts +78 -3
- package/src/studies-index-modes.test.ts +129 -0
- package/src/studies.test.ts +35 -11
- package/src/studies.ts +96 -26
- package/src/study-folder.test.ts +237 -0
- package/src/study-folder.ts +176 -0
- package/src/study-gate.test.ts +467 -0
- package/src/study-gate.ts +234 -0
- package/src/study-index-input.ts +31 -0
- package/src/study-modes.ts +107 -0
- package/src/study-registry-rule.test.ts +285 -11
- package/src/study-registry-rule.ts +64 -35
- package/src/study-run.ts +21 -0
|
@@ -139,7 +139,12 @@ author's check of the drawn units. `paperlint studies new` writes the template b
|
|
|
139
139
|
},
|
|
140
140
|
"arms": [],
|
|
141
141
|
"primary_outcome": "",
|
|
142
|
-
"author_check": null
|
|
142
|
+
"author_check": null,
|
|
143
|
+
"mode": {
|
|
144
|
+
"kind": "decide_before_run",
|
|
145
|
+
"outputs": [],
|
|
146
|
+
"decision": { "file": "repro/P1-S02-census/decision.md", "note": "" }
|
|
147
|
+
}
|
|
143
148
|
}
|
|
144
149
|
```
|
|
145
150
|
|
|
@@ -154,6 +159,14 @@ author's check of the drawn units. `paperlint studies new` writes the template b
|
|
|
154
159
|
| `primary_outcome` | the one number the study reports first |
|
|
155
160
|
| `author_check` | `null` until the author has seen the drawn units; then `by`, `date`, `quote` |
|
|
156
161
|
| `extra` | optional: the paper's own keys (hypotheses, models, budget), kept unread |
|
|
162
|
+
| `mode` | a measurement's: exactly one of `decide_before_run` or `exploratory` |
|
|
163
|
+
|
|
164
|
+
`mode` is required of a `measurement` (other kinds may omit it): how its outcomes are kept from the
|
|
165
|
+
decisions on its inputs — decided before the run (the default the template writes; its `outputs`,
|
|
166
|
+
and its `decision` file relative to the paper, committed before the run) or `exploratory` with its
|
|
167
|
+
`reason`. Without it a measurement's plan is a draft whose empty text is `mode`. The modes, and the
|
|
168
|
+
rule that holds the order in git, [`repro/outputs-before-decision`](outputs-before-decision.md), are
|
|
169
|
+
in [`docs/design/study-modes.md`](../../design/study-modes.md).
|
|
157
170
|
|
|
158
171
|
The template's draw is of all the population; a sampled study changes it to
|
|
159
172
|
`{ "kind": "seeded", "method": "random", "seed": 7 }`. The population's size is not stored: it is
|
|
@@ -176,12 +189,13 @@ The rule reports:
|
|
|
176
189
|
managers leave there, like `__pycache__/` and `node_modules/`, are not studies);
|
|
177
190
|
- a row whose folder does not exist, and a folder named by more than one row;
|
|
178
191
|
- an id that is not `<prefix>-S<digits>`, an id on more than one row, and a folder that is not
|
|
179
|
-
`<id>-<slug
|
|
192
|
+
`<id>-<slug>` — a row naming `../x` among them, through which no file is read;
|
|
180
193
|
- a title over 8 words;
|
|
181
194
|
- `done` without `result` or `result_file`, and a `result_file` that is not a file inside the folder;
|
|
182
195
|
- `superseded` without `superseded_by`, or naming an id that is not in the registry;
|
|
183
|
-
- an index out of sync: the block of `repro/README.md` between the markers below must
|
|
184
|
-
|
|
196
|
+
- an index out of sync: the block of `repro/README.md` between the markers below must hold the
|
|
197
|
+
cells the registry and the plans generate, whatever padding a formatter gave the table — every
|
|
198
|
+
column but the two `studies index` reads from git (below);
|
|
185
199
|
|
|
186
200
|
```text
|
|
187
201
|
<!-- studies:begin — generated from studies.json by `paperlint studies index`; do not edit -->
|
|
@@ -195,9 +209,10 @@ The rule reports:
|
|
|
195
209
|
must meet a requirement the registry does not hold (`unknown-requirement`);
|
|
196
210
|
- a `headline` measurement with no `approval`, or, when the registry names its `author`, one approved
|
|
197
211
|
by anyone else (`headline-approval`);
|
|
198
|
-
- a row's `plan` that is outside its folder, not a file, or not of the plan's shape — and, once the
|
|
212
|
+
- a row's `plan` that is outside its folder, not a file, reached through a symbolic link, or not of the plan's shape — and, once the
|
|
199
213
|
study has run (`running`, `done`, `stopped`, `superseded`), a plan that leaves `question`,
|
|
200
|
-
`population.source`, `population.draw.method` or `primary_outcome` empty
|
|
214
|
+
`population.source`, `population.draw.method` or `primary_outcome` empty, or — for a measurement —
|
|
215
|
+
declares no `mode` or leaves one of its texts empty (`bad-plan`);
|
|
201
216
|
- a study of a `headline` measurement that has run with no `author_check` in its plan — or no plan —
|
|
202
217
|
or, when the registry names its `author`, a check by anyone else (`author-check`).
|
|
203
218
|
|
|
@@ -212,9 +227,24 @@ study began, not what it is. The registry gives each study a number that does no
|
|
|
212
227
|
person can read, and says in one place where every study stands. A rule holds it, not a guideline: a
|
|
213
228
|
row the rule does not check is a row that drifts.
|
|
214
229
|
|
|
215
|
-
The index in `repro/README.md` is generated, so it is never edited by hand
|
|
216
|
-
|
|
217
|
-
|
|
230
|
+
The index in `repro/README.md` is generated, so it is never edited by hand: the rule compares its
|
|
231
|
+
cells. It is a table padded the way prettier writes one, so formatting the README leaves it in sync.
|
|
232
|
+
|
|
233
|
+
Three of its columns say how each study kept its outcomes from its decisions
|
|
234
|
+
([`docs/design/study-modes.md`](../../design/study-modes.md)):
|
|
235
|
+
|
|
236
|
+
| column | cell |
|
|
237
|
+
| -------------- | ------------------------------------------------------------------------------------ |
|
|
238
|
+
| `mode` | `decide_before_run`, `exploratory: <reason>`, or `—` for a study whose plan has none |
|
|
239
|
+
| `decision` | the decision file's first commit (12 characters) and its date, or `not committed` |
|
|
240
|
+
| `first output` | the first commit of the oldest output and its date, or `none` |
|
|
241
|
+
|
|
242
|
+
The `mode` comes from the plan, which is in the tree, so the rule compares it. The two commits are
|
|
243
|
+
what git's history said when `paperlint studies index` last ran: a squash merge or a rebase gives the
|
|
244
|
+
same files new commits, and a shallow CI clone has none to read, so the rule never compares those two
|
|
245
|
+
columns. Regenerate the index before reading them; the order itself is judged by
|
|
246
|
+
[`repro/outputs-before-decision`](outputs-before-decision.md), not by the table. In a shallow clone
|
|
247
|
+
`studies index` writes `unknown (shallow clone)`.
|
|
218
248
|
|
|
219
249
|
## Examples
|
|
220
250
|
|
|
@@ -237,9 +267,9 @@ the plan is reported for its empty fields, and the study for the author's check
|
|
|
237
267
|
```text
|
|
238
268
|
papers/example/PIPELINE-STATUS.md
|
|
239
269
|
1:1 error The plan of `P1-S02`, `plan.json` in its folder, leaves `question`, `population.source`,
|
|
240
|
-
`population.draw.method
|
|
241
|
-
plan is written before the runs. What to do: fill
|
|
242
|
-
`designing`.
|
|
270
|
+
`population.draw.method`, `primary_outcome`, `mode.outputs` and `mode.decision.note`
|
|
271
|
+
empty, and the study is `running`: a plan is written before the runs. What to do: fill
|
|
272
|
+
them in, or set the study back to `designing`.
|
|
243
273
|
1:1 error `P1-S02` is `running` in the headline measurement `M1`, and its plan has no
|
|
244
274
|
`author_check`. What to do: show the author the drawn units, then record their answer
|
|
245
275
|
in the plan's `author_check` — `by`, `date`, and their words in `quote`.
|
|
@@ -263,9 +293,9 @@ repro/
|
|
|
263
293
|
```markdown
|
|
264
294
|
<!-- studies:begin — generated from studies.json by `paperlint studies index`; do not edit -->
|
|
265
295
|
|
|
266
|
-
| id | title | status | result | in paper | folder |
|
|
267
|
-
| ------ | ------------------ | ------ | ------------------ | -------- | -------------------------------------------------------- |
|
|
268
|
-
| P1-S01 | Baseline pass rate | done | 41 of 60 runs pass | yes | [P1-S01-baseline-pass-rate/](P1-S01-baseline-pass-rate/) |
|
|
296
|
+
| id | title | status | result | in paper | mode | decision | first output | folder |
|
|
297
|
+
| ------ | ------------------ | ------ | ------------------ | -------- | ----------------- | ----------------------- | ----------------------- | -------------------------------------------------------- |
|
|
298
|
+
| P1-S01 | Baseline pass rate | done | 41 of 60 runs pass | yes | decide_before_run | 3f2a9c1d7e40 2026-10-14 | 8b51e0aa42c9 2026-10-15 | [P1-S01-baseline-pass-rate/](P1-S01-baseline-pass-rate/) |
|
|
269
299
|
|
|
270
300
|
<!-- studies:end -->
|
|
271
301
|
```
|
|
@@ -284,6 +314,10 @@ No rule options.
|
|
|
284
314
|
- A repeated measurement or requirement id, and a requirement no measurement names.
|
|
285
315
|
- A `prereg.json` or `plan.json` that no row names.
|
|
286
316
|
- Whether the paper cites a study: `in_paper` is declared, not detected.
|
|
317
|
+
- The index's `decision` and `first output` cells: they name commits a squash merge renames.
|
|
318
|
+
- Inside a study folder that is a symbolic link: nothing is read through it, so its plan and its
|
|
319
|
+
result file read as missing. A plan or a result file whose path passes through a link inside the
|
|
320
|
+
folder is not read either, and is reported naming the link (`bad-plan`, `result-file`).
|
|
287
321
|
- What may stand at the top of `repro/` besides the study folders, and whether a study folder has a
|
|
288
322
|
`README.md`: that is [`repro/allowed-files-only`](allowed-files-only.md).
|
|
289
323
|
|
|
@@ -376,7 +376,7 @@ author wrote. Two corpora, 2026-10-03, both measured on headings, before the rul
|
|
|
376
376
|
- **The accepted paper in this repository**, `fixtures/accepted-papers/agenticdev-acm26`: 9
|
|
377
377
|
headings, 6 of them in sentence case, which the vendor's checklist does not accept. The rule
|
|
378
378
|
reports 18 words, every one a true positive, and its fixes write the six corrected
|
|
379
|
-
headings ([`fixtures/accepted-papers/README.md`](
|
|
379
|
+
headings ([`fixtures/accepted-papers/README.md`](https://github.com/zernie/paperlint/blob/main/fixtures/accepted-papers/README.md)).
|
|
380
380
|
Its `\title` and short title, read since 2026-10-04, are already in headline style and add no
|
|
381
381
|
finding.
|
|
382
382
|
- **277 `acmart` sources from arXiv** (authors' versions of papers whose arXiv comment names an ACM
|
package/docs/rules.md
CHANGED
|
@@ -3,59 +3,60 @@
|
|
|
3
3
|
The README lists what each check catches in one line. This page says exactly which file each one
|
|
4
4
|
reads and when it fails. Errors fail `paperlint lint`; warnings print and do not.
|
|
5
5
|
|
|
6
|
-
| Rule
|
|
7
|
-
|
|
|
8
|
-
| `paper/stages`
|
|
9
|
-
| `paper/source`
|
|
10
|
-
| [`study/declare-sample`](rules/study/declare-sample.md)
|
|
11
|
-
| [`cycle/record`](rules/cycle/record.md)
|
|
12
|
-
| [`cycle/evidence`](rules/cycle/evidence.md)
|
|
13
|
-
| [`cycle/stage`](rules/cycle/stage.md)
|
|
14
|
-
| [`cycle/port-done`](rules/cycle/port-done.md)
|
|
15
|
-
| [`paper/folder-venue-leftover`](rules/paper/folder-venue-leftover.md)
|
|
16
|
-
| [`paper/allowed-files-only`](rules/paper/allowed-files-only.md)
|
|
17
|
-
| [`repro/allowed-files-only`](rules/repro/allowed-files-only.md)
|
|
18
|
-
| [`repro/study-registered`](rules/repro/study-registered.md)
|
|
19
|
-
| [`repro/study-plan-name`](rules/repro/study-plan-name.md)
|
|
20
|
-
| [`
|
|
21
|
-
| `paper/
|
|
22
|
-
| `paper/
|
|
23
|
-
| `paper/
|
|
24
|
-
| `paper/
|
|
25
|
-
|
|
|
26
|
-
| `
|
|
27
|
-
| `paper/
|
|
28
|
-
| `paper/refs-
|
|
29
|
-
| `
|
|
30
|
-
| `tex/
|
|
31
|
-
|
|
|
32
|
-
| [`tex/
|
|
33
|
-
| [`tex/
|
|
34
|
-
| [`
|
|
35
|
-
| [`
|
|
36
|
-
| [`
|
|
37
|
-
| [`tex/
|
|
38
|
-
| [`tex/
|
|
39
|
-
| [`tex/
|
|
40
|
-
| [`tex/
|
|
41
|
-
| [`tex/
|
|
42
|
-
| `
|
|
43
|
-
| `
|
|
44
|
-
| `
|
|
45
|
-
| `pdf/
|
|
46
|
-
| `pdf/
|
|
47
|
-
| `pdf/
|
|
48
|
-
|
|
|
49
|
-
| [`
|
|
50
|
-
| `pdf/
|
|
51
|
-
|
|
|
52
|
-
| [`talk/
|
|
53
|
-
| [`talk/
|
|
54
|
-
| [`talk/
|
|
55
|
-
| [`talk/duration
|
|
56
|
-
| [`talk/
|
|
57
|
-
| [`talk/
|
|
58
|
-
| [`talk/
|
|
6
|
+
| Rule | Level | Reads | Fails when |
|
|
7
|
+
| ------------------------------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
8
|
+
| `paper/stages` | error | `PIPELINE-STATUS.md` | a declared stage's PDF is missing, or the `bytes:` it names does not match the file's real size, or a frozen PDF exists that no stage declares |
|
|
9
|
+
| `paper/source` | error | `PIPELINE-STATUS.md` | a declared stage has no frozen `.tex` beside its PDF (a commit hash does not count — squash and gc destroy it) |
|
|
10
|
+
| [`study/declare-sample`](rules/study/declare-sample.md) | experimental; off unless a paper turns it on (`"error"`) | each study's `repro/<study>/prereg.json` | a study's pre-registration does not declare its `population` (what the claim is about, source, size), the `strata` and what each of its `screens` removed per stratum value, its `coverage` (share 0–1 or null with a reason, and the strata it cannot reach), or the `author_check` of the drawn units (a doubtful verdict needs a recorded `decision`); reported on `PIPELINE-STATUS.md`, once per problem — [page](rules/study/declare-sample.md) |
|
|
11
|
+
| [`cycle/record`](rules/cycle/record.md) | error | `paperlint.json` (`cycles`) | the paper's attempts at venues (`cycles`, one entry per attempt) hold one source's deadlines out of order (registration ≤ submission ≤ resubmission < notification < camera-ready), or copy a portal reading the venue's preset carries; reported on `PIPELINE-STATUS.md`. A record that does not parse — a bare date, two open cycles, an unknown key — is refused by `paperlint lint` itself before any rule runs, exit 2 — [page](rules/cycle/record.md) |
|
|
12
|
+
| [`cycle/evidence`](rules/cycle/evidence.md) | error | `paperlint.json` (`cycles`) → the paper folder | a closed cycle (`accepted`, `rejected`, `withdrawn`) or a deadline's `override` names an `evidence` file — the decision mail, the reviews, the withdrawal note, the chairs' mail — that is not in the paper folder; reported on `PIPELINE-STATUS.md` — [page](rules/cycle/evidence.md) |
|
|
13
|
+
| [`cycle/stage`](rules/cycle/stage.md) | error | `PIPELINE-STATUS.md` → `paperlint.json` (`cycles`) | with `cycles` declared, a stage names no `cycle: <id>`, names one no cycle has, or a `submitted`/`camera-ready` stage belongs to a cycle whose `phase` is still `porting` — [page](rules/cycle/stage.md) |
|
|
14
|
+
| [`cycle/port-done`](rules/cycle/port-done.md) | error | `paper.tex` → `paperlint.json` (`cycles`) → the preset's `template` | the current cycle still declares `"phase": "porting"` (which silences the venue's format rules) while the `\documentclass` is already the venue's template: the port is done, drop the phase — [page](rules/cycle/port-done.md) |
|
|
15
|
+
| [`paper/folder-venue-leftover`](rules/paper/folder-venue-leftover.md) | warn | the folder name → `paperlint.json` | the paper's folder is named after another shipped venue than the one it extends (`papers/aisec-2026/` for a paper now set for AIDC); reported on `PIPELINE-STATUS.md` — [page](rules/paper/folder-venue-leftover.md) |
|
|
16
|
+
| [`paper/allowed-files-only`](rules/paper/allowed-files-only.md) | error | the paper folder's root listing → `paperlint.json` | a file or folder at the paper's root is not part of the layout (`PLAN.md`, `archive/`, a stray PDF); reported on `PIPELINE-STATUS.md`, once per entry, with where it goes; `extra/` takes anything — [page](rules/paper/allowed-files-only.md) |
|
|
17
|
+
| [`repro/allowed-files-only`](rules/repro/allowed-files-only.md) | error | the listing of the paper's `repro/` | an entry at the top of `repro/` is not `README.md`, `studies.json`, `.gitignore`, `tools/`, `data/` or a study folder named `<id>-<slug>` (or, in a paper without the registry, `<slug>-YYYY-MM-DD`), or a study folder has no `README.md`; reported on `PIPELINE-STATUS.md`, once per entry, with where it goes by kind (a script → `repro/tools/`, data → `repro/data/`, a note → its study or `research/`) — [page](rules/repro/allowed-files-only.md) |
|
|
18
|
+
| [`repro/study-registered`](rules/repro/study-registered.md) | error | the listing of the paper's `repro/`, `repro/studies.json`, `repro/README.md`, each study's `plan.json` | a study folder with no row in `repro/studies.json`, a row whose folder is missing or not `<id>-<slug>`, a bad or repeated id, a title over 8 words, `done` without a result and an existing result file, `superseded` without an existing successor, a row naming a measurement the registry does not declare, a measurement with no study or an unknown requirement, a headline measurement not approved by the author, a plan that is missing, malformed or — once the study runs — unfilled, a headline study that has run without the author's check in its plan, or the index in `repro/README.md` out of sync with the registry; `paperlint studies new` and `paperlint studies index` write both — [page](rules/repro/study-registered.md) |
|
|
19
|
+
| [`repro/study-plan-name`](rules/repro/study-plan-name.md) | warn | `repro/studies.json` | a study's plan still named `prereg.json`, its old name: read as the plan, and to be renamed `plan.json` — [page](rules/repro/study-plan-name.md) |
|
|
20
|
+
| [`repro/outputs-before-decision`](rules/repro/outputs-before-decision.md) | error | `repro/studies.json`, each decide-first study's `plan.json` and folder, git's history | an output of a study decided before its run whose first commit does not descend from its decision's first commit, an output while the decision is uncommitted, a decision its outputs match, a shallow or unreadable history; `paperlint studies gate` opens the run only once the decision is committed — [page](rules/repro/outputs-before-decision.md) |
|
|
21
|
+
| [`paper/sources-fresh`](rules/paper/sources-fresh.md) | warn | `paper.tex` → `_build/sources.json` | the paper has not been built (no record of the files TeX read), or a file changed since the last build (its SHA-256 differs) — run `npx paperlint build` |
|
|
22
|
+
| `paper/author-list` | error | `paper.tex` → `_build/references.json`, `_build/sources.json` | an entry's authors are not those of the version it cites — typically the arXiv preprint's list under a published venue. Checked online by `paperlint build` (DBLP), reported on the entry's own line (or at the top of `paper.tex`, naming the entry's file); silent without a current build record |
|
|
23
|
+
| `paper/section-word` | warn | `paper.tex` and its body files | `§` or `\S\ref` instead of the word Section. **Fixable:** `--fix` writes `Section~\ref{…}` / `Section 5` |
|
|
24
|
+
| `paper/leading-zero` | warn | `paper.tex` and its body files | a decimal below 1 without its leading zero (`.05` instead of `0.05`, IEEE / ISO 80000-1 style), counted only where the reader sees it — prose, math and table cells, not macro options, column specs, comments, code or tikz. A number right after `¶` or `§` (`¶¶.42`) is a paragraph designator and is not reported; in a paragraph that cites numbers that way, another bare decimal is reported without a fix, with the zero as a suggestion. **Fixable** |
|
|
25
|
+
| `paper/figure-ref-style` | warn | `paper.tex` and its body files | `Fig.~\ref` and `Figure~\ref` mixed in one document; each minority occurrence is reported. **Fixable:** `--fix` writes the majority form |
|
|
26
|
+
| [`bib/reachable-entry`](rules/bib/reachable-entry.md) | warn | `paper.tex` → `_build/sources.json`: the databases the last build's bibtex opened | an entry has no doi, url or arXiv id — a reader has nothing to follow. Reported on the entry in the `filecontents` block of `paper.tex` that wrote its `.bib`, or at the top of `paper.tex` with the entry's file and line first; silent until a build records the paper; no fix, the link has to be looked up — [page](rules/bib/reachable-entry.md) |
|
|
27
|
+
| `paper/cite-exists` | error | `paper.tex` → `_build/references.json` | an entry's doi or arXiv id resolves to nothing, or to a different work. Checked online by `paperlint build`; a work that was merely not found is not a finding |
|
|
28
|
+
| `paper/refs-fresh` | error | `paper.tex` → `_build/references.json` | the databases bibtex opened changed since the build checked them (their SHA-256 differs) — run `npx paperlint build` |
|
|
29
|
+
| `paper/refs-checked` | warn | `paper.tex` → `_build/references.json` | a build recorded the paper's databases and none has checked their references, or the last build could not (no network), or its bibtex typeset a key paperlint's reader did not read (an entry behind `%`, inside `@comment{…}`), or bibtex found a database outside the paper directory (`BIBINPUTS`) — so the two rules above did not run on it. Silent without a record of the build (`paper/sources-fresh` speaks) |
|
|
30
|
+
| `tex/future-promise` | warn | `paper.tex` and its body files | a camera-ready build still says "will be released" about something already handed over |
|
|
31
|
+
| `tex/acm-frontmatter-override` | error | `paper.tex` | an `acmart` build overrides ACM's front-matter commands and drops template elements from page 1 |
|
|
32
|
+
| [`tex/template`](rules/tex/template.md) | error | `paper.tex` → `paperlint.json` | the `\documentclass` is not the preset's `template` class, or lacks an option it names — [page](rules/tex/template.md) |
|
|
33
|
+
| [`tex/required-section`](rules/tex/required-section.md) | error | `paper.tex` → `paperlint.json` | a section the preset requires (AIDC: «LLM Usage Statement», last) is missing or not where it must be — [page](rules/tex/required-section.md) |
|
|
34
|
+
| [`tex/heading-case`](rules/tex/heading-case.md) | optional; the AgenticDev preset sets `error` | `paper.tex` and the files it includes | a word in the paper's `\title` or in a `\section`, `\subsection`, `\subsubsection`, `\paragraph` or `\subparagraph` title is not in the style its scope asks: `{ "title", "headings", "levels"? }`, each `chicago-headline` (Conference Publishing's quote of the Chicago Manual of Style), `sentence` (first word only) or `any`. Words that are a preposition in one title and a particle in another (`up`, `on`, `in`) are not read mid-title. **Fixable:** `--fix` — [page](rules/tex/heading-case.md) |
|
|
35
|
+
| [`format/layout-override`](rules/format/layout-override.md) | error | `paper.tex` → `paperlint.json` | the source changes the page layout the venue's template sets for the whole document — `geometry`, a layout `\setlength`, `\linespread`, `\baselinestretch` — [page](rules/format/layout-override.md) |
|
|
36
|
+
| [`anonymity/identity`](rules/anonymity/identity.md) | error | `paper.tex` → `_build/paper.facts.json` | a double-blind venue (`"blind": true`) and no `identity` declared, or a declared name, handle, email or project in the PDF's text, metadata or link targets — [page](rules/anonymity/identity.md) |
|
|
37
|
+
| [`tex/venue-leftover`](rules/tex/venue-leftover.md) | warn | `paper.tex` → `paperlint.json` | the text names another shipped venue than the one the paper extends («Submission to VenueA 2026» in a paper now set for VenueB) — [page](rules/tex/venue-leftover.md) |
|
|
38
|
+
| [`tex/claim-provenance`](rules/tex/claim-provenance.md) | warn | `paper.tex` | a sentence of the body states a number and does not say whose it is — no citation or link, no _we_/_our_, no `\ref` or "Table 2", no sample ("n = 134", "48 runs") — [page](rules/tex/claim-provenance.md) |
|
|
39
|
+
| [`tex/register`](rules/tex/register.md) | warn | `paper.tex` and the files it includes | the body runs to a post's register: more than 0.8 sentences per 1000 words open with _And_, _So_, _But_, _Nor_, _Or_ or _Yet_ — the limit is an option — [page](rules/tex/register.md) |
|
|
40
|
+
| [`tex/contrast-frames`](rules/tex/contrast-frames.md) | warn | `paper.tex` and the files it includes → `paperlint.json` | contrast frames (_X, not Y_, _not X but Y_, _rather than_, _instead of_, _as opposed to_) per 10,000 words fall outside the band the venue preset's anchors set (AIDC: 0–10.4, from five accepted ACSAC papers); above it, each frame is reported too — [page](rules/tex/contrast-frames.md) |
|
|
41
|
+
| [`tex/claim-emphasis`](rules/tex/claim-emphasis.md) | warn | `paper.tex` and the files it includes → `paperlint.json` | claims set in bold inside a sentence (six words or more, or holding a number; not a term, not a label opening a paragraph) per 10,000 words fall outside the preset's band (AIDC: 0–17.8); above it, each is reported too — [page](rules/tex/claim-emphasis.md) |
|
|
42
|
+
| [`tex/relation-markers`](rules/tex/relation-markers.md) | warn | `paper.tex` and the files it includes → `paperlint.json` | words that name how a sentence relates to the one before (_because_, _therefore_, _however_, _for example_ …) per 10,000 words fall outside the preset's band (AIDC: 25.4–135.0) — the floor that catches relations left to infer — [page](rules/tex/relation-markers.md) |
|
|
43
|
+
| `review/frontmatter` | error | `reviews/*.md` | the review's frontmatter fails paperlint's JSON Schema — a `findings` record without `id`/`status`, an unknown field, or an **open** finding with no `cause` (`skill-defect` · `missing-skill` · `hook` · `rule`). A review with no `findings` key is not checked for findings |
|
|
44
|
+
| `sibling/frontmatter` | warn | `siblings/*.md` (not `README.md`) | a sibling card's frontmatter has no `read:` saying how much of the competing paper was read (`full` · `abstract` · `none`) |
|
|
45
|
+
| `pdf/fresh` | error | `paper.tex` → `_build/paper.facts.json` | the paper names a venue and the facts cannot be judged: not JSON, a schema other than 3, or they describe a PDF that is gone or differs from the one on disk (its SHA-256) |
|
|
46
|
+
| `pdf/profile` | error | `paper.tex` → `paperlint.json` | `paperlint.json` is not JSON or has an unknown key, its `extends` does not resolve (not found, a cycle, a chain longer than four, a preset that fails the schema, an npm name), it names no `kind` while the preset has kinds, or names a kind the preset does not have |
|
|
47
|
+
| `pdf/fonts` | error | `paper.tex` → `_build/paper.facts.json` | a font the pages draw is Type 3 or not embedded, or no font starts with the family the venue preset names for body text (`fonts_text`) or headings (`fonts_title`) |
|
|
48
|
+
| `pdf/geometry` | error | `paper.tex` → `_build/paper.facts.json` | the page width or height is more than `dimTol` (default 0.05 in) off the preset's, or the column count differs |
|
|
49
|
+
| [`format/page-limit`](rules/format/page-limit.md) | error | `paper.tex` → `_build/paper.facts.json` | body or reference pages exceed the limits of the paper's kind. With `body_ends_at: "references"` (AIDC) the body ends at the references or the appendix, whichever comes first — found by hyperref's anchors, then the heading line — and the page it ends on counts when body text stands above the heading; with `appendix_in_body` too (MSR) the appendix is body wherever it sits and the reference pages are the ones holding only references; an end it cannot find, or signals that disagree, are reported — [page](rules/format/page-limit.md) |
|
|
50
|
+
| [`pdf/body-size`](rules/pdf/body-size.md) | error | `paper.tex` → `_build/paper.facts.json` | the body font size is more than `body_pt_tol` off the preset's, or the reference font size is outside the preset's range widened by `body_pt_tol`. banal reads 0.3 pt above the size the glyphs are set in; checked on five built accepted papers (none reported) and three variants one size off (each reported) — [page](rules/pdf/body-size.md) |
|
|
51
|
+
| `pdf/measured` | warn | `paper.tex` → `_build/paper.facts.json` | the paper's `paperlint.json` names no venue preset yet; or it names one and there are no facts (it was not built), or the facts carry no page geometry (banal was not found) — so the checks above did not run |
|
|
52
|
+
| [`talk/profile`](rules/talk/profile.md) | error | `paper.tex` → `paperlint.json` | the paper declares `talk` and names no preset, the preset has no `talk` block, the mode is not one the venue allows, or the venue sets no talk slot for the paper's kind — [page](rules/talk/profile.md) |
|
|
53
|
+
| [`talk/required-files`](rules/talk/required-files.md) | error | `paper.tex` → `paperlint.json`, the talk folder | a file the venue requires for the paper's talk mode (video, one-slide, captions…) is not in the talk folder — [page](rules/talk/required-files.md) |
|
|
54
|
+
| [`talk/undeclared`](rules/talk/undeclared.md) | warn | `paper.tex` → the paper's `talk/` folder | an `.mp4` sits in `talk/` and the paper declares no `talk`, so nothing checks it — [page](rules/talk/undeclared.md) |
|
|
55
|
+
| [`talk/duration`](rules/talk/duration.md) | error | `paper.tex` → the talk video | the video runs longer than the slot's `talk_s_max`, or its audio track is more than 1 s off the video's length — [page](rules/talk/duration.md) |
|
|
56
|
+
| [`talk/duration-floor`](rules/talk/duration-floor.md) | warn | `paper.tex` → the talk video | the video runs shorter than the slot's `talk_s_min` — [page](rules/talk/duration-floor.md) |
|
|
57
|
+
| [`talk/video-format`](rules/talk/video-format.md) | error | `paper.tex` → the talk video | the video is not ISO media, is QuickTime where the venue asks for MP4, is under `min_height_px`, or over `max_bytes` — [page](rules/talk/video-format.md) |
|
|
58
|
+
| [`talk/one-slide-size`](rules/talk/one-slide-size.md) | error | `paper.tex` → the one-slide PNG | the one-slide image is not the size the paper or the preset states, or not a PNG — [page](rules/talk/one-slide-size.md) |
|
|
59
|
+
| [`talk/captions-cover`](rules/talk/captions-cover.md) | warn | `paper.tex` → the captions and the video | the captions start late, end early or leave a long gap (uncalibrated thresholds) — [page](rules/talk/captions-cover.md) |
|
|
59
60
|
|
|
60
61
|
**Body files** are the files of the paper's directory that TeX read after `\begin{document}` in the
|
|
61
62
|
last build, as `paperlint build` recorded them in `_build/sources.json` — not a preamble file, not a
|
package/docs/testing.md
CHANGED
|
@@ -100,6 +100,7 @@ npm run coverage # the same under c8, failing below the thresho
|
|
|
100
100
|
npm run test:e2e # every end-to-end run
|
|
101
101
|
npm run test:e2e:install # the package packed and installed under npm and pnpm
|
|
102
102
|
npm run test:e2e:tex # real TeX Live: toolchain, builds of every fixture, banal
|
|
103
|
+
npm run test:e2e:studies # real git: the gate, the order rule, the index's commits
|
|
103
104
|
npm run check # every gate CI runs, and the list of what it does not reproduce
|
|
104
105
|
```
|
|
105
106
|
|