paperlint 8.0.0 → 9.0.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/CLAUDE.md +9 -25
- package/CONTRIBUTING.md +5 -4
- package/README.md +4 -3
- package/dist/adapters/bibtex/index.d.ts +3 -0
- package/dist/adapters/bibtex/index.d.ts.map +1 -0
- package/dist/adapters/bibtex/index.js +103 -0
- package/dist/adapters/bibtex/index.js.map +1 -0
- package/dist/adapters/latex/filecontents.d.ts +33 -0
- package/dist/adapters/latex/filecontents.d.ts.map +1 -0
- package/dist/adapters/latex/filecontents.js +65 -0
- package/dist/adapters/latex/filecontents.js.map +1 -0
- package/dist/adapters/latex/includes.d.ts +3 -3
- package/dist/adapters/latex/includes.d.ts.map +1 -1
- package/dist/adapters/latex/includes.js +18 -10
- package/dist/adapters/latex/includes.js.map +1 -1
- package/dist/adapters/latex/index.d.ts.map +1 -1
- package/dist/adapters/latex/index.js +2 -0
- package/dist/adapters/latex/index.js.map +1 -1
- package/dist/adapters/latex/nodes.d.ts +12 -0
- package/dist/adapters/latex/nodes.d.ts.map +1 -1
- package/dist/adapters/latex/nodes.js +39 -0
- package/dist/adapters/latex/nodes.js.map +1 -1
- package/dist/adapters/latex/parse.d.ts +7 -1
- package/dist/adapters/latex/parse.d.ts.map +1 -1
- package/dist/adapters/latex/parse.js +55 -6
- package/dist/adapters/latex/parse.js.map +1 -1
- package/dist/adapters/memory/index.d.ts +3 -0
- package/dist/adapters/memory/index.d.ts.map +1 -1
- package/dist/adapters/memory/index.js +9 -0
- package/dist/adapters/memory/index.js.map +1 -1
- package/dist/adapters/references/index.d.ts.map +1 -1
- package/dist/adapters/references/index.js +27 -24
- package/dist/adapters/references/index.js.map +1 -1
- package/dist/adapters/sources-record/index.d.ts +9 -0
- package/dist/adapters/sources-record/index.d.ts.map +1 -0
- package/dist/adapters/sources-record/index.js +68 -0
- package/dist/adapters/sources-record/index.js.map +1 -0
- package/dist/adapters/tex-output/blg.d.ts +9 -0
- package/dist/adapters/tex-output/blg.d.ts.map +1 -0
- package/dist/adapters/tex-output/blg.js +20 -0
- package/dist/adapters/tex-output/blg.js.map +1 -0
- package/dist/adapters/tex-output/fls.d.ts +8 -0
- package/dist/adapters/tex-output/fls.d.ts.map +1 -0
- package/dist/adapters/tex-output/fls.js +16 -0
- package/dist/adapters/tex-output/fls.js.map +1 -0
- package/dist/adapters/tex-output/index.d.ts +7 -0
- package/dist/adapters/tex-output/index.d.ts.map +1 -0
- package/dist/adapters/tex-output/index.js +7 -0
- package/dist/adapters/tex-output/index.js.map +1 -0
- package/dist/bib-rules.d.ts +47 -0
- package/dist/bib-rules.d.ts.map +1 -0
- package/dist/bib-rules.js +127 -0
- package/dist/bib-rules.js.map +1 -0
- package/dist/build.d.ts +29 -1
- package/dist/build.d.ts.map +1 -1
- package/dist/build.js +40 -24
- package/dist/build.js.map +1 -1
- package/dist/claim-provenance.d.ts +2 -2
- package/dist/cli.d.ts +6 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +30 -26
- package/dist/cli.js.map +1 -1
- package/dist/domain/paper-source.d.ts +1 -10
- package/dist/domain/paper-source.d.ts.map +1 -1
- package/dist/domain/paper-source.js +34 -24
- package/dist/domain/paper-source.js.map +1 -1
- package/dist/domain/paper-sources.d.ts +72 -0
- package/dist/domain/paper-sources.d.ts.map +1 -0
- package/dist/domain/paper-sources.js +18 -0
- package/dist/domain/paper-sources.js.map +1 -0
- package/dist/domain/sources-record.d.ts +102 -0
- package/dist/domain/sources-record.d.ts.map +1 -0
- package/dist/domain/sources-record.js +38 -0
- package/dist/domain/sources-record.js.map +1 -0
- package/dist/domain/tex-run.d.ts +25 -0
- package/dist/domain/tex-run.d.ts.map +1 -0
- package/dist/domain/tex-run.js +79 -0
- package/dist/domain/tex-run.js.map +1 -0
- package/dist/eslint-rules/paper-context.d.ts.map +1 -1
- package/dist/eslint-rules/paper-context.js +4 -3
- package/dist/eslint-rules/paper-context.js.map +1 -1
- package/dist/eslint-rules/paper-typography.d.ts +0 -9
- package/dist/eslint-rules/paper-typography.d.ts.map +1 -1
- package/dist/eslint-rules/paper-typography.js +12 -5
- package/dist/eslint-rules/paper-typography.js.map +1 -1
- package/dist/latex-log.d.ts +10 -0
- package/dist/latex-log.d.ts.map +1 -1
- package/dist/latex-log.js +10 -0
- package/dist/latex-log.js.map +1 -1
- package/dist/latex-loop.d.ts +2 -0
- package/dist/latex-loop.d.ts.map +1 -1
- package/dist/latex-loop.js.map +1 -1
- package/dist/package-dirs.d.ts.map +1 -1
- package/dist/package-dirs.js +3 -2
- package/dist/package-dirs.js.map +1 -1
- package/dist/paper-includes.d.ts +4 -7
- package/dist/paper-includes.d.ts.map +1 -1
- package/dist/paper-includes.js +29 -21
- package/dist/paper-includes.js.map +1 -1
- package/dist/paper-prose.d.ts +2 -2
- package/dist/paper-record.d.ts +25 -0
- package/dist/paper-record.d.ts.map +1 -0
- package/dist/paper-record.js +39 -0
- package/dist/paper-record.js.map +1 -0
- package/dist/paper-sources.d.ts +66 -0
- package/dist/paper-sources.d.ts.map +1 -0
- package/dist/paper-sources.js +92 -0
- package/dist/paper-sources.js.map +1 -0
- package/dist/ports/bib-reader.d.ts +18 -0
- package/dist/ports/bib-reader.d.ts.map +1 -0
- package/dist/ports/bib-reader.js +2 -0
- package/dist/ports/bib-reader.js.map +1 -0
- package/dist/ports/check-references.d.ts +9 -4
- package/dist/ports/check-references.d.ts.map +1 -1
- package/dist/ports/latex.d.ts +15 -0
- package/dist/ports/latex.d.ts.map +1 -1
- package/dist/ports/sources-codec.d.ts +11 -0
- package/dist/ports/sources-codec.d.ts.map +1 -0
- package/dist/ports/sources-codec.js +2 -0
- package/dist/ports/sources-codec.js.map +1 -0
- package/dist/ports/tex-output.d.ts +17 -0
- package/dist/ports/tex-output.d.ts.map +1 -0
- package/dist/ports/tex-output.js +2 -0
- package/dist/ports/tex-output.js.map +1 -0
- package/dist/recorded-bibliography.d.ts +89 -0
- package/dist/recorded-bibliography.d.ts.map +1 -0
- package/dist/recorded-bibliography.js +136 -0
- package/dist/recorded-bibliography.js.map +1 -0
- package/dist/reference-rules.d.ts +5 -5
- package/dist/reference-rules.d.ts.map +1 -1
- package/dist/reference-rules.js +150 -77
- package/dist/reference-rules.js.map +1 -1
- package/dist/references.d.ts +71 -16
- package/dist/references.d.ts.map +1 -1
- package/dist/references.js +110 -26
- package/dist/references.js.map +1 -1
- package/dist/register-bands.d.ts +3 -3
- package/dist/register-bands.d.ts.map +1 -1
- package/dist/register-bands.js.map +1 -1
- package/dist/register.d.ts +2 -2
- package/dist/sources-record.d.ts +38 -0
- package/dist/sources-record.d.ts.map +1 -0
- package/dist/sources-record.js +123 -0
- package/dist/sources-record.js.map +1 -0
- package/dist/sources-rules.d.ts +44 -0
- package/dist/sources-rules.d.ts.map +1 -0
- package/dist/sources-rules.js +76 -0
- package/dist/sources-rules.js.map +1 -0
- package/dist/tex-paper.d.ts +10 -15
- package/dist/tex-paper.d.ts.map +1 -1
- package/dist/tex-paper.js +24 -40
- package/dist/tex-paper.js.map +1 -1
- package/dist/tex-venue-rules.d.ts +3 -3
- package/dist/tex-venue-rules.d.ts.map +1 -1
- package/dist/tex-venue-rules.js.map +1 -1
- package/docs/configuration.md +12 -4
- package/docs/design/paper-sources.md +197 -0
- package/docs/package-shape-options.md +1 -1
- package/docs/references.md +34 -8
- package/docs/rules/bib/reachable-entry.md +64 -0
- package/docs/rules/paper/sources-fresh.md +81 -0
- package/docs/rules.md +62 -57
- package/eslint-rules/paper-context.ts +4 -3
- package/eslint-rules/paper-typography.test.mjs +12 -72
- package/eslint-rules/paper-typography.ts +13 -6
- package/eslint.config.mjs +22 -0
- package/fixtures/build-e2e/aidc/paper.tex +1 -1
- package/fixtures/build-e2e/anon-ack/paper.tex +1 -1
- package/fixtures/build-e2e/anon-author/paper.tex +1 -1
- package/fixtures/build-e2e/anon-bib/paper.tex +1 -1
- package/fixtures/build-e2e/anon-href/paper.tex +1 -1
- package/fixtures/build-e2e/anon-macro/paper.tex +1 -1
- package/fixtures/build-e2e/anon-pdfauthor/paper.tex +1 -1
- package/fixtures/paper-sources/p1/paper.tex +30 -0
- package/fixtures/paper-sources/p1/refs.bib +6 -0
- package/fixtures/paper-sources/p1/sections/dead.tex +6 -0
- package/fixtures/paper-sources/p1/sections/intro.tex +7 -0
- package/fixtures/paper-sources/p1/sections/parked.tex +6 -0
- package/fixtures/paper-sources/p1/tex-truth.json +37 -0
- package/fixtures/paper-sources/p1/versions/2026-01-01-review.tex +4 -0
- package/fixtures/paper-sources/v1-stale/paper.tex +14 -0
- package/fixtures/paper-sources/v1-stale/refs.bib +6 -0
- package/fixtures/paper-sources/v1-stale/tex-truth.json +32 -0
- package/fixtures/paper-sources/v10-ifthenelse/anon.bib +1 -0
- package/fixtures/paper-sources/v10-ifthenelse/paper.tex +9 -0
- package/fixtures/paper-sources/v10-ifthenelse/real.bib +1 -0
- package/fixtures/paper-sources/v10-ifthenelse/tex-truth.json +28 -0
- package/fixtures/paper-sources/v11-two-blocks/paper.tex +12 -0
- package/fixtures/paper-sources/v11-two-blocks/tex-truth.json +30 -0
- package/fixtures/paper-sources/v13-percent-text/paper.tex +6 -0
- package/fixtures/paper-sources/v13-percent-text/refs.bib +3 -0
- package/fixtures/paper-sources/v13-percent-text/tex-truth.json +30 -0
- package/fixtures/paper-sources/v15-after-end/paper.tex +6 -0
- package/fixtures/paper-sources/v15-after-end/refs.bib +1 -0
- package/fixtures/paper-sources/v15-after-end/tex-truth.json +17 -0
- package/fixtures/paper-sources/v16-included-block/bibblock.tex +3 -0
- package/fixtures/paper-sources/v16-included-block/paper.tex +7 -0
- package/fixtures/paper-sources/v16-included-block/refs.bib +1 -0
- package/fixtures/paper-sources/v16-included-block/tex-truth.json +35 -0
- package/fixtures/paper-sources/v17-include-order/bibsetup.tex +1 -0
- package/fixtures/paper-sources/v17-include-order/first.bib +1 -0
- package/fixtures/paper-sources/v17-include-order/later.bib +1 -0
- package/fixtures/paper-sources/v17-include-order/paper.tex +7 -0
- package/fixtures/paper-sources/v17-include-order/tex-truth.json +40 -0
- package/fixtures/paper-sources/v2-overwrite/paper.tex +14 -0
- package/fixtures/paper-sources/v2-overwrite/refs.bib +6 -0
- package/fixtures/paper-sources/v2-overwrite/tex-truth.json +30 -0
- package/fixtures/paper-sources/v22-parked-thebibliography/paper.tex +7 -0
- package/fixtures/paper-sources/v22-parked-thebibliography/tex-truth.json +17 -0
- package/fixtures/paper-sources/v23-parked-include/old.bib +1 -0
- package/fixtures/paper-sources/v23-parked-include/paper.tex +7 -0
- package/fixtures/paper-sources/v23-parked-include/parked.tex +1 -0
- package/fixtures/paper-sources/v23-parked-include/refs.bib +1 -0
- package/fixtures/paper-sources/v23-parked-include/tex-truth.json +28 -0
- package/fixtures/paper-sources/v24-quoted-fields/paper.tex +6 -0
- package/fixtures/paper-sources/v24-quoted-fields/refs.bib +5 -0
- package/fixtures/paper-sources/v24-quoted-fields/tex-truth.json +32 -0
- package/fixtures/paper-sources/v25-string-differs/paper.tex +10 -0
- package/fixtures/paper-sources/v25-string-differs/refs.bib +2 -0
- package/fixtures/paper-sources/v25-string-differs/tex-truth.json +32 -0
- package/fixtures/paper-sources/v26-comment-in-names/one.bib +1 -0
- package/fixtures/paper-sources/v26-comment-in-names/paper.tex +7 -0
- package/fixtures/paper-sources/v26-comment-in-names/tex-truth.json +32 -0
- package/fixtures/paper-sources/v26-comment-in-names/two.bib +1 -0
- package/fixtures/paper-sources/v27-shared-string/abbreviations.bib +2 -0
- package/fixtures/paper-sources/v27-shared-string/paper.tex +6 -0
- package/fixtures/paper-sources/v27-shared-string/references.bib +6 -0
- package/fixtures/paper-sources/v27-shared-string/tex-truth.json +31 -0
- package/fixtures/paper-sources/v28-shared-string-block/abbreviations.bib +2 -0
- package/fixtures/paper-sources/v28-shared-string-block/paper.tex +14 -0
- package/fixtures/paper-sources/v28-shared-string-block/tex-truth.json +33 -0
- package/fixtures/paper-sources/v29-generated-input/paper.tex +9 -0
- package/fixtures/paper-sources/v29-generated-input/tex-truth.json +24 -0
- package/fixtures/paper-sources/v3-declared/paper.bib +6 -0
- package/fixtures/paper-sources/v3-declared/paper.tex +6 -0
- package/fixtures/paper-sources/v3-declared/tex-truth.json +28 -0
- package/fixtures/paper-sources/v30-name-next-line/paper.tex +14 -0
- package/fixtures/paper-sources/v30-name-next-line/tex-truth.json +30 -0
- package/fixtures/paper-sources/v4-commented/paper.tex +14 -0
- package/fixtures/paper-sources/v4-commented/refs.bib +6 -0
- package/fixtures/paper-sources/v4-commented/tex-truth.json +28 -0
- package/fixtures/paper-sources/v5-percent-entry/paper.tex +20 -0
- package/fixtures/paper-sources/v5-percent-entry/tex-truth.json +37 -0
- package/fixtures/paper-sources/v6-unclosed/paper.tex +6 -0
- package/fixtures/paper-sources/v6-unclosed/refs.bib +5 -0
- package/fixtures/paper-sources/v6-unclosed/tex-truth.json +37 -0
- package/fixtures/paper-sources/v8-jobname/paper.tex +9 -0
- package/fixtures/paper-sources/v8-jobname/tex-truth.json +30 -0
- package/fixtures/paper-sources/v9-two-bibliographies/one.bib +1 -0
- package/fixtures/paper-sources/v9-two-bibliographies/paper.tex +7 -0
- package/fixtures/paper-sources/v9-two-bibliographies/tex-truth.json +35 -0
- package/fixtures/paper-sources/v9-two-bibliographies/two.bib +1 -0
- package/fixtures/paper-typography/clean-paper/paper.tex +1 -1
- package/fixtures/paper-typography/messy-paper/paper.tex +1 -1
- package/package.json +2 -10
- package/scripts/check.test.ts +23 -1
- package/scripts/check.ts +7 -3
- package/scripts/coverage-config.test.ts +19 -10
- package/scripts/layer-legacy-frozen.test.ts +41 -2
- package/scripts/layer-legacy-frozen.ts +31 -2
- package/skills/grade-paper-writing/SKILL.md +4 -3
- package/skills/grade-paper-writing/SKILL.md.spec.ts +3 -2
- package/skills/grade-paper-writing/prose-lint.mjs +11 -2
- package/skills/grade-paper-writing/prose-lint.test.ts +52 -4
- package/skills/paper-pipeline/scripts/extract-ref-facts.harness.mjs +83 -33
- package/skills/paper-pipeline/scripts/extract-ref-facts.mjs +67 -115
- package/skills/paper-pipeline/scripts/extract-ref-facts.test.mjs +128 -121
- package/skills/verify-citations/SKILL.md +7 -4
- package/skills/verify-citations/SKILL.md.spec.ts +6 -3
- package/skills/verify-citations/scripts/bib-authors.check.test.mjs +17 -19
- package/skills/verify-citations/scripts/bib-authors.cli.test.ts +129 -46
- package/skills/verify-citations/scripts/bib-authors.d.mts +22 -2
- package/skills/verify-citations/scripts/bib-authors.mjs +57 -111
- package/skills/verify-citations/scripts/verify-cites.cli.test.ts +16 -0
- package/skills/verify-citations/scripts/verify-cites.d.mts +19 -3
- package/skills/verify-citations/scripts/verify-cites.mjs +42 -108
- package/skills/verify-citations/scripts/verify-cites.test.mjs +23 -36
- package/src/adapters/bibtex/index.test.ts +163 -0
- package/src/adapters/bibtex/index.ts +155 -0
- package/src/adapters/latex/filecontents.ts +114 -0
- package/src/adapters/latex/includes.ts +18 -10
- package/src/adapters/latex/index.test.ts +73 -0
- package/src/adapters/latex/index.ts +2 -0
- package/src/adapters/latex/nodes.ts +64 -0
- package/src/adapters/latex/parse.test.ts +38 -0
- package/src/adapters/latex/parse.ts +67 -6
- package/src/adapters/memory/index.ts +17 -0
- package/src/adapters/references/index.test.ts +75 -21
- package/src/adapters/references/index.ts +37 -32
- package/src/adapters/sources-record/index.test.ts +87 -0
- package/src/adapters/sources-record/index.ts +82 -0
- package/src/adapters/tex-output/blg.ts +27 -0
- package/src/adapters/tex-output/fls.ts +24 -0
- package/src/adapters/tex-output/index.test.ts +171 -0
- package/src/adapters/tex-output/index.ts +12 -0
- package/src/bib-rules.test.ts +356 -0
- package/src/bib-rules.ts +228 -0
- package/src/bibliography-at.test.ts +286 -0
- package/src/build.test.ts +210 -0
- package/src/build.ts +100 -35
- package/src/claim-provenance.test.ts +33 -7
- package/src/claim-provenance.ts +2 -2
- package/src/cli.harness.mjs +20 -10
- package/src/cli.test.ts +14 -10
- package/src/cli.ts +37 -28
- package/src/domain/paper-source.test.ts +58 -20
- package/src/domain/paper-source.ts +38 -42
- package/src/domain/paper-sources.ts +94 -0
- package/src/domain/sources-record.test.ts +71 -0
- package/src/domain/sources-record.ts +136 -0
- package/src/domain/tex-run.test.ts +228 -0
- package/src/domain/tex-run.ts +139 -0
- package/src/heading-case.test.ts +24 -10
- package/src/latex-log.ts +20 -0
- package/src/latex-loop.harness.ts +1 -0
- package/src/latex-loop.ts +2 -0
- package/src/linted-set.test.ts +9 -1
- package/src/new-paper.harness.mjs +3 -2
- package/src/new-paper.test.ts +9 -5
- package/src/package-dirs.ts +3 -2
- package/src/paper-includes.test.ts +157 -38
- package/src/paper-includes.ts +39 -35
- package/src/paper-prose.test.ts +34 -5
- package/src/paper-prose.ts +2 -2
- package/src/paper-record.test.ts +173 -0
- package/src/paper-record.ts +66 -0
- package/src/paper-settings-commands.test.ts +5 -2
- package/src/paper-sources.ts +151 -0
- package/src/ports/bib-reader.ts +27 -0
- package/src/ports/check-references.ts +7 -3
- package/src/ports/latex.ts +19 -0
- package/src/ports/sources-codec.ts +11 -0
- package/src/ports/tex-output.ts +17 -0
- package/src/recorded-bibliography.ts +297 -0
- package/src/reference-rules.ts +217 -104
- package/src/references.test.ts +520 -177
- package/src/references.ts +185 -37
- package/src/register-bands.test.ts +5 -1
- package/src/register-bands.ts +3 -5
- package/src/register.test.ts +6 -1
- package/src/register.ts +2 -2
- package/src/rule-cases.test.ts +68 -12
- package/src/rule-docs.test.ts +0 -1
- package/src/sources-record.test.ts +308 -0
- package/src/sources-record.ts +231 -0
- package/src/sources-rules.test.ts +152 -0
- package/src/sources-rules.ts +117 -0
- package/src/tex-paper.test.ts +148 -78
- package/src/tex-paper.ts +31 -61
- package/src/tex-venue-rules.test.ts +36 -8
- package/src/tex-venue-rules.ts +3 -5
- package/dist/eslint-rules/bib-reachable-entry.d.ts +0 -22
- package/dist/eslint-rules/bib-reachable-entry.d.ts.map +0 -1
- package/dist/eslint-rules/bib-reachable-entry.js +0 -75
- package/dist/eslint-rules/bib-reachable-entry.js.map +0 -1
- package/eslint-rules/bib-reachable-entry.ts +0 -76
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { type BibEntry, type BibText } from "./domain/paper-sources.ts";
|
|
2
|
+
import type { AbsolutePath } from "./domain/paths.ts";
|
|
3
|
+
import type { Span } from "./domain/tex-document.ts";
|
|
4
|
+
import { type SourcesRecord } from "./domain/sources-record.ts";
|
|
5
|
+
import { type PaperRecord, type RecordReadDeps } from "./paper-record.ts";
|
|
6
|
+
import type { BibReader } from "./ports/bib-reader.ts";
|
|
7
|
+
import type { LatexReader } from "./ports/latex.ts";
|
|
8
|
+
/** What reading the recorded bibliography needs: the disk, the record's schema, the bibtex reader. */
|
|
9
|
+
export interface RecordedReadDeps extends RecordReadDeps {
|
|
10
|
+
readonly bib: BibReader;
|
|
11
|
+
}
|
|
12
|
+
/** And what finding where a `.bib` TeX wrote stands needs besides: the reader of `filecontents` blocks. */
|
|
13
|
+
export interface RecordedDeps extends RecordedReadDeps {
|
|
14
|
+
readonly latex: Pick<LatexReader, "filecontents">;
|
|
15
|
+
}
|
|
16
|
+
/** A database bibtex opened that is on disk now, as the bibtex reader reads it. */
|
|
17
|
+
export interface ReadDatabase {
|
|
18
|
+
/** As bibtex names it: `refs.bib`, `bibs/x.bib`. */
|
|
19
|
+
readonly name: string;
|
|
20
|
+
/** A `.bib` TeX wrote (a `filecontents` block), not one the author keeps. */
|
|
21
|
+
readonly written: boolean;
|
|
22
|
+
readonly bib: BibText;
|
|
23
|
+
}
|
|
24
|
+
export type RecordedBibliography = {
|
|
25
|
+
readonly kind: "unrecorded";
|
|
26
|
+
readonly record: Exclude<PaperRecord, {
|
|
27
|
+
readonly kind: "fresh";
|
|
28
|
+
}>;
|
|
29
|
+
} | {
|
|
30
|
+
readonly kind: "recorded";
|
|
31
|
+
readonly record: SourcesRecord;
|
|
32
|
+
/** In the order bibtex opened them, each once. */
|
|
33
|
+
readonly databases: readonly ReadDatabase[];
|
|
34
|
+
/**
|
|
35
|
+
* As bibtex names them: the databases it opened that the paper directory does not hold — found on
|
|
36
|
+
* its search path (BIBINPUTS). One that was there when the build recorded it and is gone now made
|
|
37
|
+
* the record stale instead: every database bibtex opened is hashed.
|
|
38
|
+
*/
|
|
39
|
+
readonly unread: readonly string[];
|
|
40
|
+
};
|
|
41
|
+
/** The bibliography the last build of the paper in `dir` read. */
|
|
42
|
+
export declare function recordedBibliography(dir: string, deps: RecordedReadDeps): RecordedBibliography;
|
|
43
|
+
/** An entry of a database bibtex opened, and where it stands in that database. */
|
|
44
|
+
export interface RecordedEntry {
|
|
45
|
+
readonly database: ReadDatabase;
|
|
46
|
+
readonly entry: BibEntry;
|
|
47
|
+
/** Its place among the database's entries: what pairs it with the same entry of a block. */
|
|
48
|
+
readonly index: number;
|
|
49
|
+
}
|
|
50
|
+
/** Every entry of the databases, in the order bibtex opened them and the entries stand. */
|
|
51
|
+
export declare const entriesOfDatabases: (databases: readonly ReadDatabase[]) => readonly RecordedEntry[];
|
|
52
|
+
/** Where a finding about an entry is reported in paper.tex. */
|
|
53
|
+
export type EntryReport = {
|
|
54
|
+
readonly kind: "here";
|
|
55
|
+
readonly span: Span;
|
|
56
|
+
}
|
|
57
|
+
/** At the top of paper.tex; `where` names the entry (`refs.bib:12:1`). */
|
|
58
|
+
| {
|
|
59
|
+
readonly kind: "elsewhere";
|
|
60
|
+
readonly span: Span;
|
|
61
|
+
readonly where: string;
|
|
62
|
+
};
|
|
63
|
+
/** A text of the paper that may hold a block: a file of the record, the main file as the editor has it. */
|
|
64
|
+
interface Holder {
|
|
65
|
+
readonly path: AbsolutePath;
|
|
66
|
+
readonly text: string;
|
|
67
|
+
}
|
|
68
|
+
/** The paper being linted: where it is, the record of its build, and its main file as the editor holds it. */
|
|
69
|
+
export interface LintedPaper {
|
|
70
|
+
readonly dir: string;
|
|
71
|
+
readonly record: SourcesRecord;
|
|
72
|
+
readonly main: Holder;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Where each finding about `found` is reported, in the same order. The main file is read as the editor
|
|
76
|
+
* holds it; the record's other `.tex` files are read from disk.
|
|
77
|
+
*/
|
|
78
|
+
export declare function entryReports(paper: LintedPaper, found: readonly RecordedEntry[], deps: RecordedDeps): readonly EntryReport[];
|
|
79
|
+
/**
|
|
80
|
+
* The text the author edits for each database bibtex opened, in the order it opened them: for a `.bib`
|
|
81
|
+
* TeX wrote, the block of `paper.tex` or of an included file that holds what bibtex read; for any other
|
|
82
|
+
* database, and for a written one no block holds, the file itself. What a script reads, so its entries
|
|
83
|
+
* stand where the author finds them.
|
|
84
|
+
*/
|
|
85
|
+
export declare function authoredTexts(dir: string, recorded: Extract<RecordedBibliography, {
|
|
86
|
+
readonly kind: "recorded";
|
|
87
|
+
}>, deps: RecordedDeps): readonly BibText[];
|
|
88
|
+
export {};
|
|
89
|
+
//# sourceMappingURL=recorded-bibliography.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"recorded-bibliography.d.ts","sourceRoot":"","sources":["../src/recorded-bibliography.ts"],"names":[],"mappings":"AA0BA,OAAO,EAEL,KAAK,QAAQ,EAEb,KAAK,OAAO,EACb,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAGL,KAAK,aAAa,EACnB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAEL,KAAK,WAAW,EAChB,KAAK,cAAc,EACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAGpD,sGAAsG;AACtG,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;CACzB;AAED,2GAA2G;AAC3G,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;CACnD;AAED,mFAAmF;AACnF,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,MAAM,oBAAoB,GAC5B;IACE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACnE,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,kDAAkD;IAClD,QAAQ,CAAC,SAAS,EAAE,SAAS,YAAY,EAAE,CAAC;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC,CAAC;AAkCN,kEAAkE;AAClE,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,gBAAgB,GACrB,oBAAoB,CAoBtB;AAED,kFAAkF;AAClF,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;IAChC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;IACzB,4FAA4F;IAC5F,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,2FAA2F;AAC3F,eAAO,MAAM,kBAAkB,GAC7B,WAAW,SAAS,YAAY,EAAE,KACjC,SAAS,aAAa,EAGtB,CAAC;AAIJ,+DAA+D;AAC/D,MAAM,MAAM,WAAW,GACnB;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;CAAE;AAChD,0EAA0E;GACxE;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAahF,2GAA2G;AAC3G,UAAU,MAAM;IACd,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAiDD,8GAA8G;AAC9G,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAyBD;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,WAAW,EAClB,KAAK,EAAE,SAAS,aAAa,EAAE,EAC/B,IAAI,EAAE,YAAY,GACjB,SAAS,WAAW,EAAE,CAUxB;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,OAAO,CAAC,oBAAoB,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,EACtE,IAAI,EAAE,YAAY,GACjB,SAAS,OAAO,EAAE,CAKpB"}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* THE BIBLIOGRAPHY THE LAST BUILD READ — the entries of the databases bibtex opened, from the build's
|
|
3
|
+
* record (`_build/sources.json`, docs/design/paper-sources.md §1), through the one bibtex reader. Nothing
|
|
4
|
+
* here reads TeX source to decide which bibliography a paper has: TeX answered, the build wrote it
|
|
5
|
+
* down, and `paperRecord` says whether the paper is still the one it was written for.
|
|
6
|
+
*
|
|
7
|
+
* unrecorded no record, or a stale one — the rules that need it are silent (`paper/sources-fresh`
|
|
8
|
+
* speaks), the scripts refuse ("run `npx paperlint build` first")
|
|
9
|
+
* recorded a current record, and the databases bibtex opened that are on disk now (none when
|
|
10
|
+
* bibtex ran none), and the names of those that are not
|
|
11
|
+
*
|
|
12
|
+
* The databases are read in the order bibtex opened them, each with the `@string`s the ones before it
|
|
13
|
+
* left in force — bibtex keeps one table of them across its databases, so `\\bibliography{abbrev,refs}`
|
|
14
|
+
* expands an entry of `refs.bib` with a `@string` of `abbrev.bib`. A database that is not on disk adds
|
|
15
|
+
* none: its `@string`s are bibtex's alone.
|
|
16
|
+
*
|
|
17
|
+
* WHERE A FINDING ABOUT AN ENTRY GOES (`entryReports`). ESLint lints `paper.tex` only, so every finding
|
|
18
|
+
* is a place in it. An entry of a `.bib` TeX wrote (a `filecontents` block) is reported on its own line
|
|
19
|
+
* in the block of `paper.tex` whose body bibtex takes as the same database (`sameDatabase`) — a lookup
|
|
20
|
+
* of where the text stands, which decides nothing: the record said what TeX read. When no block of
|
|
21
|
+
* `paper.tex` is that database — the block is in an included file, or `paper.tex` was edited after the
|
|
22
|
+
* build — and for the entry of every other `.bib`, the finding is at the top of `paper.tex`, the file,
|
|
23
|
+
* line and column of the entry at the front of the message (`refs.bib:12:1:`).
|
|
24
|
+
*/
|
|
25
|
+
import { extname, posix, relative, resolve } from "node:path";
|
|
26
|
+
import { callerPath } from "./caller-path.js";
|
|
27
|
+
import { sameDatabase, } from "./domain/paper-sources.js";
|
|
28
|
+
import { JOBNAME, spelledIn, } from "./domain/sources-record.js";
|
|
29
|
+
import { paperRecord, } from "./paper-record.js";
|
|
30
|
+
import { decoded, lineColumn } from "./tex-paper.js";
|
|
31
|
+
/**
|
|
32
|
+
* The databases `names`, in this order, each read with the `@string`s the ones before it left in force,
|
|
33
|
+
* as bibtex reads them. One that is not on disk adds none.
|
|
34
|
+
*/
|
|
35
|
+
const readInSequence = (dir, names, deps) => names.reduce((acc, name) => {
|
|
36
|
+
const path = callerPath(resolve(dir, name));
|
|
37
|
+
const text = decoded(deps.files.readBytes(path));
|
|
38
|
+
const bib = text === null ? null : deps.bib.readFile(path, text, acc.inForce);
|
|
39
|
+
return {
|
|
40
|
+
inForce: bib?.strings ?? acc.inForce,
|
|
41
|
+
read: [...acc.read, { name, bib }],
|
|
42
|
+
};
|
|
43
|
+
}, { inForce: {}, read: [] }).read;
|
|
44
|
+
/** The bibliography the last build of the paper in `dir` read. */
|
|
45
|
+
export function recordedBibliography(dir, deps) {
|
|
46
|
+
const r = paperRecord(dir, deps);
|
|
47
|
+
if (r.kind !== "fresh")
|
|
48
|
+
return { kind: "unrecorded", record: r };
|
|
49
|
+
const { bibtex, written } = r.record;
|
|
50
|
+
const opened = readInSequence(dir, (bibtex.ran ? bibtex.databases : []).filter((d, i, all) => all.findIndex((o) => resolve(dir, o) === resolve(dir, d)) === i), deps);
|
|
51
|
+
return {
|
|
52
|
+
kind: "recorded",
|
|
53
|
+
record: r.record,
|
|
54
|
+
databases: opened.flatMap(({ name, bib }) => bib === null ? [] : [{ name, written: written.includes(name), bib }]),
|
|
55
|
+
unread: opened.filter((d) => d.bib === null).map((d) => d.name),
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
/** Every entry of the databases, in the order bibtex opened them and the entries stand. */
|
|
59
|
+
export const entriesOfDatabases = (databases) => databases.flatMap((database) => database.bib.entries.map((entry, index) => ({ database, entry, index })));
|
|
60
|
+
/** The first line of an entry: `@misc{key,` — what a finding underlines. */
|
|
61
|
+
const headOf = (bib, e) => {
|
|
62
|
+
const first = bib.text
|
|
63
|
+
.slice(e.span.start, e.span.end)
|
|
64
|
+
.split("\n", 1)
|
|
65
|
+
.join("");
|
|
66
|
+
return { start: e.span.start, end: e.span.start + first.length };
|
|
67
|
+
};
|
|
68
|
+
const TOP = { start: 0, end: 0 };
|
|
69
|
+
/**
|
|
70
|
+
* The text of every `.tex` the record lists, in the order TeX first read them: from disk, except
|
|
71
|
+
* `override` (the main file as the editor holds it), which stands for its own path. A record is only
|
|
72
|
+
* current while every file it lists is on disk, so none is skipped for being absent.
|
|
73
|
+
*/
|
|
74
|
+
function holders(dir, record, override, deps) {
|
|
75
|
+
return record.inputs
|
|
76
|
+
.map((i) => callerPath(resolve(dir, i.path)))
|
|
77
|
+
.filter((p) => extname(p) === ".tex")
|
|
78
|
+
.map((path) => override !== null && override.path === path
|
|
79
|
+
? override
|
|
80
|
+
: { path, text: decoded(deps.files.readBytes(path)) })
|
|
81
|
+
.filter((h) => h.text !== null);
|
|
82
|
+
}
|
|
83
|
+
/** The block, in some text of the paper, that holds what bibtex read of `db`. */
|
|
84
|
+
const blockHolding = (db, texts, deps) => texts
|
|
85
|
+
.flatMap((holder) => deps.latex
|
|
86
|
+
.filecontents(holder.text, JOBNAME)
|
|
87
|
+
// The block that wrote this database: its file, then its text.
|
|
88
|
+
.filter((b) => spelledIn([posix.normalize(b.writes)], db.name) !== null)
|
|
89
|
+
// Read as bibtex read the database: with the `@string`s in force before it.
|
|
90
|
+
.map((b) => ({
|
|
91
|
+
holder,
|
|
92
|
+
bib: deps.bib.read(holder.path, holder.text, b.body, db.bib.inherited),
|
|
93
|
+
})))
|
|
94
|
+
.find((b) => sameDatabase(b.bib, db.bib)) ?? null;
|
|
95
|
+
/** Where a finding about `f` is reported, given the block of a text of the paper that holds its database (or none). */
|
|
96
|
+
function reportOf(paper, block, f) {
|
|
97
|
+
const there = block?.bib.entries[f.index];
|
|
98
|
+
if (block === null || there?.key !== f.entry.key)
|
|
99
|
+
return {
|
|
100
|
+
kind: "elsewhere",
|
|
101
|
+
span: TOP,
|
|
102
|
+
where: `${f.database.name}:${lineColumn(f.database.bib.text, headOf(f.database.bib, f.entry).start)}`,
|
|
103
|
+
};
|
|
104
|
+
const span = headOf(block.bib, there);
|
|
105
|
+
return block.holder.path === paper.main.path
|
|
106
|
+
? { kind: "here", span }
|
|
107
|
+
: {
|
|
108
|
+
kind: "elsewhere",
|
|
109
|
+
span: TOP,
|
|
110
|
+
where: `${relative(paper.dir, block.holder.path)}:${lineColumn(block.holder.text, span.start)}`,
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Where each finding about `found` is reported, in the same order. The main file is read as the editor
|
|
115
|
+
* holds it; the record's other `.tex` files are read from disk.
|
|
116
|
+
*/
|
|
117
|
+
export function entryReports(paper, found, deps) {
|
|
118
|
+
const texts = holders(paper.dir, paper.record, paper.main, deps);
|
|
119
|
+
// Only the written databases that have a finding are searched for their block.
|
|
120
|
+
const blocks = new Map(found
|
|
121
|
+
.map((f) => f.database)
|
|
122
|
+
.filter((d, i, all) => d.written && all.indexOf(d) === i)
|
|
123
|
+
.map((d) => [d, blockHolding(d, texts, deps)]));
|
|
124
|
+
return found.map((f) => reportOf(paper, blocks.get(f.database) ?? null, f));
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* The text the author edits for each database bibtex opened, in the order it opened them: for a `.bib`
|
|
128
|
+
* TeX wrote, the block of `paper.tex` or of an included file that holds what bibtex read; for any other
|
|
129
|
+
* database, and for a written one no block holds, the file itself. What a script reads, so its entries
|
|
130
|
+
* stand where the author finds them.
|
|
131
|
+
*/
|
|
132
|
+
export function authoredTexts(dir, recorded, deps) {
|
|
133
|
+
const texts = holders(dir, recorded.record, null, deps);
|
|
134
|
+
return recorded.databases.map((d) => (d.written ? blockHolding(d, texts, deps)?.bib : undefined) ?? d.bib);
|
|
135
|
+
}
|
|
136
|
+
//# sourceMappingURL=recorded-bibliography.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"recorded-bibliography.js","sourceRoot":"","sources":["../src/recorded-bibliography.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EACL,YAAY,GAIb,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EACL,OAAO,EACP,SAAS,GAEV,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,WAAW,GAGZ,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AA6CrD;;;GAGG;AACH,MAAM,cAAc,GAAG,CACrB,GAAW,EACX,KAAwB,EACxB,IAAsB,EACH,EAAE,CACrB,KAAK,CAAC,MAAM,CAIV,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;IACZ,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,MAAM,GAAG,GACP,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACpE,OAAO;QACL,OAAO,EAAE,GAAG,EAAE,OAAO,IAAI,GAAG,CAAC,OAAO;QACpC,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;KACnC,CAAC;AACJ,CAAC,EACD,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAC1B,CAAC,IAAI,CAAC;AAET,kEAAkE;AAClE,MAAM,UAAU,oBAAoB,CAClC,GAAW,EACX,IAAsB;IAEtB,MAAM,CAAC,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACjC,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACjE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,MAAM,MAAM,GAAG,cAAc,CAC3B,GAAG,EACH,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CACzC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CACZ,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAClE,EACD,IAAI,CACL,CAAC;IACF,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAA2B,EAAE,CACnE,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CACrE;QACD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;KAChE,CAAC;AACJ,CAAC;AAUD,2FAA2F;AAC3F,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,SAAkC,EACR,EAAE,CAC5B,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC7B,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CACzE,CAAC;AAUJ,4EAA4E;AAC5E,MAAM,MAAM,GAAG,CAAC,GAAY,EAAE,CAAW,EAAQ,EAAE;IACjD,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI;SACnB,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;SAC/B,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;SACd,IAAI,CAAC,EAAE,CAAC,CAAC;IACZ,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;AACnE,CAAC,CAAC;AAEF,MAAM,GAAG,GAAS,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;AAQvC;;;;GAIG;AACH,SAAS,OAAO,CACd,GAAW,EACX,MAAqB,EACrB,QAAuB,EACvB,IAAkB;IAElB,OAAO,MAAM,CAAC,MAAM;SACjB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;SAC5C,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;SACpC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACZ,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI;QACzC,CAAC,CAAC,QAAQ;QACV,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CACxD;SACA,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AACjD,CAAC;AAED,iFAAiF;AACjF,MAAM,YAAY,GAAG,CACnB,EAAgB,EAChB,KAAwB,EACxB,IAAkB,EACyC,EAAE,CAC7D,KAAK;KACF,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAClB,IAAI,CAAC,KAAK;KACP,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC;IACnC,+DAA+D;KAC9D,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;IACxE,4EAA4E;KAC3E,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,MAAM;IACN,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,IAAI,EACX,CAAC,CAAC,IAAI,EACN,EAAE,CAAC,GAAG,CAAC,SAAS,CACjB;CACF,CAAC,CAAC,CACN;KACA,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC;AAStD,uHAAuH;AACvH,SAAS,QAAQ,CACf,KAAkB,EAClB,KAAgE,EAChE,CAAgB;IAEhB,MAAM,KAAK,GAAG,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC1C,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG;QAC9C,OAAO;YACL,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE;SACtG,CAAC;IACJ,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACtC,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI;QAC1C,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;QACxB,CAAC,CAAC;YACE,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,GAAG;YACT,KAAK,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;SAChG,CAAC;AACR,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAkB,EAClB,KAA+B,EAC/B,IAAkB;IAElB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjE,+EAA+E;IAC/E,MAAM,MAAM,GAAG,IAAI,GAAG,CACpB,KAAK;SACF,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;SACtB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;SACxD,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAU,CAAC,CAC1D,CAAC;IACF,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAC3B,GAAW,EACX,QAAsE,EACtE,IAAkB;IAElB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACxD,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,CAC3B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAC5E,CAAC;AACJ,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type RecordedDeps } from "./recorded-bibliography.ts";
|
|
2
2
|
interface Loc {
|
|
3
3
|
readonly line: number;
|
|
4
4
|
readonly column: number;
|
|
@@ -7,6 +7,8 @@ interface RuleContext {
|
|
|
7
7
|
readonly filename: string;
|
|
8
8
|
readonly cwd: string;
|
|
9
9
|
readonly sourceCode: {
|
|
10
|
+
/** The file as written (the `tex/latex` language's source code). */
|
|
11
|
+
readonly raw: string;
|
|
10
12
|
getLocFromIndex(i: number): Loc;
|
|
11
13
|
};
|
|
12
14
|
report(d: {
|
|
@@ -32,10 +34,8 @@ export interface ReferenceRuleModule {
|
|
|
32
34
|
};
|
|
33
35
|
}
|
|
34
36
|
type Name = "author-list" | "cite-exists" | "refs-checked" | "refs-fresh";
|
|
35
|
-
/** The four rules, reading through `
|
|
36
|
-
export declare function referenceRules(
|
|
37
|
-
files: Files;
|
|
38
|
-
}): Record<Name, ReferenceRuleModule>;
|
|
37
|
+
/** The four rules, reading the paper through `deps`. They act on `paper.tex` only. */
|
|
38
|
+
export declare function referenceRules(deps: RecordedDeps): Record<Name, ReferenceRuleModule>;
|
|
39
39
|
/** The level each is on at for every `paper.tex` in paperlint's own config. */
|
|
40
40
|
export declare const REFERENCE_RULE_LEVELS: {
|
|
41
41
|
readonly "paper/author-list": "error";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reference-rules.d.ts","sourceRoot":"","sources":["../src/reference-rules.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"reference-rules.d.ts","sourceRoot":"","sources":["../src/reference-rules.ts"],"names":[],"mappings":"AAkCA,OAAO,EAGL,KAAK,YAAY,EAElB,MAAM,4BAA4B,CAAC;AAWpC,UAAU,GAAG;IACX,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AACD,UAAU,WAAW;IACnB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,UAAU,EAAE;QACnB,oEAAoE;QACpE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB,eAAe,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;KACjC,CAAC;IACF,MAAM,CAAC,CAAC,EAAE;QACR,GAAG,EAAE;YAAE,KAAK,EAAE,GAAG,CAAC;YAAC,GAAG,EAAE,GAAG,CAAA;SAAE,CAAC;QAC9B,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC/B,GAAG,IAAI,CAAC;CACV;AACD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE;QACb,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,YAAY,CAAC;QACxC,QAAQ,CAAC,IAAI,EAAE;YAAE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;SAAE,CAAC;QAChD,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;QACnC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;KACrD,CAAC;IACF,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG;QAAE,WAAW,CAAC,EAAE,MAAM,IAAI,CAAA;KAAE,CAAC;CAC5D;AAED,KAAK,IAAI,GAAG,aAAa,GAAG,aAAa,GAAG,cAAc,GAAG,YAAY,CAAC;AA+N1E,sFAAsF;AACtF,wBAAgB,cAAc,CAC5B,IAAI,EAAE,YAAY,GACjB,MAAM,CAAC,IAAI,EAAE,mBAAmB,CAAC,CA6BnC;AAED,+EAA+E;AAC/E,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC"}
|
package/dist/reference-rules.js
CHANGED
|
@@ -5,47 +5,76 @@
|
|
|
5
5
|
*
|
|
6
6
|
* entry whose authors are the preprint's paper/author-list (error), on the entry
|
|
7
7
|
* entry whose identifier provably fails paper/cite-exists (error), on the entry
|
|
8
|
-
* no
|
|
9
|
-
*
|
|
8
|
+
* no verdicts, or recorded "not checked" paper/refs-checked (warn) — like pdf/measured
|
|
9
|
+
* a key bibtex typeset that no entry the paper/refs-checked (warn): that reference was not
|
|
10
|
+
* reader read has (`unseenKeys`) checked
|
|
11
|
+
* a database bibtex found outside the paper/refs-checked (warn): its references were not checked
|
|
12
|
+
* paper directory (BIBINPUTS)
|
|
13
|
+
* databases edited after the build paper/refs-fresh (error) — like pdf/fresh
|
|
10
14
|
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
15
|
+
* The databases are the ones the last build's bibtex opened (`_build/sources.json`,
|
|
16
|
+
* docs/design/paper-sources.md §1) — `readBibliography` answers only from a record the paper has not
|
|
17
|
+
* changed since. With no record, or a stale one, every rule here is silent: `paper/sources-fresh`
|
|
18
|
+
* speaks once. While the verdicts are stale, the per-entry rules are silent too: they would judge
|
|
19
|
+
* databases that no longer exist, and refs-fresh already says so once. A paper whose build ran no
|
|
20
|
+
* bibtex gets nothing.
|
|
21
|
+
*
|
|
22
|
+
* `paper/author-list` and `paper/cite-exists` lay the verdicts on the entries of those databases. ESLint
|
|
23
|
+
* does not lint a `.bib`, so a finding is a place in `paper.tex`: an entry of a `.bib` TeX wrote from a
|
|
24
|
+
* block of `paper.tex` is reported on its line there (`entryReports`); any other entry at the top of
|
|
25
|
+
* `paper.tex`, with the entry's file, line and column at the front of the message (`refs.bib:12:1:`).
|
|
14
26
|
*
|
|
15
27
|
* `paper/author-list` used to live on PIPELINE-STATUS.md and ask whether the scorecard mentioned
|
|
16
28
|
* a run. It lives here now because its subject is the bibliography, and the record of the run is
|
|
17
29
|
* the run's own output.
|
|
18
30
|
*/
|
|
19
31
|
import { basename, dirname } from "node:path";
|
|
20
|
-
import {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
32
|
+
import { callerPath } from "./caller-path.js";
|
|
33
|
+
import { MAIN_FILE } from "./domain/paper-sources.js";
|
|
34
|
+
import { entryReports, } from "./recorded-bibliography.js";
|
|
35
|
+
import { bibHash, readBibliography, readReferences, REFERENCES_FILE, unseenKeys, } from "./references.js";
|
|
36
|
+
/**
|
|
37
|
+
* Each entry checked with its verdict — when the record holds one verdict per entry, in its order, as
|
|
38
|
+
* the build writes it. One that does not (written by hand) is not about these databases: null.
|
|
39
|
+
*/
|
|
40
|
+
function laid(verdicts, entries) {
|
|
41
|
+
const pairs = entries.flatMap((f, i) => {
|
|
42
|
+
const v = verdicts[i];
|
|
43
|
+
return v?.key === f.entry.key ? [[f, v]] : [];
|
|
44
|
+
});
|
|
45
|
+
return pairs.length === entries.length && verdicts.length === entries.length
|
|
46
|
+
? pairs
|
|
47
|
+
: null;
|
|
48
|
+
}
|
|
49
|
+
/** What the verdicts on disk say about the databases of `bib`. */
|
|
50
|
+
function judgedVerdicts(bib, doc) {
|
|
26
51
|
if (doc === null)
|
|
27
52
|
return { kind: "unrecorded" };
|
|
28
53
|
if (doc.bib.sha256 !== bibHash(bib))
|
|
29
54
|
return { kind: "stale" };
|
|
30
55
|
if (doc.status === "not-checked")
|
|
31
56
|
return { kind: "not-checked", why: doc.why ?? "no reason recorded" };
|
|
32
|
-
const
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
...(e.exists === "false"
|
|
37
|
-
? [{ key: e.key, rule: "cite-exists", why: e.why ?? "" }]
|
|
38
|
-
: []),
|
|
39
|
-
]);
|
|
40
|
-
return { kind: "ready", bib, failing };
|
|
57
|
+
const verdicts = laid(doc.entries, bib.entries);
|
|
58
|
+
return verdicts === null
|
|
59
|
+
? { kind: "stale" }
|
|
60
|
+
: { kind: "ready", judged: { bib, verdicts } };
|
|
41
61
|
}
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
62
|
+
function assess(deps, paperDir) {
|
|
63
|
+
const read = readBibliography(paperDir, deps);
|
|
64
|
+
switch (read.kind) {
|
|
65
|
+
case "no-record":
|
|
66
|
+
case "nothing":
|
|
67
|
+
case "not-wired":
|
|
68
|
+
return { kind: "silent" };
|
|
69
|
+
case "unread":
|
|
70
|
+
return { kind: "unread", databases: read.databases };
|
|
71
|
+
case "read":
|
|
72
|
+
return judgedVerdicts(read.bibliography, readReferences(deps.files, paperDir));
|
|
73
|
+
}
|
|
47
74
|
}
|
|
48
75
|
const BUILD = "`npx paperlint build`";
|
|
76
|
+
const MISMATCH = "`{{key}}`: the authors are not those of the version cited — {{why}}. The citation resolves and the id resolves, and the list is the PREPRINT's under a published venue";
|
|
77
|
+
const MISSING = "`{{key}}` does not resolve to the work cited — {{why}}";
|
|
49
78
|
const META = {
|
|
50
79
|
"author-list": {
|
|
51
80
|
type: "problem",
|
|
@@ -53,9 +82,7 @@ const META = {
|
|
|
53
82
|
description: "each entry's authors are those of the version it cites, not the preprint's (recorded by paperlint build)",
|
|
54
83
|
},
|
|
55
84
|
schema: [],
|
|
56
|
-
messages: {
|
|
57
|
-
mismatch: "`{{key}}`: the authors are not those of the version cited — {{why}}. The citation resolves and the id resolves, and the list is the PREPRINT's under a published venue",
|
|
58
|
-
},
|
|
85
|
+
messages: { mismatch: MISMATCH, mismatchIn: `{{where}}: ${MISMATCH}` },
|
|
59
86
|
},
|
|
60
87
|
"cite-exists": {
|
|
61
88
|
type: "problem",
|
|
@@ -63,9 +90,7 @@ const META = {
|
|
|
63
90
|
description: "each entry's identifier resolves to the work cited (recorded by paperlint build)",
|
|
64
91
|
},
|
|
65
92
|
schema: [],
|
|
66
|
-
messages: {
|
|
67
|
-
missing: "`{{key}}` does not resolve to the work cited — {{why}}",
|
|
68
|
-
},
|
|
93
|
+
messages: { missing: MISSING, missingIn: `{{where}}: ${MISSING}` },
|
|
69
94
|
},
|
|
70
95
|
"refs-checked": {
|
|
71
96
|
type: "suggestion",
|
|
@@ -76,12 +101,14 @@ const META = {
|
|
|
76
101
|
messages: {
|
|
77
102
|
unrecorded: `the references have not been checked — ${BUILD} checks them online and records the result in _build/${REFERENCES_FILE}`,
|
|
78
103
|
notChecked: `the last build could not check the references ({{why}}) — run ${BUILD} with network`,
|
|
104
|
+
unseen: "the last build's bibtex typeset {{what}}, which paperlint's reader did not read from the databases bibtex opened, so those references were not checked: an entry behind `%` or inside `@comment{…}` — bibtex has no comment syntax and reads it, the reader skips it. Delete the entry, or remove its `@`",
|
|
105
|
+
unread: `{{what}}, which the last build's bibtex opened, is not in the paper directory (bibtex found it on its search path, BIBINPUTS), so its references were not checked — move it beside paper.tex`,
|
|
79
106
|
},
|
|
80
107
|
},
|
|
81
108
|
"refs-fresh": {
|
|
82
109
|
type: "problem",
|
|
83
110
|
docs: {
|
|
84
|
-
description: "the recorded reference verdicts are about the
|
|
111
|
+
description: "the recorded reference verdicts are about the databases on disk, not an earlier set",
|
|
85
112
|
},
|
|
86
113
|
schema: [],
|
|
87
114
|
messages: {
|
|
@@ -89,61 +116,107 @@ const META = {
|
|
|
89
116
|
},
|
|
90
117
|
},
|
|
91
118
|
};
|
|
119
|
+
const AT_START = { kind: "here", span: { start: 0, end: 0 } };
|
|
92
120
|
const JUDGES = {
|
|
93
|
-
"
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
:
|
|
116
|
-
|
|
121
|
+
"refs-checked": (a) => {
|
|
122
|
+
switch (a.kind) {
|
|
123
|
+
case "unrecorded":
|
|
124
|
+
return [{ messageId: "unrecorded" }];
|
|
125
|
+
case "not-checked":
|
|
126
|
+
return [{ messageId: "notChecked", data: { why: a.why } }];
|
|
127
|
+
case "unread":
|
|
128
|
+
return [
|
|
129
|
+
{ messageId: "unread", data: { what: a.databases.join(", ") } },
|
|
130
|
+
];
|
|
131
|
+
case "ready": {
|
|
132
|
+
const unseen = unseenKeys(a.judged.bib);
|
|
133
|
+
return unseen.length === 0
|
|
134
|
+
? []
|
|
135
|
+
: [
|
|
136
|
+
{
|
|
137
|
+
messageId: "unseen",
|
|
138
|
+
data: { what: unseen.map((k) => `\`${k}\``).join(", ") },
|
|
139
|
+
},
|
|
140
|
+
];
|
|
141
|
+
}
|
|
142
|
+
case "silent":
|
|
143
|
+
case "stale":
|
|
144
|
+
return [];
|
|
145
|
+
}
|
|
146
|
+
},
|
|
147
|
+
"refs-fresh": (a) => (a.kind === "stale" ? [{ messageId: "stale" }] : []),
|
|
117
148
|
};
|
|
118
|
-
/**
|
|
119
|
-
|
|
120
|
-
|
|
149
|
+
/**
|
|
150
|
+
* One finding, at its entry in paper.tex — or, for an entry in a `.bib`, at the top, with the `…In`
|
|
151
|
+
* message that names the entry's file, line and column first.
|
|
152
|
+
*/
|
|
153
|
+
function report(context, r) {
|
|
154
|
+
const loc = (i) => context.sourceCode.getLocFromIndex(i);
|
|
155
|
+
const at = r.at ?? AT_START;
|
|
156
|
+
context.report({
|
|
157
|
+
loc: { start: loc(at.span.start), end: loc(at.span.end) },
|
|
158
|
+
...(at.kind === "here"
|
|
159
|
+
? { messageId: r.messageId, ...(r.data ? { data: r.data } : {}) }
|
|
160
|
+
: {
|
|
161
|
+
messageId: `${r.messageId}In`,
|
|
162
|
+
data: { ...r.data, where: at.where },
|
|
163
|
+
}),
|
|
164
|
+
});
|
|
165
|
+
}
|
|
166
|
+
/** The verdicts a rule reports, and the message each makes. */
|
|
167
|
+
const VERDICT_RULES = {
|
|
168
|
+
"author-list": {
|
|
169
|
+
failed: (v) => v.authors === "mismatch",
|
|
170
|
+
messageId: "mismatch",
|
|
171
|
+
},
|
|
172
|
+
"cite-exists": {
|
|
173
|
+
failed: (v) => v.exists === "false",
|
|
174
|
+
messageId: "missing",
|
|
175
|
+
},
|
|
176
|
+
};
|
|
177
|
+
/**
|
|
178
|
+
* The entries the verdicts judged failing for `rule`, each where it is reported (`entryReports`): the
|
|
179
|
+
* line of its `filecontents` block in the paper's text when TeX wrote its `.bib` from one, else the
|
|
180
|
+
* top of `paper.tex`.
|
|
181
|
+
*/
|
|
182
|
+
function verdictReports(rule, context, deps) {
|
|
183
|
+
const main = callerPath(context.filename);
|
|
184
|
+
const dir = dirname(main);
|
|
185
|
+
const a = assess(deps, dir);
|
|
186
|
+
if (a.kind !== "ready")
|
|
187
|
+
return [];
|
|
188
|
+
const { failed, messageId } = VERDICT_RULES[rule];
|
|
189
|
+
const flagged = a.judged.verdicts.filter(([, v]) => failed(v));
|
|
190
|
+
const at = entryReports({
|
|
191
|
+
dir,
|
|
192
|
+
record: a.judged.bib.record,
|
|
193
|
+
main: { path: main, text: context.sourceCode.raw },
|
|
194
|
+
}, flagged.map(([f]) => f), deps);
|
|
195
|
+
return flagged.map(([, v], i) => ({
|
|
196
|
+
at: at[i],
|
|
197
|
+
messageId,
|
|
198
|
+
data: { key: v.key, why: v.why ?? "" },
|
|
199
|
+
}));
|
|
200
|
+
}
|
|
201
|
+
/** The four rules, reading the paper through `deps`. They act on `paper.tex` only. */
|
|
202
|
+
export function referenceRules(deps) {
|
|
203
|
+
const make = (name, judge) => ({
|
|
121
204
|
meta: META[name],
|
|
122
|
-
create: (context) => basename(context.filename) !==
|
|
205
|
+
create: (context) => basename(context.filename) !== MAIN_FILE
|
|
123
206
|
? {}
|
|
124
207
|
: {
|
|
125
208
|
"root:exit": () => {
|
|
126
|
-
const
|
|
127
|
-
|
|
128
|
-
// An external refs.bib: the entry is not in this file, so the finding sits at its
|
|
129
|
-
// start and names the key.
|
|
130
|
-
const external = a.kind === "ready" && a.bib.source !== "paper.tex";
|
|
131
|
-
for (const r of JUDGES[name](a)) {
|
|
132
|
-
const loc = context.sourceCode.getLocFromIndex(external ? 0 : r.at);
|
|
133
|
-
context.report({
|
|
134
|
-
loc: { start: loc, end: loc },
|
|
135
|
-
messageId: r.messageId,
|
|
136
|
-
...(r.data ? { data: r.data } : {}),
|
|
137
|
-
});
|
|
138
|
-
}
|
|
209
|
+
for (const r of judge(context))
|
|
210
|
+
report(context, r);
|
|
139
211
|
},
|
|
140
212
|
},
|
|
141
213
|
});
|
|
214
|
+
const assessed = (name) => (context) => JUDGES[name](assess(deps, dirname(callerPath(context.filename))));
|
|
142
215
|
return {
|
|
143
|
-
"author-list": make("author-list"),
|
|
144
|
-
"cite-exists": make("cite-exists"),
|
|
145
|
-
"refs-checked": make("refs-checked"),
|
|
146
|
-
"refs-fresh": make("refs-fresh"),
|
|
216
|
+
"author-list": make("author-list", (c) => verdictReports("author-list", c, deps)),
|
|
217
|
+
"cite-exists": make("cite-exists", (c) => verdictReports("cite-exists", c, deps)),
|
|
218
|
+
"refs-checked": make("refs-checked", assessed("refs-checked")),
|
|
219
|
+
"refs-fresh": make("refs-fresh", assessed("refs-fresh")),
|
|
147
220
|
};
|
|
148
221
|
}
|
|
149
222
|
/** The level each is on at for every `paper.tex` in paperlint's own config. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reference-rules.js","sourceRoot":"","sources":["../src/reference-rules.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"reference-rules.js","sourceRoot":"","sources":["../src/reference-rules.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD,OAAO,EACL,YAAY,GAIb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,OAAO,EACP,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,UAAU,GAGX,MAAM,iBAAiB,CAAC;AAgDzB;;;GAGG;AACH,SAAS,IAAI,CACX,QAAiC,EACjC,OAAiC;IAEjC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QACtB,OAAO,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzD,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM;QAC1E,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,IAAI,CAAC;AACX,CAAC;AAED,kEAAkE;AAClE,SAAS,cAAc,CACrB,GAAwB,EACxB,GAA8B;IAE9B,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;IAChD,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAC9D,IAAI,GAAG,CAAC,MAAM,KAAK,aAAa;QAC9B,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,oBAAoB,EAAE,CAAC;IACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAChD,OAAO,QAAQ,KAAK,IAAI;QACtB,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE;QACnB,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC;AACnD,CAAC;AAED,SAAS,MAAM,CAAC,IAAkB,EAAE,QAAgB;IAClD,MAAM,IAAI,GAAG,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC9C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,WAAW,CAAC;QACjB,KAAK,SAAS,CAAC;QACf,KAAK,WAAW;YACd,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC5B,KAAK,QAAQ;YACX,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;QACvD,KAAK,MAAM;YACT,OAAO,cAAc,CACnB,IAAI,CAAC,YAAY,EACjB,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CACrC,CAAC;IACN,CAAC;AACH,CAAC;AAED,MAAM,KAAK,GAAG,uBAAuB,CAAC;AAEtC,MAAM,QAAQ,GACZ,wKAAwK,CAAC;AAC3K,MAAM,OAAO,GAAG,wDAAwD,CAAC;AAEzE,MAAM,IAAI,GAAwD;IAChE,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,0GAA0G;SAC7G;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,QAAQ,EAAE,EAAE;KACvE;IACD,aAAa,EAAE;QACb,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,kFAAkF;SACrF;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,cAAc,OAAO,EAAE,EAAE;KACnE;IACD,cAAc,EAAE;QACd,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EACT,kGAAkG;SACrG;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,UAAU,EAAE,0CAA0C,KAAK,wDAAwD,eAAe,EAAE;YACpI,UAAU,EAAE,iEAAiE,KAAK,eAAe;YACjG,MAAM,EACJ,2SAA2S;YAC7S,MAAM,EAAE,8LAA8L;SACvM;KACF;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,qFAAqF;SACxF;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,KAAK,EAAE,kEAAkE,KAAK,EAAE;SACjF;KACF;CACF,CAAC;AASF,MAAM,QAAQ,GAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;AAE3E,MAAM,MAAM,GAER;IACF,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE;QACpB,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;YACf,KAAK,YAAY;gBACf,OAAO,CAAC,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;YACvC,KAAK,aAAa;gBAChB,OAAO,CAAC,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC7D,KAAK,QAAQ;gBACX,OAAO;oBACL,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;iBAChE,CAAC;YACJ,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACxC,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC;oBACxB,CAAC,CAAC,EAAE;oBACJ,CAAC,CAAC;wBACE;4BACE,SAAS,EAAE,QAAQ;4BACnB,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;yBACzD;qBACF,CAAC;YACR,CAAC;YACD,KAAK,QAAQ,CAAC;YACd,KAAK,OAAO;gBACV,OAAO,EAAE,CAAC;QACd,CAAC;IACH,CAAC;IACD,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;CAC1E,CAAC;AAEF;;;GAGG;AACH,SAAS,MAAM,CAAC,OAAoB,EAAE,CAAS;IAC7C,MAAM,GAAG,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IACjE,MAAM,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC;IAC5B,OAAO,CAAC,MAAM,CAAC;QACb,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QACzD,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,MAAM;YACpB,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;YACjE,CAAC,CAAC;gBACE,SAAS,EAAE,GAAG,CAAC,CAAC,SAAS,IAAI;gBAC7B,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,EAAE;aACrC,CAAC;KACP,CAAC,CAAC;AACL,CAAC;AAED,+DAA+D;AAC/D,MAAM,aAAa,GAAG;IACpB,aAAa,EAAE;QACb,MAAM,EAAE,CAAC,CAAe,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,UAAU;QACrD,SAAS,EAAE,UAAU;KACtB;IACD,aAAa,EAAE;QACb,MAAM,EAAE,CAAC,CAAe,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO;QACjD,SAAS,EAAE,SAAS;KACrB;CACO,CAAC;AAEX;;;;GAIG;AACH,SAAS,cAAc,CACrB,IAAgC,EAChC,OAAoB,EACpB,IAAkB;IAElB,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO;QAAE,OAAO,EAAE,CAAC;IAClC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAClD,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,MAAM,EAAE,GAAG,YAAY,CACrB;QACE,GAAG;QACH,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM;QAC3B,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE;KACnD,EACD,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EACvB,IAAI,CACL,CAAC;IACF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAChC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QACT,SAAS;QACT,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE;KACvC,CAAC,CAAC,CAAC;AACN,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,cAAc,CAC5B,IAAkB;IAElB,MAAM,IAAI,GAAG,CACX,IAAU,EACV,KAAkD,EAC7B,EAAE,CAAC,CAAC;QACzB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;QAChB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,CAClB,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,SAAS;YACtC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE,WAAW,EAAE,GAAG,EAAE;oBAChB,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC;wBAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;gBACrD,CAAC;aACF;KACR,CAAC,CAAC;IACH,MAAM,QAAQ,GACZ,CAAC,IAAmC,EAAE,EAAE,CACxC,CAAC,OAAoB,EAAqB,EAAE,CAC1C,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,OAAO;QACL,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,EAAE,EAAE,CACvC,cAAc,CAAC,aAAa,EAAE,CAAC,EAAE,IAAI,CAAC,CACvC;QACD,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,EAAE,EAAE,CACvC,cAAc,CAAC,aAAa,EAAE,CAAC,EAAE,IAAI,CAAC,CACvC;QACD,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;QAC9D,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;KACzD,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,mBAAmB,EAAE,OAAO;IAC5B,mBAAmB,EAAE,OAAO;IAC5B,oBAAoB,EAAE,MAAM;IAC5B,kBAAkB,EAAE,OAAO;CACnB,CAAC"}
|