paperlint 6.3.0 → 7.1.0
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/CONTRIBUTING.md +4 -2
- package/README.md +20 -13
- package/dist/adapters/latex/conditionals.d.ts +21 -0
- package/dist/adapters/latex/conditionals.d.ts.map +1 -0
- package/dist/adapters/latex/conditionals.js +75 -0
- package/dist/adapters/latex/conditionals.js.map +1 -0
- package/dist/adapters/latex/headings.d.ts +10 -0
- package/dist/adapters/latex/headings.d.ts.map +1 -0
- package/dist/adapters/latex/headings.js +129 -0
- package/dist/adapters/latex/headings.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 +3 -0
- package/dist/adapters/latex/index.js.map +1 -1
- package/dist/adapters/latex/parse.d.ts +1 -1
- package/dist/adapters/latex/parse.d.ts.map +1 -1
- package/dist/adapters/latex/parse.js +3 -2
- package/dist/adapters/latex/parse.js.map +1 -1
- package/dist/build.d.ts +1 -1
- package/dist/build.d.ts.map +1 -1
- package/dist/build.js +1 -1
- package/dist/build.js.map +1 -1
- package/dist/cli.d.ts +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +19 -5
- package/dist/cli.js.map +1 -1
- package/dist/domain/body-pages.d.ts +29 -0
- package/dist/domain/body-pages.d.ts.map +1 -1
- package/dist/domain/body-pages.js +25 -0
- package/dist/domain/body-pages.js.map +1 -1
- package/dist/domain/heading-case.d.ts +100 -0
- package/dist/domain/heading-case.d.ts.map +1 -0
- package/dist/domain/heading-case.js +365 -0
- package/dist/domain/heading-case.js.map +1 -0
- package/dist/domain/tex-document.d.ts +32 -0
- package/dist/domain/tex-document.d.ts.map +1 -1
- package/dist/domain/tex-document.js +11 -0
- package/dist/domain/tex-document.js.map +1 -1
- package/dist/eslint-rules/latex-language.d.ts.map +1 -1
- package/dist/eslint-rules/latex-language.js +16 -3
- package/dist/eslint-rules/latex-language.js.map +1 -1
- package/dist/facts-file.d.ts +3 -3
- package/dist/facts-file.d.ts.map +1 -1
- package/dist/facts-file.js +3 -3
- package/dist/facts-file.js.map +1 -1
- package/dist/folder-venue-rule.js +6 -6
- package/dist/folder-venue-rule.js.map +1 -1
- package/dist/heading-case.d.ts +48 -0
- package/dist/heading-case.d.ts.map +1 -0
- package/dist/heading-case.js +191 -0
- package/dist/heading-case.js.map +1 -0
- package/dist/paper-includes.d.ts +3 -0
- package/dist/paper-includes.d.ts.map +1 -1
- package/dist/paper-includes.js +17 -2
- package/dist/paper-includes.js.map +1 -1
- package/dist/ports/latex.d.ts +7 -1
- package/dist/ports/latex.d.ts.map +1 -1
- package/dist/preset-card-rule.d.ts +100 -0
- package/dist/preset-card-rule.d.ts.map +1 -0
- package/dist/preset-card-rule.js +221 -0
- package/dist/preset-card-rule.js.map +1 -0
- package/dist/presets.d.ts +29 -5
- package/dist/presets.d.ts.map +1 -1
- package/dist/presets.js +104 -68
- package/dist/presets.js.map +1 -1
- package/dist/submission.d.ts +8 -0
- package/dist/submission.d.ts.map +1 -1
- package/dist/submission.js +19 -7
- package/dist/submission.js.map +1 -1
- package/dist/tex-requirements.d.ts +42 -3
- package/dist/tex-requirements.d.ts.map +1 -1
- package/dist/tex-requirements.js +34 -5
- package/dist/tex-requirements.js.map +1 -1
- package/dist/tex-venue-rules.d.ts +6 -3
- package/dist/tex-venue-rules.d.ts.map +1 -1
- package/dist/tex-venue-rules.js +29 -10
- package/dist/tex-venue-rules.js.map +1 -1
- package/dist/venue-rules.d.ts +2 -1
- package/dist/venue-rules.d.ts.map +1 -1
- package/dist/venue-rules.js +55 -7
- package/dist/venue-rules.js.map +1 -1
- package/docs/configuration.md +13 -1
- package/docs/e2e.md +14 -12
- package/docs/optional-rules.md +4 -3
- package/docs/rules/format/page-limit.md +19 -2
- package/docs/rules/paper/folder-venue-leftover.md +1 -1
- package/docs/rules/talk/profile.md +1 -1
- package/docs/rules/tex/heading-case.md +424 -0
- package/docs/rules/tex/template.md +25 -5
- package/docs/rules/tex/venue-leftover.md +13 -0
- package/docs/rules.md +74 -57
- package/docs/submission.md +5 -1
- package/eslint-rules/latex-language.test.mjs +12 -0
- package/eslint-rules/latex-language.ts +17 -4
- package/eslint-rules/paper-typography.test.mjs +12 -0
- package/eslint.config.mjs +59 -1
- package/fixtures/build-e2e/acmart/paper.tex +1 -1
- package/fixtures/build-e2e/fallback/expect.json +3 -3
- package/fixtures/build-e2e/msr/PIPELINE-STATUS.md +3 -0
- package/fixtures/build-e2e/msr/expect.json +18 -0
- package/fixtures/build-e2e/msr/paper.tex +49 -0
- package/fixtures/build-e2e/msr/paperlint.json +1 -0
- package/fixtures/build-e2e/msr-appendix-after/PIPELINE-STATUS.md +3 -0
- package/fixtures/build-e2e/msr-appendix-after/expect.json +20 -0
- package/fixtures/build-e2e/msr-appendix-after/paper.tex +48 -0
- package/fixtures/build-e2e/msr-appendix-after/paperlint.json +1 -0
- package/lib/skill-checks.mjs +31 -0
- package/package.json +7 -1
- package/presets/acm-sigconf.jsonc +5 -0
- package/presets/acm-sigconf.md +43 -0
- package/presets/agenticdev.jsonc +27 -6
- package/presets/agenticdev.md +151 -0
- package/presets/aidc.jsonc +6 -0
- package/presets/aidc.md +75 -0
- package/presets/aisec.jsonc +5 -1
- package/presets/aisec.md +117 -0
- package/presets/ieee-conference.jsonc +5 -0
- package/presets/ieee-conference.md +38 -0
- package/presets/msr.jsonc +71 -0
- package/presets/msr.md +94 -0
- package/presets/realm.jsonc +7 -2
- package/presets/realm.md +166 -0
- package/presets/tex/agenticdev.tex +1 -1
- package/presets/tex-base.jsonc +6 -0
- package/presets/tex-base.md +30 -0
- package/presets/venue-profile.schema.json +65 -1
- package/skills/camera-ready/SKILL.md +8 -1
- package/skills/camera-ready/SKILL.md.spec.ts +7 -0
- package/skills/find-venue/SKILL.md +6 -5
- package/skills/find-venue/SKILL.md.spec.ts +5 -4
- package/skills/paper-pipeline/SKILL.md +5 -6
- package/skills/paper-pipeline/SKILL.md.spec.ts +4 -5
- package/skills/paper-pipeline/references/acl-venue-rules.md +1 -1
- package/skills/study-accepted-papers/SKILL.md +3 -3
- package/skills/study-accepted-papers/SKILL.md.spec.ts +2 -2
- package/skills/submission-portal/SKILL.md +2 -2
- package/skills/submission-portal/SKILL.md.spec.ts +1 -1
- package/skills/submit-paper/SKILL.md +34 -22
- package/skills/submit-paper/SKILL.md.spec.ts +33 -21
- package/skills/submit-paper/references/publishers/acm.md +1 -1
- package/src/adapters/latex/conditionals.ts +130 -0
- package/src/adapters/latex/headings.ts +163 -0
- package/src/adapters/latex/index.test.ts +65 -0
- package/src/adapters/latex/index.ts +3 -0
- package/src/adapters/latex/parse.ts +3 -2
- package/src/build.ts +2 -2
- package/src/cli.test.ts +50 -7
- package/src/cli.ts +28 -6
- package/src/domain/body-pages.test.ts +144 -0
- package/src/domain/body-pages.ts +61 -1
- package/src/domain/heading-case.test.ts +660 -0
- package/src/domain/heading-case.ts +538 -0
- package/src/domain/tex-document.ts +36 -0
- package/src/domain/venue-name.test.ts +13 -7
- package/src/facts-file.test.ts +4 -4
- package/src/facts-file.ts +6 -6
- package/src/folder-venue-rule.test.ts +10 -10
- package/src/folder-venue-rule.ts +6 -6
- package/src/heading-case.test.ts +500 -0
- package/src/heading-case.ts +275 -0
- package/src/init.test.ts +1 -1
- package/src/new-paper.test.ts +37 -6
- package/src/paper-includes.test.ts +26 -0
- package/src/paper-includes.ts +20 -2
- package/src/paper-settings-commands.test.ts +26 -11
- package/src/ports/latex.ts +7 -0
- package/src/preset-card-rule.test.ts +267 -0
- package/src/preset-card-rule.ts +384 -0
- package/src/presets.test.ts +259 -41
- package/src/presets.ts +161 -75
- package/src/rule-cases.test.ts +136 -50
- package/src/submission.test.ts +44 -4
- package/src/submission.ts +28 -7
- package/src/talk-rules.test.ts +6 -3
- package/src/tex-requirements.harness.ts +25 -11
- package/src/tex-requirements.test.ts +127 -1
- package/src/tex-requirements.ts +91 -12
- package/src/tex-venue-rules.test.ts +196 -21
- package/src/tex-venue-rules.ts +47 -16
- package/src/venue-rules.test.ts +180 -8
- package/src/venue-rules.ts +71 -10
- package/templates/paper/paper.tex +1 -1
- package/skills/submit-paper/references/venues/agenticdev.md +0 -171
- package/skills/submit-paper/references/venues/aisec.md +0 -105
- package/skills/submit-paper/references/venues/realm.md +0 -155
package/docs/rules.md
CHANGED
|
@@ -3,53 +3,56 @@
|
|
|
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 | Level
|
|
7
|
-
| --------------------------------------------------------------------- |
|
|
8
|
-
| `paper/stages` | error
|
|
9
|
-
| `paper/source` | error
|
|
10
|
-
| [`paper/folder-venue-leftover`](rules/paper/folder-venue-leftover.md) | warn
|
|
11
|
-
| `paper/author-list` | error
|
|
12
|
-
| `paper/section-word` | warn
|
|
13
|
-
| `paper/leading-zero` | warn
|
|
14
|
-
| `paper/figure-ref-style` | warn
|
|
15
|
-
| `bib/reachable-entry` | warn
|
|
16
|
-
| `paper/cite-exists` | error
|
|
17
|
-
| `paper/refs-fresh` | error
|
|
18
|
-
| `paper/refs-checked` | warn
|
|
19
|
-
| `tex/future-promise` | warn
|
|
20
|
-
| `tex/acm-frontmatter-override` | error
|
|
21
|
-
| [`tex/template`](rules/tex/template.md) | error
|
|
22
|
-
| [`tex/required-section`](rules/tex/required-section.md) | error
|
|
23
|
-
| [`
|
|
24
|
-
| [`
|
|
25
|
-
| [`
|
|
26
|
-
| [`tex/
|
|
27
|
-
| [`tex/
|
|
28
|
-
| [`tex/
|
|
29
|
-
| [`tex/
|
|
30
|
-
| [`tex/
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `pdf/
|
|
35
|
-
| `pdf/
|
|
36
|
-
| `pdf/
|
|
37
|
-
|
|
|
38
|
-
| [`
|
|
39
|
-
| `pdf/
|
|
40
|
-
|
|
|
41
|
-
| [`talk/
|
|
42
|
-
| [`talk/
|
|
43
|
-
| [`talk/
|
|
44
|
-
| [`talk/duration
|
|
45
|
-
| [`talk/
|
|
46
|
-
| [`talk/
|
|
47
|
-
| [`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
|
+
| [`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) |
|
|
11
|
+
| `paper/author-list` | error | `paper.tex` → `_build/references.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 |
|
|
12
|
+
| `paper/section-word` | warn | `paper.tex` and its body files, `paper.md` | `§` or `\S\ref` instead of the word Section. **Fixable:** `--fix` writes `Section~\ref{…}` / `Section 5` |
|
|
13
|
+
| `paper/leading-zero` | warn | `paper.tex` and its body files, `paper.md` | 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** |
|
|
14
|
+
| `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 |
|
|
15
|
+
| `bib/reachable-entry` | warn | `paper.tex` (its `filecontents` bibliography) | an entry has no doi, url or arXiv id — a reader has nothing to follow. Reported on the entry; no fix, the link has to be looked up |
|
|
16
|
+
| `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 |
|
|
17
|
+
| `paper/refs-fresh` | error | `paper.tex` → `_build/references.json` | the bibliography changed since the build checked it (its SHA-256 differs) — run `npx paperlint build` |
|
|
18
|
+
| `paper/refs-checked` | warn | `paper.tex` → `_build/references.json` | the paper has a bibliography and no build has checked it, or the last build could not (no network) — so the two rules above did not run |
|
|
19
|
+
| `tex/future-promise` | warn | `paper.tex` and its body files | a camera-ready build still says "will be released" about something already handed over |
|
|
20
|
+
| `tex/acm-frontmatter-override` | error | `paper.tex` | an `acmart` build overrides ACM's front-matter commands and drops template elements from page 1 |
|
|
21
|
+
| [`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) |
|
|
22
|
+
| [`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) |
|
|
23
|
+
| [`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) |
|
|
24
|
+
| [`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) |
|
|
25
|
+
| [`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) |
|
|
26
|
+
| [`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) |
|
|
27
|
+
| [`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) |
|
|
28
|
+
| [`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) |
|
|
29
|
+
| [`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) |
|
|
30
|
+
| [`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) |
|
|
31
|
+
| [`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) |
|
|
32
|
+
| `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 |
|
|
33
|
+
| `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`) |
|
|
34
|
+
| `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) |
|
|
35
|
+
| `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 |
|
|
36
|
+
| `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`) |
|
|
37
|
+
| `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 |
|
|
38
|
+
| [`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) |
|
|
39
|
+
| [`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) |
|
|
40
|
+
| `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 |
|
|
41
|
+
| [`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) |
|
|
42
|
+
| [`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) |
|
|
43
|
+
| [`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) |
|
|
44
|
+
| [`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) |
|
|
45
|
+
| [`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) |
|
|
46
|
+
| [`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) |
|
|
47
|
+
| [`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) |
|
|
48
|
+
| [`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) |
|
|
48
49
|
|
|
49
50
|
**Body files** are the files `paper.tex` includes from its document body (`\input`, `\include`,
|
|
50
51
|
`\subfile`, nested ones too), found in the paper's directory — not a preamble include, not a file
|
|
51
|
-
found only in paperlint's own inputs, and not any other `.tex` beside the paper (`versions/`).
|
|
52
|
-
|
|
52
|
+
found only in paperlint's own inputs, and not any other `.tex` beside the paper (`versions/`). Only
|
|
53
|
+
the `.tex` ones are linted on their own: an included `.bbl` or `.pgf` is a tool's output, read into
|
|
54
|
+
the whole paper where TeX typesets it, but not judged or fixed as prose of its own. A
|
|
55
|
+
finding in a body file is reported at that file and line, and `--fix` edits that file. Which reference form
|
|
53
56
|
is the majority and whether the build is a review build are decided over the whole paper. An include
|
|
54
57
|
that names no file is printed as a note: lint did not read it, and the build will stop on it.
|
|
55
58
|
|
|
@@ -61,8 +64,8 @@ The `talk/*` rules judge a talk's finished files and are silent for a paper that
|
|
|
61
64
|
`talk` (but `talk/undeclared`): [`talk.md`](talk.md).
|
|
62
65
|
|
|
63
66
|
Optional rules — off unless you turn them on in the `rules` setting, because only some venues need
|
|
64
|
-
them — are on their own page: [`optional-rules.md`](optional-rules.md). Today there
|
|
65
|
-
`pdf/last-page-balance`.
|
|
67
|
+
them — are on their own page: [`optional-rules.md`](optional-rules.md). Today there are two,
|
|
68
|
+
`pdf/last-page-balance` and `tex/heading-case`.
|
|
66
69
|
|
|
67
70
|
## A deliberate exception: a disable directive, with the reason
|
|
68
71
|
|
|
@@ -111,14 +114,15 @@ for papers, each with the quote it came from, the TeX packages its template need
|
|
|
111
114
|
the venue implies. A preset may itself extend another: the ACM venues extend the `acm-sigconf`
|
|
112
115
|
family, which holds everything the ACM template decides.
|
|
113
116
|
|
|
114
|
-
| preset | extends | template
|
|
115
|
-
| --------------------------- | --------------------------- |
|
|
116
|
-
| `paperlint:acm-sigconf` | — | ACM `acmart` sigconf
|
|
117
|
-
| `paperlint:agenticdev` | `paperlint:acm-sigconf` | ACM `acmart` sigconf
|
|
118
|
-
| `paperlint:aisec` | `paperlint:acm-sigconf` | ACM `acmart` sigconf
|
|
119
|
-
| `paperlint:realm` | — | ACL
|
|
120
|
-
| `paperlint:ieee-conference` | — | IEEE `IEEEtran` conference
|
|
121
|
-
| `paperlint:aidc` | `paperlint:ieee-conference` | IEEE `IEEEtran` conference, `compsoc`
|
|
117
|
+
| preset | extends | template | kinds | page limit checked | rules it turns on |
|
|
118
|
+
| --------------------------- | --------------------------- | ------------------------------------------------- | -------------------------------------------------------- | -------------------------------------- | ------------------------------------------- |
|
|
119
|
+
| `paperlint:acm-sigconf` | — | ACM `acmart` sigconf | none | no (no kinds) | — |
|
|
120
|
+
| `paperlint:agenticdev` | `paperlint:acm-sigconf` | ACM `acmart` sigconf | `short` (5 + 2 refs), `full` (10 + 2), `demo` (5 + 2) | yes | `pdf/last-page-balance`, `tex/heading-case` |
|
|
121
|
+
| `paperlint:aisec` | `paperlint:acm-sigconf` | ACM `acmart` sigconf | `research`, `benchmark`, `position`, `sok` (10 + 2 each) | yes | — |
|
|
122
|
+
| `paperlint:realm` | — | ACL | `long`, `short` | no — see below | — |
|
|
123
|
+
| `paperlint:ieee-conference` | — | IEEE `IEEEtran` conference | none | no (no kinds) | — |
|
|
124
|
+
| `paperlint:aidc` | `paperlint:ieee-conference` | IEEE `IEEEtran` conference, `compsoc` | `regular` (12), `short` (6) | yes, before the references — see below | — (`blind`) |
|
|
125
|
+
| `paperlint:msr` | `paperlint:ieee-conference` | IEEE `IEEEtran` `[10pt,conference]`, no `compsoc` | `technical` (10 + 2 of only references) | yes, appendices included — see below | — (`blind`) |
|
|
122
126
|
|
|
123
127
|
That is all that ships today. There is no NeurIPS, USENIX or Springer preset. A paper for an ACM or
|
|
124
128
|
IEEE conference venue nobody has profiled can extend `paperlint:acm-sigconf` or
|
|
@@ -130,7 +134,12 @@ would fail a correct paper. AIDC's limit is checked by another count, for the sa
|
|
|
130
134
|
a page as body when an appendix or the LLM Usage Statement sits on it, and AIDC counts neither, so a
|
|
131
135
|
correct 12-page paper measured 13. Its preset sets `"body_ends_at": "references"`: the body is the
|
|
132
136
|
pages before the one where the references heading first appears. It is also `"blind": true`, which
|
|
133
|
-
turns on [`anonymity/identity`](rules/anonymity/identity.md).
|
|
137
|
+
turns on [`anonymity/identity`](rules/anonymity/identity.md). MSR's limit is checked by a third
|
|
138
|
+
count: its ten pages of main text include the appendices, and only pages holding nothing but
|
|
139
|
+
references are the two extra ones. banal types a page whose first heading reads «Appendix» as
|
|
140
|
+
bibliography and an appendix after the references as references, so its preset adds
|
|
141
|
+
`"appendix_in_body": true` ([page](rules/format/page-limit.md)); it also forbids the `compsoc` and
|
|
142
|
+
`compsocconf` class options its call rules out (`template_forbids`). AgenticDev's turns on `pdf/last-page-balance`
|
|
134
143
|
because its proceedings are produced by Conference Publishing Consulting, which sends back an
|
|
135
144
|
unbalanced last page; AISec's does not, because nothing in hand says who produces the AISec
|
|
136
145
|
proceedings.
|
|
@@ -138,7 +147,7 @@ proceedings.
|
|
|
138
147
|
**How presets are named.** A template family — the preset venues extend, owning the template,
|
|
139
148
|
the format and the TeX packages — is `<publisher>-<template variant>`: `acm-sigconf`, `ieee-conference`. A venue
|
|
140
149
|
is its own short name, lowercase, with no publisher and no parent-conference prefix: `aisec`,
|
|
141
|
-
`agenticdev`, `realm`, `aidc`. Which template a venue uses is said by its `extends`, not by its
|
|
150
|
+
`agenticdev`, `realm`, `aidc`, `msr`. Which template a venue uses is said by its `extends`, not by its
|
|
142
151
|
name — a name repeating it would be wrong the day the venue changes template — and the parent
|
|
143
152
|
conference (CCS, ASE, ACSAC) goes into the preset's comment and its `aliases`.
|
|
144
153
|
|
|
@@ -194,7 +203,10 @@ papers/
|
|
|
194
203
|
```jsonc
|
|
195
204
|
// venues/usenix-sec.jsonc
|
|
196
205
|
{
|
|
206
|
+
// a venue says so, names itself, and links the call for papers its numbers are quoted from
|
|
207
|
+
"type": "venue",
|
|
197
208
|
"name": "USENIX Security",
|
|
209
|
+
"url": "https://www.usenix.org/conference/usenixsecurity27/call-for-papers",
|
|
198
210
|
// a standalone preset needs its template's TeX packages; one that extends a family inherits them
|
|
199
211
|
"template": "article",
|
|
200
212
|
// TeX Live packages only, each with a file that proves it is installed. The USENIX style file
|
|
@@ -219,8 +231,10 @@ The numbers and packages above illustrate the shape; take yours from the venue's
|
|
|
219
231
|
|
|
220
232
|
| key | what it is |
|
|
221
233
|
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
234
|
+
| `type` | what the file is, required: `venue` (one venue's call for papers), `family` (a publisher's template that venues extend; it names no venue, so it has no `name` and no `url`), or `base` (the TeX base set, `tex` only, extended by nothing). A family may extend only a family; a venue a family or another venue |
|
|
222
235
|
| `extends` | the preset this one builds on: `paperlint:<name>` or `./path` / `../path`, relative to this file |
|
|
223
|
-
| `name` | how messages name the venue
|
|
236
|
+
| `name` | a venue's name, required on a venue: how messages name it, and one of the names `tex/venue-leftover` looks for. A family's messages use its file name |
|
|
237
|
+
| `url` | a venue's call for papers or author instructions (`https://`), required on a venue — the page its numbers are quoted from |
|
|
224
238
|
| `template` | the `\documentclass` the venue's template uses — a whole line (`\documentclass[conference,compsoc]{IEEEtran}`) or a bare class name; `tex/template` requires the paper's class and every option named here |
|
|
225
239
|
| `aliases` | other names the venue goes by in a paper's text — its acronym, its parent conference: `["AISec", "ACM CCS"]`. Collected along `extends`, with `name`. Read by `tex/venue-leftover` and `paper/folder-venue-leftover` |
|
|
226
240
|
| `portal` | where the venue takes submissions, `{ "kind": "hotcrp", "url": "https://…" }` — read by [`paperlint submission`](submission.md); a child's value replaces its parent's |
|
|
@@ -237,6 +251,9 @@ package; `format` keys are replaced one by one, and a child's kind replaces that
|
|
|
237
251
|
presets long, and a cycle is refused by name. `paperlint toolchain` installs the packages of every
|
|
238
252
|
shipped preset and of every preset your papers extend.
|
|
239
253
|
|
|
254
|
+
Keep a card beside your preset, `venues/usenix-sec.md`, for what the call says that no rule
|
|
255
|
+
checks — as the shipped presets do (`presets/<name>.md`, [configuration](configuration.md)).
|
|
256
|
+
|
|
240
257
|
Presets from npm packages are not supported yet.
|
|
241
258
|
|
|
242
259
|
## The paper is LaTeX
|
package/docs/submission.md
CHANGED
|
@@ -19,7 +19,7 @@ Two keys, each in the file that owns the fact, and a token:
|
|
|
19
19
|
| the paper's `paperlint.json` | `"submission": { "id": 7 }` | which submission on that portal is this paper's |
|
|
20
20
|
| the environment | `HOTCRP_TOKEN` | an API token for your HotCRP account |
|
|
21
21
|
|
|
22
|
-
`paperlint:aidc`
|
|
22
|
+
`paperlint:aidc` and `paperlint:msr` declare their portals. For another venue, add `portal` to your own preset (see
|
|
23
23
|
[`rules.md`](rules.md)) — or upload by hand: a kind paperlint has no adapter for is refused with
|
|
24
24
|
`portal kind "<kind>" is not supported; upload by hand`.
|
|
25
25
|
|
|
@@ -54,6 +54,10 @@ abstract (`--abstract <file>`, plain text) and the status "submitted" (`--submit
|
|
|
54
54
|
change touched (`change_list`), HotCRP's messages — and the local file's sha256. Exit 1 when the
|
|
55
55
|
change is not valid or the HTTP status is not 2xx.
|
|
56
56
|
|
|
57
|
+
Before it sends anything, dry run or not, it prints one line asking you to open that exact PDF and
|
|
58
|
+
check it against the venue's call for papers — named by the preset's `url` when the preset is a
|
|
59
|
+
venue: what paperlint checks is an aid, and the venue's reading of the PDF is what counts.
|
|
60
|
+
|
|
57
61
|
The safe order: `show`, `update` (dry run), read what it says, `update --save`, then `show` again and
|
|
58
62
|
check `match yes`.
|
|
59
63
|
|
|
@@ -204,3 +204,15 @@ test("a source code made from a parse result without the raw text reads the proj
|
|
|
204
204
|
[true, undefined, true],
|
|
205
205
|
);
|
|
206
206
|
});
|
|
207
|
+
|
|
208
|
+
test("🔴 a heading written over several lines keeps every newline, so the projection's lines are the source's", () => {
|
|
209
|
+
const src = "\\section{Related\nwork in\nthe field}\nText.\n";
|
|
210
|
+
const { text } = texToMdast(src);
|
|
211
|
+
// Guards: a line number computed on the projection (ESLint's getLocFromIndex) is the source's.
|
|
212
|
+
assert.equal(text.length, src.length);
|
|
213
|
+
assert.deepEqual(
|
|
214
|
+
[...text].flatMap((c, i) => (c === "\n" ? [i] : [])),
|
|
215
|
+
[...src].flatMap((c, i) => (c === "\n" ? [i] : [])),
|
|
216
|
+
);
|
|
217
|
+
assert.equal(text.split("\n")[3], "Text.");
|
|
218
|
+
});
|
|
@@ -567,10 +567,23 @@ export function texToMdast(
|
|
|
567
567
|
// project to ATX: `##` where `\se` was, the rest spaces; the closing `}` too
|
|
568
568
|
blank(pos.start.offset, end.offset + 1);
|
|
569
569
|
for (let i = 0; i < depth; i++) chars[pos.start.offset + i] = "#";
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
570
|
+
// 🔴 The title is written right-aligned against the closing `}`, into the cells that are
|
|
571
|
+
// not a newline: a heading written over several lines keeps every `\n` where it was. The
|
|
572
|
+
// projection's lines must be the source's — ESLint turns an offset into a line on this
|
|
573
|
+
// text (`getLocFromIndex`), and a rule that reports a raw offset after a two-line heading
|
|
574
|
+
// was reported one line up, outside the reach of a disable directive. Measured 2026-10-04.
|
|
575
|
+
const cells = [...Array(end.offset - pos.start.offset - depth).keys()]
|
|
576
|
+
.map((k) => end.offset - 1 - k)
|
|
577
|
+
.filter((o) => src[o] !== "\n")
|
|
578
|
+
.slice(0, title.length)
|
|
579
|
+
.reverse();
|
|
580
|
+
const tStart = cells[0] ?? end.offset;
|
|
581
|
+
title
|
|
582
|
+
.slice(title.length - cells.length)
|
|
583
|
+
.split("")
|
|
584
|
+
.forEach((ch, i) => {
|
|
585
|
+
chars[nth(cells, i)] = ch;
|
|
586
|
+
});
|
|
574
587
|
const tPos = { start: loc(tStart), end: loc(end.offset) };
|
|
575
588
|
children.push({
|
|
576
589
|
type: "heading",
|
|
@@ -250,6 +250,18 @@ describe("paper/leading-zero", () => {
|
|
|
250
250
|
});
|
|
251
251
|
});
|
|
252
252
|
|
|
253
|
+
describe("a finding after a heading written over several lines", () => {
|
|
254
|
+
it("🔴 is reported on its own line, with CRLF line ends too", async () => {
|
|
255
|
+
for (const nl of ["\n", "\r\n"]) {
|
|
256
|
+
const text = doc(
|
|
257
|
+
["\\section{Related", "work}", "We use .05 here."].join(nl),
|
|
258
|
+
);
|
|
259
|
+
const [m] = ids(await lint(text), "paper/leading-zero");
|
|
260
|
+
expect([m?.line, m?.column]).toEqual([5, 8]);
|
|
261
|
+
}
|
|
262
|
+
});
|
|
263
|
+
});
|
|
264
|
+
|
|
253
265
|
describe("paper/leading-zero — a number after ¶ or § is not a decimal (#102)", () => {
|
|
254
266
|
// From a consumer's bibliography: `--fix` rewrote the paragraph number `¶¶.42` to `¶¶0.42`.
|
|
255
267
|
const CITE =
|
package/eslint.config.mjs
CHANGED
|
@@ -21,7 +21,13 @@ import tseslint from "typescript-eslint";
|
|
|
21
21
|
import boundaries from "eslint-plugin-boundaries";
|
|
22
22
|
import functional from "eslint-plugin-functional";
|
|
23
23
|
import sonarjs from "eslint-plugin-sonarjs";
|
|
24
|
-
import {
|
|
24
|
+
import {
|
|
25
|
+
projectStructureParser,
|
|
26
|
+
projectStructurePlugin,
|
|
27
|
+
} from "eslint-plugin-project-structure";
|
|
28
|
+
import { presetCardRules } from "#src/preset-card-rule";
|
|
29
|
+
import { nodeFiles } from "#src/adapters/node/index";
|
|
30
|
+
import { dirname, join } from "node:path";
|
|
25
31
|
import { fileURLToPath } from "node:url";
|
|
26
32
|
|
|
27
33
|
// The complexity set, shared by the TypeScript block and the ratchet below. Every function
|
|
@@ -407,6 +413,57 @@ export const IO_GLOBALS = {
|
|
|
407
413
|
},
|
|
408
414
|
};
|
|
409
415
|
|
|
416
|
+
/**
|
|
417
|
+
* EVERY PRESET HAS A CARD, AND EVERY CARD'S RULES TABLE IS THE PRESET'S. Two checks, one block each:
|
|
418
|
+
*
|
|
419
|
+
* - `project-structure/folder-structure` (its `enforceExistence`): each `presets/<name>.jsonc` needs
|
|
420
|
+
* `presets/<name>.md` beside it, and is named in kebab case. Its rule listens for a `Program` node,
|
|
421
|
+
* so the presets are read with the plugin's own parser, which gives every file an empty one.
|
|
422
|
+
* Measured 2026-10-04: under `@eslint/json`'s `json/jsonc` language (root node `Document`) the same
|
|
423
|
+
* rule never ran — RC 0 with seven cards missing.
|
|
424
|
+
* - `preset/card-rules` (src/preset-card-rule.ts): the section between the card's markers is the
|
|
425
|
+
* resolved preset — what it is, its call for papers, its rules and where each was set. `--fix`
|
|
426
|
+
* writes it.
|
|
427
|
+
*
|
|
428
|
+
* `root` is a parameter only so a test can lint a copy of the presets: the plugin resolves
|
|
429
|
+
* `structureRoot` against `projectRoot`, and the card rule reads the presets and docs under it.
|
|
430
|
+
* On an error the plugin writes `projectStructure.cache.json` into `projectRoot` (gitignored).
|
|
431
|
+
*/
|
|
432
|
+
export const presetCards = (root) => [
|
|
433
|
+
{
|
|
434
|
+
files: ["presets/*.jsonc"],
|
|
435
|
+
plugins: { "project-structure": projectStructurePlugin },
|
|
436
|
+
languageOptions: { parser: projectStructureParser },
|
|
437
|
+
rules: {
|
|
438
|
+
"project-structure/folder-structure": [
|
|
439
|
+
"error",
|
|
440
|
+
{
|
|
441
|
+
projectRoot: root,
|
|
442
|
+
structureRoot: "presets",
|
|
443
|
+
structure: [
|
|
444
|
+
{ name: "{kebab-case}.jsonc", enforceExistence: "{node-name}.md" },
|
|
445
|
+
],
|
|
446
|
+
},
|
|
447
|
+
],
|
|
448
|
+
},
|
|
449
|
+
},
|
|
450
|
+
{
|
|
451
|
+
files: ["presets/*.md"],
|
|
452
|
+
plugins: {
|
|
453
|
+
markdown,
|
|
454
|
+
preset: {
|
|
455
|
+
rules: presetCardRules({
|
|
456
|
+
files: nodeFiles,
|
|
457
|
+
venuesDir: join(root, "presets"),
|
|
458
|
+
docsRoot: root,
|
|
459
|
+
}),
|
|
460
|
+
},
|
|
461
|
+
},
|
|
462
|
+
language: "markdown/gfm",
|
|
463
|
+
rules: { "preset/card-rules": "error" },
|
|
464
|
+
},
|
|
465
|
+
];
|
|
466
|
+
|
|
410
467
|
const ceiling = (rule, n) =>
|
|
411
468
|
rule === "max-lines-per-function"
|
|
412
469
|
? ["error", { ...MAX_LINES, max: n }]
|
|
@@ -667,6 +724,7 @@ export default [
|
|
|
667
724
|
languageOptions: { frontmatter: "yaml" },
|
|
668
725
|
rules: { "port/md-install-path": "warn" },
|
|
669
726
|
},
|
|
727
|
+
...presetCards(dirname(fileURLToPath(import.meta.url))),
|
|
670
728
|
{
|
|
671
729
|
files: ["**/*.tex"],
|
|
672
730
|
plugins: {
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
% without it the fixture would fail for a reason unrelated to the subject of the test.
|
|
4
4
|
\documentclass[sigconf,nonacm]{acmart}
|
|
5
5
|
\begin{document}
|
|
6
|
-
\title{A
|
|
6
|
+
\title{A Fixture That Must Come Out in the Class's Own Fonts}
|
|
7
7
|
\author{A. Author}
|
|
8
8
|
\affiliation{\institution{X University}\city{Almaty}\country{Kazakhstan}}
|
|
9
9
|
\maketitle
|
|
@@ -32,19 +32,19 @@
|
|
|
32
32
|
{
|
|
33
33
|
"severity": 2,
|
|
34
34
|
"says": [
|
|
35
|
-
"page width is 8.264 in,
|
|
35
|
+
"page width is 8.264 in, AgenticDev requires 8.5 in"
|
|
36
36
|
]
|
|
37
37
|
},
|
|
38
38
|
{
|
|
39
39
|
"severity": 2,
|
|
40
40
|
"says": [
|
|
41
|
-
"page height is 11.694 in,
|
|
41
|
+
"page height is 11.694 in, AgenticDev requires 11 in"
|
|
42
42
|
]
|
|
43
43
|
},
|
|
44
44
|
{
|
|
45
45
|
"severity": 2,
|
|
46
46
|
"says": [
|
|
47
|
-
"column(s),
|
|
47
|
+
"column(s), AgenticDev requires 2"
|
|
48
48
|
]
|
|
49
49
|
}
|
|
50
50
|
]
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$comment": "A real IEEEtran [10pt,conference] paper for MSR whose ten pages of main text include an appendix before the references, with two pages of only references: format/page-limit, tex/template and anonymity/identity have nothing to say. banal's own count (body 9, references 3) would fail it.",
|
|
3
|
+
"build": {
|
|
4
|
+
"outcome": "pdf",
|
|
5
|
+
"pages": 12
|
|
6
|
+
},
|
|
7
|
+
"fonts": {
|
|
8
|
+
"some": "NimbusRomNo9L",
|
|
9
|
+
"none": "^(CMR|CMBX|CMTI|CMTT|CMSS|LMRoman)"
|
|
10
|
+
},
|
|
11
|
+
"lint": {
|
|
12
|
+
"rules": {
|
|
13
|
+
"format/page-limit": [],
|
|
14
|
+
"tex/template": [],
|
|
15
|
+
"anonymity/identity": []
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
}
|