paperlint 8.0.0 → 9.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/CLAUDE.md +22 -0
- package/.github/CLAUDE.md.spec.ts +20 -0
- package/CLAUDE.md +59 -531
- package/CONTRIBUTING.md +7 -6
- package/README.md +4 -3
- package/dist/CLAUDE.md.spec.d.ts +3 -0
- package/dist/CLAUDE.md.spec.d.ts.map +1 -0
- package/dist/CLAUDE.md.spec.js +62 -0
- package/dist/CLAUDE.md.spec.js.map +1 -0
- 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 +41 -25
- 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/CLAUDE.md.spec.d.ts +3 -0
- package/dist/eslint-rules/CLAUDE.md.spec.d.ts.map +1 -0
- package/dist/eslint-rules/CLAUDE.md.spec.js +39 -0
- package/dist/eslint-rules/CLAUDE.md.spec.js.map +1 -0
- package/dist/eslint-rules/install-path-literals.d.ts +1 -1
- package/dist/eslint-rules/install-path-literals.js +4 -4
- package/dist/eslint-rules/install-path-literals.js.map +1 -1
- 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/eslint-rules/pdf-last-page-balance.js +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/lib/agent-cli-version.js +1 -1
- package/dist/lib/agent-cli-version.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-requirements.js +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/dist/toolchain.js +1 -1
- package/docs/configuration.md +12 -4
- package/docs/design/paper-sources.md +197 -0
- package/docs/e2e.md +1 -1
- package/docs/incidents.md +5 -5
- 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/CLAUDE.md +44 -0
- package/eslint-rules/CLAUDE.md.spec.ts +43 -0
- package/eslint-rules/install-path-literals.harness.mjs +1 -1
- package/eslint-rules/install-path-literals.ts +4 -4
- 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-rules/pdf-last-page-balance.ts +1 -1
- package/eslint.config.mjs +28 -3
- 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/hooks/CLAUDE.md +34 -0
- package/hooks/CLAUDE.md.spec.ts +30 -0
- package/lib/agent-cli-version.ts +1 -1
- package/package.json +3 -11
- package/plugin/CLAUDE.md +22 -0
- package/plugin/CLAUDE.md.spec.ts +22 -0
- package/scripts/check.test.ts +23 -1
- package/scripts/check.ts +7 -3
- package/scripts/coverage-config.test.ts +21 -11
- package/scripts/layer-legacy-frozen.test.ts +41 -2
- package/scripts/layer-legacy-frozen.ts +31 -2
- package/skills/CLAUDE.md +19 -0
- package/skills/CLAUDE.md.spec.ts +18 -0
- 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/plan-paper-timeline/plan-paper-timeline.effects.harness.mjs +21 -102
- 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/CLAUDE.md +23 -1
- package/src/CLAUDE.md.spec.ts +72 -0
- 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 +101 -36
- 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-requirements.ts +1 -1
- package/src/tex-venue-rules.test.ts +36 -8
- package/src/tex-venue-rules.ts +3 -5
- package/src/toolchain.ts +1 -1
- 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,72 @@
|
|
|
1
|
+
// Compiled to src/CLAUDE.md by `npx vigiles compile`. Edit THIS file, never the markdown.
|
|
2
|
+
import { enforce, file, instructionFile, prose } from "vigiles/spec";
|
|
3
|
+
|
|
4
|
+
export default instructionFile({
|
|
5
|
+
sections: {
|
|
6
|
+
"`src/`": prose`The package's TypeScript: the CLI, the build, the toolchain installer, and the measuring that feeds
|
|
7
|
+
the facts file. Loaded when working under \`src/\`; the repository-wide rules are in the root
|
|
8
|
+
\`CLAUDE.md\`.`,
|
|
9
|
+
|
|
10
|
+
"The two layer axes": prose`**\`src/\` is hexagonal on two axes, and the linter enforces both** (\`eslint.config.mjs\`; fixtures in
|
|
11
|
+
\`test/fixtures/layers/\`, run by ${file("test/eslint-layers.test.ts")}; issue #76).
|
|
12
|
+
|
|
13
|
+
**Axis A — knowledge. Core means the DOMAIN, not "no I/O".** A file belongs to an adapter when it
|
|
14
|
+
exists because of one external program or format: _if banal / pdf.js / TeX Live / ESLint / Claude
|
|
15
|
+
Code disappeared tomorrow, which files would change? Those are its adapter, wherever they sit
|
|
16
|
+
today._ The domain is what would not change if every one of them were swapped. Purity is not the
|
|
17
|
+
test — a parser for banal's JSON is pure and is still banal's.
|
|
18
|
+
|
|
19
|
+
| element | where | holds | may import |
|
|
20
|
+
| --------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
+
| \`domain\` | \`src/domain/\` | values and decisions in the paper's vocabulary | \`domain\`; \`ts-essentials\`, \`node:path\`, \`node:crypto\` |
|
|
22
|
+
| \`port\` | \`src/ports/\` | interfaces **shaped by what the inside needs**, never by what a tool does (Graça: "created to fit the Application Core needs and not simply mimic the tools APIs") | \`domain\`, \`port\`; the same three externals |
|
|
23
|
+
| \`app\` | \`src/*.ts\` | use cases over ports; **no I/O defaults** — a use case without its deps does not compile | \`domain\`, \`port\`, \`app\`, the package's \`.mjs\`; Node's \`util\`/\`url\`/\`module\` |
|
|
24
|
+
| \`adapter\` | \`src/adapters/<tool>/\` | everything that knows \`<tool>\` exists, pure parsers included; used through its \`index.ts\` | \`domain\`, \`port\`, its own folder, its tool's packages, the package's \`.mjs\`. **Never** \`app\`, **never** another adapter |
|
|
25
|
+
| \`root\` | \`src/cli.ts\` | reads \`process.*\`, builds adapters, wires ports | anything |
|
|
26
|
+
|
|
27
|
+
Folders are ELEMENTS of \`eslint-plugin-boundaries\`, single files are CATEGORIES (\`root\`, \`app\`,
|
|
28
|
+
\`test\`, \`io\`): v7 matches element patterns as folders. Everyone — tests included — reaches an
|
|
29
|
+
adapter through its \`index.ts\`; the files inside one adapter import each other freely.
|
|
30
|
+
|
|
31
|
+
**Axis B — purity.** An effect (disk, process, network, env, clock, TTY) may be written only in
|
|
32
|
+
\`src/adapters/<tool>/<x>.io.ts\` and \`src/cli.ts\`. Every other file, adapters' parsers included,
|
|
33
|
+
takes a port. Test: _can a call here fail for a reason not in its arguments?_ Imports are checked
|
|
34
|
+
through the \`io\` file category in \`boundaries/dependencies\`; the \`process\` and \`fetch\` globals by
|
|
35
|
+
\`no-restricted-globals\`.
|
|
36
|
+
|
|
37
|
+
**The legacy app files are held by a ratchet, not exempted.** A site that still breaks either axis
|
|
38
|
+
carries \`// eslint-disable-next-line <rule> -- legacy <I/O|layer>, moves behind a port in #76\`.
|
|
39
|
+
Unused directives are errors (\`reportUnusedDisableDirectives\`), so a fixed site must drop its
|
|
40
|
+
comment; the per-file counts are frozen in \`scripts/layer-legacy.frozen.json\` and checked by
|
|
41
|
+
${file("scripts/layer-legacy-frozen.ts")} (\`npm run check\`, CI), which counts ESLint's own
|
|
42
|
+
\`suppressedMessages\` and fails when a file's count grows, a file not in the list carries one, or
|
|
43
|
+
anything under \`src/domain/\`, \`src/ports/\` or \`src/adapters/\` does. A NEW module that needs the
|
|
44
|
+
world is a new \`*.io.ts\` in the adapter of the program it talks to — never a new directive.
|
|
45
|
+
|
|
46
|
+
Parse at the boundary, into types that cannot hold an invalid state (a banal path that exists only
|
|
47
|
+
after its sha256 and probe passed; a \`Ready\` only an installer mints; an outcome as a discriminated
|
|
48
|
+
union, not a string); the inside never re-validates.
|
|
49
|
+
|
|
50
|
+
⚠️ **Two settings are load-bearing.** \`boundaries/root-path\`: without it the plugin matches paths
|
|
51
|
+
against \`process.cwd()\`, so lint started from any other directory classifies nothing and passes.
|
|
52
|
+
\`checkAllOrigins: true\`: without it no \`module:\` policy is evaluated, so axis B and the library bans
|
|
53
|
+
report nothing — dropping it turns the fixtures \`src/domain/reads-disk.ts\` and
|
|
54
|
+
\`src/adapters/one/disk.ts\` clean (measured).`,
|
|
55
|
+
|
|
56
|
+
"Readers and commands": prose`\`@retorquere/bibtex-parser\` is the one \`.bib\` reader, behind ${file("src/ports/bib-reader.ts")}.
|
|
57
|
+
Rejected on 2026-09-27, so not proposed again: a separate \`paperlint refs\` command; the slowness it
|
|
58
|
+
would have moved was a cache thrown away after every build (${file("docs/references.md")}).`,
|
|
59
|
+
},
|
|
60
|
+
rules: {
|
|
61
|
+
layers: enforce(
|
|
62
|
+
"eslint/boundaries/dependencies",
|
|
63
|
+
"Both axes: what a layer may import, and where an effect may be written.",
|
|
64
|
+
{ render: "id" },
|
|
65
|
+
),
|
|
66
|
+
"effect-globals": enforce(
|
|
67
|
+
"eslint/no-restricted-globals",
|
|
68
|
+
"The process and fetch globals only where an effect may be written.",
|
|
69
|
+
{ render: "id" },
|
|
70
|
+
),
|
|
71
|
+
},
|
|
72
|
+
});
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The bibtex reader over @retorquere/bibtex-parser: where each entry stands, its fields as text, its
|
|
3
|
+
* name lists as names, the `@string` and `@preamble` a copy is compared on, and an entry it cannot
|
|
4
|
+
* finish. What bibtex reads beyond it is the post-build check's (src/references.ts), measured on the
|
|
5
|
+
* planted papers in src/paper-sources.test.ts.
|
|
6
|
+
*/
|
|
7
|
+
import { readFileSync } from "node:fs";
|
|
8
|
+
import { dirname, join } from "node:path";
|
|
9
|
+
import { fileURLToPath } from "node:url";
|
|
10
|
+
import { describe, expect, it } from "vitest";
|
|
11
|
+
import { absolutePath } from "../../domain/paths.ts";
|
|
12
|
+
import { bibReader } from "./index.ts";
|
|
13
|
+
|
|
14
|
+
const PATH = absolutePath("/p/refs.bib");
|
|
15
|
+
const read = (text: string) => bibReader.readFile(PATH, text);
|
|
16
|
+
|
|
17
|
+
describe("the bibtex reader", () => {
|
|
18
|
+
it("places each entry in the text, a block's within the file that holds it", () => {
|
|
19
|
+
const tex =
|
|
20
|
+
"\\begin{filecontents*}{refs.bib}\n@misc{a, title={A}}\n@Article(b, title={B})\n\\end{filecontents*}\n";
|
|
21
|
+
const body = { start: tex.indexOf("@misc"), end: tex.indexOf("\\end") };
|
|
22
|
+
const bib = bibReader.read(absolutePath("/p/paper.tex"), tex, body);
|
|
23
|
+
expect(
|
|
24
|
+
bib.entries.map((e) => [
|
|
25
|
+
e.type,
|
|
26
|
+
e.key,
|
|
27
|
+
tex.slice(e.span.start, e.span.end),
|
|
28
|
+
]),
|
|
29
|
+
).toEqual([
|
|
30
|
+
["misc", "a", "@misc{a, title={A}}"],
|
|
31
|
+
["article", "b", "@Article(b, title={B})"],
|
|
32
|
+
]);
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
it("reads fields as text: LaTeX accents, a link, a list field joined", () => {
|
|
36
|
+
const [e] = read(
|
|
37
|
+
'@book{k, title={M{\\"u}ller}, howpublished={\\url{https://x.org}}, publisher={A and B}}',
|
|
38
|
+
).entries;
|
|
39
|
+
// The parser writes `{\"u}` as u and a combining diaeresis: compared composed.
|
|
40
|
+
expect(
|
|
41
|
+
Object.fromEntries(
|
|
42
|
+
Object.entries(e?.fields ?? {}).map(([k, v]) => [
|
|
43
|
+
k,
|
|
44
|
+
v.normalize("NFC"),
|
|
45
|
+
]),
|
|
46
|
+
),
|
|
47
|
+
).toEqual({
|
|
48
|
+
title: "Müller",
|
|
49
|
+
howpublished: '<a href="https://x.org">https://x.org</a>',
|
|
50
|
+
publisher: "A and B",
|
|
51
|
+
});
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
it("reads a name list as names: family part, particle, suffix, a literal kept whole", () => {
|
|
55
|
+
const [e] = read(
|
|
56
|
+
"@misc{k, author={Lovelace, Ada and von Neumann, Jr., John and {World Health Organization} and others}}",
|
|
57
|
+
).entries;
|
|
58
|
+
expect(e?.names).toEqual({
|
|
59
|
+
author: [
|
|
60
|
+
{ lastName: "Lovelace", firstName: "Ada" },
|
|
61
|
+
{
|
|
62
|
+
lastName: "Neumann",
|
|
63
|
+
firstName: "John",
|
|
64
|
+
prefix: "von",
|
|
65
|
+
suffix: "Jr.",
|
|
66
|
+
},
|
|
67
|
+
{ name: "World Health Organization" },
|
|
68
|
+
{ lastName: "others" },
|
|
69
|
+
],
|
|
70
|
+
});
|
|
71
|
+
});
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
describe("the bibtex reader — what a copy is compared on, and what it leaves to bibtex", () => {
|
|
75
|
+
it("reads @preamble commands, and expands each @string where an entry uses it", () => {
|
|
76
|
+
const bib = read(
|
|
77
|
+
'@string{v = "Venue"}\n@preamble{"\\x"}\n@misc{k, note = v}\n@string{v = "Later"}',
|
|
78
|
+
);
|
|
79
|
+
expect([bib.preamble, bib.entries[0]?.fields]).toEqual([
|
|
80
|
+
['"\\x"'],
|
|
81
|
+
{ note: "Venue" },
|
|
82
|
+
]);
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
it("keeps each entry as bibtex takes it: the value it used, LaTeX and braces as written, whitespace folded", () => {
|
|
86
|
+
const bib = read(
|
|
87
|
+
'@string{v = "Venue"}\n@Misc{k, note = v # " 2", author = {G{\\"o}del, Kurt}, title = {{X}}, keywords = {b, a}}\n@string{v = "Later"}',
|
|
88
|
+
);
|
|
89
|
+
expect(bib.written).toEqual([
|
|
90
|
+
{
|
|
91
|
+
type: "misc",
|
|
92
|
+
key: "k",
|
|
93
|
+
fields: {
|
|
94
|
+
note: "Venue 2",
|
|
95
|
+
author: 'G{\\"o}del, Kurt',
|
|
96
|
+
title: "{X}",
|
|
97
|
+
keywords: "a, b",
|
|
98
|
+
},
|
|
99
|
+
},
|
|
100
|
+
]);
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
it("an entry it cannot finish is no entry — bibtex reports that file (v6, exit 2)", () => {
|
|
104
|
+
const text = readFileSync(
|
|
105
|
+
join(
|
|
106
|
+
dirname(fileURLToPath(import.meta.url)),
|
|
107
|
+
"../../../fixtures/paper-sources/v6-unclosed/refs.bib",
|
|
108
|
+
),
|
|
109
|
+
"utf8",
|
|
110
|
+
);
|
|
111
|
+
expect(read(text).entries.map((e) => e.key)).toEqual(["a1", "a3"]);
|
|
112
|
+
});
|
|
113
|
+
});
|
|
114
|
+
|
|
115
|
+
describe("the bibtex reader — databases in sequence, as bibtex reads them", () => {
|
|
116
|
+
// bibtex reads the databases of `\\bibliography{abbreviations,references}` one after the other, and an
|
|
117
|
+
// `@string` the first defines is in force in the second (fixtures/paper-sources/v27-shared-string:
|
|
118
|
+
// its .bbl typesets the expanded author and booktitle).
|
|
119
|
+
const ABBR =
|
|
120
|
+
'@string{venue = "Proceedings of the {\\"O}ld Venue"}\n@string{who = "Lovelace, Ada"}\n';
|
|
121
|
+
const REFS =
|
|
122
|
+
"@inproceedings{late, author = who, booktitle = venue # {, Main}}\n";
|
|
123
|
+
const SECOND = absolutePath("/p/references.bib");
|
|
124
|
+
|
|
125
|
+
it("🔴 an @string an earlier database defined is in force in a later one: read as one file holding both", () => {
|
|
126
|
+
const first = read(ABBR);
|
|
127
|
+
const second = bibReader.readFile(SECOND, REFS, first.strings);
|
|
128
|
+
const whole = read(ABBR + REFS);
|
|
129
|
+
expect([
|
|
130
|
+
second.entries.map((e) => [e.fields, e.names]),
|
|
131
|
+
second.written,
|
|
132
|
+
]).toEqual([whole.entries.map((e) => [e.fields, e.names]), whole.written]);
|
|
133
|
+
expect(second.written[0]?.fields).toEqual({
|
|
134
|
+
author: "Lovelace, Ada",
|
|
135
|
+
booktitle: 'Proceedings of the {\\"O}ld Venue, Main',
|
|
136
|
+
});
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
it("the @strings in force after a database are those before it and its own, a redefinition winning; a block reads with them too", () => {
|
|
140
|
+
const first = read(ABBR);
|
|
141
|
+
const second = bibReader.readFile(
|
|
142
|
+
SECOND,
|
|
143
|
+
'@string{venue = "Newer"}\n',
|
|
144
|
+
first.strings,
|
|
145
|
+
);
|
|
146
|
+
expect([second.inherited, second.strings]).toEqual([
|
|
147
|
+
first.strings,
|
|
148
|
+
{ VENUE: "Newer", WHO: "Lovelace, Ada" },
|
|
149
|
+
]);
|
|
150
|
+
const tex = `\\begin{filecontents*}{refs.bib}\n${REFS}\\end{filecontents*}\n`;
|
|
151
|
+
const body = { start: tex.indexOf("@"), end: tex.indexOf("\\end") };
|
|
152
|
+
expect(
|
|
153
|
+
bibReader.read(absolutePath("/p/paper.tex"), tex, body, second.strings)
|
|
154
|
+
.written[0]?.fields.booktitle,
|
|
155
|
+
).toBe("Newer, Main");
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
it("read alone, a database has nothing inherited: a name no @string defines stays unresolved", () => {
|
|
159
|
+
const alone = bibReader.readFile(SECOND, REFS);
|
|
160
|
+
expect([alone.inherited, alone.strings]).toEqual([{}, {}]);
|
|
161
|
+
expect(alone.written[0]?.fields.author).not.toBe("Lovelace, Ada");
|
|
162
|
+
});
|
|
163
|
+
});
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The bibtex reader over `@retorquere/bibtex-parser` — the one `.bib` reader of paperlint
|
|
3
|
+
* (`src/ports/bib-reader.ts`).
|
|
4
|
+
*
|
|
5
|
+
* It reads a well-formed database as bibtex does: entries, fields (LaTeX read into text, so `{\"u}`
|
|
6
|
+
* is `ü` and `\url{x}` a link), name lists split into names, `@string`s expanded, `@preamble`. A
|
|
7
|
+
* second reading keeps each field as bibtex takes it, LaTeX as written: what two databases are
|
|
8
|
+
* compared by (`sameDatabase`), where `{\"u}` and `ü` must stay different. A malformed
|
|
9
|
+
* database is bibtex's to report: the build runs bibtex and fails with bibtex's own lines. The two
|
|
10
|
+
* readers also differ on one well-formed shape: bibtex has no comment syntax, so an entry behind
|
|
11
|
+
* `%` or inside `@comment{…}` is one bibtex reads and this reader does not. The build records what
|
|
12
|
+
* bibtex read, and `paper/refs-checked` names such an entry (`src/references.ts`).
|
|
13
|
+
*
|
|
14
|
+
* The parser gives each entry's text (`input`), not its place: each is found in the body in order.
|
|
15
|
+
*
|
|
16
|
+
* A database read after others starts with the `@string`s they left in force (`inherited`), as bibtex
|
|
17
|
+
* reads a paper's databases in sequence with one table of them: the parser takes them as its table of
|
|
18
|
+
* predefined `@string`s, which the database's own definitions override from where they stand. Each
|
|
19
|
+
* database is still parsed as its own text, so every entry keeps its place in the file that holds it.
|
|
20
|
+
*/
|
|
21
|
+
import {
|
|
22
|
+
parse,
|
|
23
|
+
type Creator,
|
|
24
|
+
type Entry,
|
|
25
|
+
type Library,
|
|
26
|
+
type Options,
|
|
27
|
+
} from "@retorquere/bibtex-parser";
|
|
28
|
+
import type {
|
|
29
|
+
BibEntry,
|
|
30
|
+
BibName,
|
|
31
|
+
BibStrings,
|
|
32
|
+
BibText,
|
|
33
|
+
WrittenEntry,
|
|
34
|
+
} from "../../domain/paper-sources.ts";
|
|
35
|
+
import type { AbsolutePath } from "../../domain/paths.ts";
|
|
36
|
+
import type { Span } from "../../domain/tex-document.ts";
|
|
37
|
+
import type { BibReader } from "../../ports/bib-reader.ts";
|
|
38
|
+
|
|
39
|
+
/** A title as written, not sentence-cased; no field kept as raw LaTeX. */
|
|
40
|
+
const OPTIONS: Readonly<Options> = { sentenceCase: false, verbatimFields: [] };
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Every field as bibtex takes it: `@string`s expanded where they are used, LaTeX left as written (no
|
|
44
|
+
* conversion, no name split, no outer braces dropped).
|
|
45
|
+
*/
|
|
46
|
+
const AS_WRITTEN: Readonly<Options> = {
|
|
47
|
+
raw: true,
|
|
48
|
+
sentenceCase: false,
|
|
49
|
+
verbatimFields: [/.*/],
|
|
50
|
+
removeOuterBraces: [],
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
/** A name's parts, those it has: the parser leaves the others out. */
|
|
54
|
+
const nameOf = (c: Readonly<Creator>): BibName =>
|
|
55
|
+
Object.fromEntries(
|
|
56
|
+
Object.entries({
|
|
57
|
+
lastName: c.lastName,
|
|
58
|
+
firstName: c.firstName,
|
|
59
|
+
prefix: c.prefix,
|
|
60
|
+
suffix: c.suffix,
|
|
61
|
+
name: c.name,
|
|
62
|
+
}).filter((kv): kv is [string, string] => kv[1] !== undefined),
|
|
63
|
+
);
|
|
64
|
+
|
|
65
|
+
const isText = (x: unknown): x is string => typeof x === "string";
|
|
66
|
+
const isName = (x: unknown): x is Readonly<Creator> =>
|
|
67
|
+
typeof x === "object" && x !== null;
|
|
68
|
+
|
|
69
|
+
/** An entry's fields and name lists, from the parser's one record of both. */
|
|
70
|
+
function fieldsOf(e: Readonly<Entry>): Pick<BibEntry, "fields" | "names"> {
|
|
71
|
+
const pairs = Object.entries(e.fields);
|
|
72
|
+
const isNames = (k: string): boolean => e.mode[k] === "creatorlist";
|
|
73
|
+
return {
|
|
74
|
+
// A list field (`keywords`, `publisher`) is joined as BibTeX writes it.
|
|
75
|
+
fields: Object.fromEntries(
|
|
76
|
+
pairs
|
|
77
|
+
.filter(([k]) => !isNames(k))
|
|
78
|
+
.map(([k, v]) => [k, [v].flat().filter(isText).join(" and ")]),
|
|
79
|
+
),
|
|
80
|
+
names: Object.fromEntries(
|
|
81
|
+
pairs
|
|
82
|
+
.filter(([k]) => isNames(k))
|
|
83
|
+
.map(([k, v]) => [k, [v].flat().filter(isName).map(nameOf)]),
|
|
84
|
+
),
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/** Each entry the parser read, placed in the text: found in `source` in order, `source` at `offset`. */
|
|
89
|
+
function placed(
|
|
90
|
+
parsed: readonly Readonly<Entry>[],
|
|
91
|
+
source: string,
|
|
92
|
+
offset: number,
|
|
93
|
+
): readonly BibEntry[] {
|
|
94
|
+
return parsed.reduce<{
|
|
95
|
+
readonly from: number;
|
|
96
|
+
readonly found: readonly BibEntry[];
|
|
97
|
+
}>(
|
|
98
|
+
(acc, e) => {
|
|
99
|
+
const at = source.indexOf(e.input, acc.from);
|
|
100
|
+
const end = at + e.input.length;
|
|
101
|
+
const span = { start: offset + at, end: offset + end };
|
|
102
|
+
const entry = { type: e.type.toLowerCase(), key: e.key, span };
|
|
103
|
+
return { from: end, found: [...acc.found, { ...entry, ...fieldsOf(e) }] };
|
|
104
|
+
},
|
|
105
|
+
{ from: 0, found: [] },
|
|
106
|
+
).found;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/** The entries the parser finished: one it could not keeps no text — it is malformed, and bibtex reports it. */
|
|
110
|
+
const finished = (lib: Readonly<Library>): readonly Readonly<Entry>[] =>
|
|
111
|
+
lib.entries.filter((e) => e.input !== "");
|
|
112
|
+
|
|
113
|
+
/** An entry as bibtex takes it; a list field (`keywords`) as one value. */
|
|
114
|
+
const writtenOf = (e: Readonly<Entry>): WrittenEntry => ({
|
|
115
|
+
type: e.type.toLowerCase(),
|
|
116
|
+
key: e.key,
|
|
117
|
+
fields: Object.fromEntries(
|
|
118
|
+
Object.entries(e.fields).map(([k, v]) => [
|
|
119
|
+
k,
|
|
120
|
+
[v].flat().filter(isText).join(", "),
|
|
121
|
+
]),
|
|
122
|
+
),
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* The database in `body` of `text`, the text of the file at `path`, read with the `@string`s
|
|
127
|
+
* `inherited` in force. The parser is handed a copy of them: it writes into its own.
|
|
128
|
+
*/
|
|
129
|
+
function read(
|
|
130
|
+
path: AbsolutePath,
|
|
131
|
+
text: string,
|
|
132
|
+
body: Span,
|
|
133
|
+
inherited: BibStrings = {},
|
|
134
|
+
): BibText {
|
|
135
|
+
const source = text.slice(body.start, body.end);
|
|
136
|
+
const lib = parse(source, { ...OPTIONS, strings: { ...inherited } });
|
|
137
|
+
const asWritten = parse(source, { ...AS_WRITTEN, strings: { ...inherited } });
|
|
138
|
+
return {
|
|
139
|
+
path,
|
|
140
|
+
text,
|
|
141
|
+
body,
|
|
142
|
+
entries: placed(finished(lib), source, body.start),
|
|
143
|
+
written: finished(asWritten).map(writtenOf),
|
|
144
|
+
preamble: lib.preamble,
|
|
145
|
+
inherited,
|
|
146
|
+
// Its own as bibtex takes them: the reading that keeps LaTeX as written.
|
|
147
|
+
strings: { ...inherited, ...asWritten.strings },
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
export const bibReader: BibReader = {
|
|
152
|
+
read,
|
|
153
|
+
readFile: (path, text, inherited) =>
|
|
154
|
+
read(path, text, { start: 0, end: text.length }, inherited),
|
|
155
|
+
};
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* THE `filecontents` BLOCKS OF A SOURCE — where a `.bib` TeX wrote stands in the text that wrote it.
|
|
3
|
+
* Read from the parse tree, never decided: which file a block writes, and whether TeX ran it, is
|
|
4
|
+
* TeX's answer (`written` in `_build/sources.json`); this reader only says where each block's text
|
|
5
|
+
* is, so a finding about an entry TeX read can be shown at the block that holds it
|
|
6
|
+
* (docs/design/paper-sources.md §1).
|
|
7
|
+
*
|
|
8
|
+
* unified-latex reads a `filecontents` environment as verbatim; its option and file name are the
|
|
9
|
+
* first things in that node, white space between them — a line break too: `\begin{filecontents*}` with
|
|
10
|
+
* `{refs.bib}` on the next line writes `refs.bib` (measured with pdflatex) — and its body starts on the
|
|
11
|
+
* line after the name, as LaTeX's own reader starts it.
|
|
12
|
+
* A block is live when the tree keeps it: a comment is a node of its own, `\iffalse … \fi` is cut at
|
|
13
|
+
* parse (`conditionals.ts`), and nothing after `\end{document}` is read (`liveRoot`).
|
|
14
|
+
*/
|
|
15
|
+
import type * as Ast from "@unified-latex/unified-latex-types";
|
|
16
|
+
import type { Filecontents } from "../../ports/latex.ts";
|
|
17
|
+
import {
|
|
18
|
+
argumentPieces,
|
|
19
|
+
inPlace,
|
|
20
|
+
isNode,
|
|
21
|
+
placeOf,
|
|
22
|
+
visited,
|
|
23
|
+
type ArgumentPiece,
|
|
24
|
+
type Node,
|
|
25
|
+
} from "./nodes.ts";
|
|
26
|
+
import { liveRoot, parseLatex, type ParsedTex } from "./parse.ts";
|
|
27
|
+
|
|
28
|
+
const FILECONTENTS: ReadonlySet<string> = new Set([
|
|
29
|
+
"filecontents",
|
|
30
|
+
"filecontents*",
|
|
31
|
+
]);
|
|
32
|
+
|
|
33
|
+
/** Names and options as TeX reads them: off the tree, a comma between two names. */
|
|
34
|
+
type Name = readonly ArgumentPiece[];
|
|
35
|
+
|
|
36
|
+
/** What a name or an option is written as: its pieces joined, white space trimmed off. */
|
|
37
|
+
export const written = (name: Name): string =>
|
|
38
|
+
name
|
|
39
|
+
.map((p) => p.text)
|
|
40
|
+
.join("")
|
|
41
|
+
.trim();
|
|
42
|
+
|
|
43
|
+
/** What may stand before the name: nothing, or one `[options]` — anything else is a block with no name. */
|
|
44
|
+
const OPTION = /^(?:\[[^\]]*\])?$/;
|
|
45
|
+
|
|
46
|
+
/** A block's head: its name's group, and its options. */
|
|
47
|
+
interface Head {
|
|
48
|
+
readonly name: Node;
|
|
49
|
+
readonly options: readonly string[];
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/** The head of a block whose text is `text`: the first group, with only white space and an option before it. */
|
|
53
|
+
function headOf(text: string): Head | null {
|
|
54
|
+
const nodes = parseLatex(text).root.content;
|
|
55
|
+
const at = nodes.findIndex((x) => x.type === "group");
|
|
56
|
+
const option = written(argumentPieces(nodes.slice(0, Math.max(at, 0)), null));
|
|
57
|
+
const name = nodes[at];
|
|
58
|
+
if (name === undefined || !OPTION.test(option)) return null;
|
|
59
|
+
return {
|
|
60
|
+
name,
|
|
61
|
+
options: option
|
|
62
|
+
.replace(/^\[|\]$/g, "")
|
|
63
|
+
.split(",")
|
|
64
|
+
.map((o) => o.trim()),
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* One verbatim `filecontents` node as a block: its name, option, and body. unified-latex reads the
|
|
70
|
+
* whole environment as verbatim, so its text is parsed on its own and the name read off that tree like
|
|
71
|
+
* a declaration's (`headOf`). The body starts on the line after the one the name ends on; what TeX
|
|
72
|
+
* ignores after the name on that line is no body.
|
|
73
|
+
*/
|
|
74
|
+
export function blockOf(
|
|
75
|
+
src: string,
|
|
76
|
+
n: Readonly<Ast.VerbatimEnvironment>,
|
|
77
|
+
jobname: string,
|
|
78
|
+
): readonly Filecontents[] {
|
|
79
|
+
return inPlace(placeOf(n), (span) => {
|
|
80
|
+
// The node runs from `\begin{env}` to past `\end{env}`.
|
|
81
|
+
const headAt = span.start + `\\begin{${n.env}}`.length;
|
|
82
|
+
const end = span.end - `\\end{${n.env}}`.length;
|
|
83
|
+
const head = headOf(src.slice(headAt, end));
|
|
84
|
+
if (head === null) return [];
|
|
85
|
+
return inPlace(placeOf(head.name), (named) => {
|
|
86
|
+
const after = headAt + named.end;
|
|
87
|
+
// What TeX ignores after the name, up to the end of its line.
|
|
88
|
+
const rest = src.slice(after, end).split("\n", 1).join("");
|
|
89
|
+
return [
|
|
90
|
+
{
|
|
91
|
+
writes: written(argumentPieces([head.name], jobname)),
|
|
92
|
+
overwrite: head.options.some(
|
|
93
|
+
(o) => o === "overwrite" || o === "force",
|
|
94
|
+
),
|
|
95
|
+
span,
|
|
96
|
+
body: { start: Math.min(after + rest.length + 1, end), end },
|
|
97
|
+
},
|
|
98
|
+
];
|
|
99
|
+
});
|
|
100
|
+
});
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
const isBlock = (n: Node): n is Readonly<Ast.VerbatimEnvironment> =>
|
|
104
|
+
n.type === "verbatim" && FILECONTENTS.has(n.env);
|
|
105
|
+
|
|
106
|
+
/** Every live `filecontents` block of a source whose main file's name is `jobname`, in source order. */
|
|
107
|
+
export const filecontentsOf = (
|
|
108
|
+
t: ParsedTex,
|
|
109
|
+
jobname: string,
|
|
110
|
+
): readonly Filecontents[] =>
|
|
111
|
+
visited(liveRoot(t), () => false)
|
|
112
|
+
.filter(isNode)
|
|
113
|
+
.filter(isBlock)
|
|
114
|
+
.flatMap((n) => blockOf(t.src, n, jobname));
|
|
@@ -4,6 +4,7 @@ import type { Include } from "../../domain/paper-source.ts";
|
|
|
4
4
|
import type { Span } from "../../domain/tex-document.ts";
|
|
5
5
|
import { isDefinition } from "./hidden.ts";
|
|
6
6
|
import {
|
|
7
|
+
argumentPieces,
|
|
7
8
|
inPlace,
|
|
8
9
|
isNode,
|
|
9
10
|
macroPlace,
|
|
@@ -13,7 +14,7 @@ import {
|
|
|
13
14
|
type Macro,
|
|
14
15
|
type Node,
|
|
15
16
|
} from "./nodes.ts";
|
|
16
|
-
import type
|
|
17
|
+
import { liveRoot, type ParsedTex } from "./parse.ts";
|
|
17
18
|
|
|
18
19
|
const INCLUDE_MACROS: ReadonlyMap<string, Include["macro"]> = new Map([
|
|
19
20
|
["input", "input"],
|
|
@@ -22,15 +23,22 @@ const INCLUDE_MACROS: ReadonlyMap<string, Include["macro"]> = new Map([
|
|
|
22
23
|
]);
|
|
23
24
|
|
|
24
25
|
/**
|
|
25
|
-
* The path an include names
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* The path an include names: its braced argument read off the tree as TeX reads it (a comment is no
|
|
27
|
+
* part of it; a macro stays as written: nothing here expands one), or — TeX's own form, `\\input name`
|
|
28
|
+
* — the name up to the next space. unified-latex gives the unbraced form an argument of the first
|
|
29
|
+
* token only (`sections` of `sections/a`), so the source is read for that one.
|
|
28
30
|
*/
|
|
29
31
|
function argumentText(src: string, m: Macro): string | null {
|
|
30
|
-
const
|
|
31
|
-
|
|
32
|
+
const arg = mandatory(m)[0];
|
|
33
|
+
const start = arg?.content[0]?.position?.start.offset;
|
|
34
|
+
if (arg === undefined || start === undefined) return null;
|
|
35
|
+
// The parser gives both forms `{` as their open mark; the source says which one was written.
|
|
36
|
+
if (src[start - 1] === "{")
|
|
37
|
+
return argumentPieces(arg.content, null)
|
|
38
|
+
.map((p) => p.text)
|
|
39
|
+
.join("");
|
|
32
40
|
const rest = src.slice(start);
|
|
33
|
-
const stop = rest.search(
|
|
41
|
+
const stop = rest.search(/[\s{}%]/u);
|
|
34
42
|
return stop < 0 ? rest : rest.slice(0, stop);
|
|
35
43
|
}
|
|
36
44
|
|
|
@@ -44,11 +52,11 @@ function includeOf(src: string, m: Macro): readonly Include[] {
|
|
|
44
52
|
|
|
45
53
|
/**
|
|
46
54
|
* Every `\input`, `\include` and `\subfile` of the source, in source order — not in a comment (a
|
|
47
|
-
* comment is a node of its own)
|
|
48
|
-
* is used, and nothing here expands macros.
|
|
55
|
+
* comment is a node of its own), not in a macro definition's body, which is read where the macro
|
|
56
|
+
* is used, and nothing here expands macros; not after `\end{document}`, which TeX never reads.
|
|
49
57
|
*/
|
|
50
58
|
export const includesOf = (t: ParsedTex): readonly Include[] =>
|
|
51
|
-
visited(t
|
|
59
|
+
visited(liveRoot(t), isDefinition)
|
|
52
60
|
.filter(isNode)
|
|
53
61
|
.flatMap((n) => (n.type === "macro" ? includeOf(t.src, n) : []));
|
|
54
62
|
|
|
@@ -697,3 +697,76 @@ describe("bodyEmphasis — each style, and edge cases", () => {
|
|
|
697
697
|
expect(e && src.slice(e.span.start, e.span.end)).toBe("\\textbf{see it}");
|
|
698
698
|
});
|
|
699
699
|
});
|
|
700
|
+
|
|
701
|
+
describe("latexReader.filecontents — the blocks that write a file, where they stand", () => {
|
|
702
|
+
const SRC =
|
|
703
|
+
"\\documentclass{x}\n" +
|
|
704
|
+
"\\begin{filecontents*}[overwrite]{refs.bib}\n@misc{a, title={A}}\n\\end{filecontents*}\n" +
|
|
705
|
+
"\\begin{document}\n" +
|
|
706
|
+
"\\begin{filecontents}{\\jobname.bib}\n@misc{b, title={B}}\n\\end{filecontents}\n" +
|
|
707
|
+
"\\end{document}\n" +
|
|
708
|
+
"\\begin{filecontents}{late.bib}\n@misc{c}\n\\end{filecontents}\n";
|
|
709
|
+
|
|
710
|
+
it("each live block, in order: the file it writes (\\jobname expanded), [overwrite], its span and body", () => {
|
|
711
|
+
const blocks = latexReader.filecontents(SRC, "paper");
|
|
712
|
+
expect(
|
|
713
|
+
blocks.map((b) => [
|
|
714
|
+
b.writes,
|
|
715
|
+
b.overwrite,
|
|
716
|
+
SRC.slice(b.body.start, b.body.end),
|
|
717
|
+
]),
|
|
718
|
+
).toEqual([
|
|
719
|
+
["refs.bib", true, "@misc{a, title={A}}\n"],
|
|
720
|
+
["paper.bib", false, "@misc{b, title={B}}\n"],
|
|
721
|
+
]);
|
|
722
|
+
expect(SRC.slice(blocks[0]?.span.start, blocks[0]?.span.end)).toMatch(
|
|
723
|
+
/^\\begin\{filecontents\*\}.*\\end\{filecontents\*\}$/s,
|
|
724
|
+
);
|
|
725
|
+
});
|
|
726
|
+
|
|
727
|
+
it("a block inside a comment, or after \\end{document}, is not one TeX runs", () => {
|
|
728
|
+
expect(
|
|
729
|
+
latexReader.filecontents(
|
|
730
|
+
"% \\begin{filecontents}{x.bib}\n% @misc{z}\n% \\end{filecontents}\n\\begin{document}\n\\end{document}\n",
|
|
731
|
+
"paper",
|
|
732
|
+
),
|
|
733
|
+
).toEqual([]);
|
|
734
|
+
});
|
|
735
|
+
|
|
736
|
+
it("a block that names no file writes none: a group after its body's first text is no name, and a body may hold none", () => {
|
|
737
|
+
expect(
|
|
738
|
+
[
|
|
739
|
+
"\\begin{filecontents}\n@misc{z}\n\\end{filecontents}\n",
|
|
740
|
+
"\\begin{filecontents}\nplain text\n\\end{filecontents}\n",
|
|
741
|
+
].flatMap((block) =>
|
|
742
|
+
latexReader.filecontents(
|
|
743
|
+
`${block}\\begin{document}\n\\end{document}\n`,
|
|
744
|
+
"paper",
|
|
745
|
+
),
|
|
746
|
+
),
|
|
747
|
+
).toEqual([]);
|
|
748
|
+
});
|
|
749
|
+
});
|
|
750
|
+
|
|
751
|
+
describe("latexReader.filecontents — a file name on a line of its own", () => {
|
|
752
|
+
it("🔴 a name on the line after \\begin, the option before it or not: TeX takes it, and the body starts on the line after the name", () => {
|
|
753
|
+
// Measured with pdflatex: `\\begin{filecontents*}` then `{refs.bib}` on the next line writes
|
|
754
|
+
// refs.bib from the lines after the name (fixtures/paper-sources/v30-name-next-line).
|
|
755
|
+
const src =
|
|
756
|
+
"\\begin{filecontents*}\n{refs.bib}\n@misc{a, title={A}}\n\\end{filecontents*}\n" +
|
|
757
|
+
"\\begin{filecontents}[overwrite]\n {two.bib}\n@misc{b}\n\\end{filecontents}\n" +
|
|
758
|
+
"\\begin{document}\n\\end{document}\n";
|
|
759
|
+
expect(
|
|
760
|
+
latexReader
|
|
761
|
+
.filecontents(src, "paper")
|
|
762
|
+
.map((b) => [
|
|
763
|
+
b.writes,
|
|
764
|
+
b.overwrite,
|
|
765
|
+
src.slice(b.body.start, b.body.end),
|
|
766
|
+
]),
|
|
767
|
+
).toEqual([
|
|
768
|
+
["refs.bib", false, "@misc{a, title={A}}\n"],
|
|
769
|
+
["two.bib", true, "@misc{b}\n"],
|
|
770
|
+
]);
|
|
771
|
+
});
|
|
772
|
+
});
|
|
@@ -33,6 +33,7 @@ import { parseLatex } from "./parse.ts";
|
|
|
33
33
|
import { bodyEmphasis, bodyProse } from "./prose.ts";
|
|
34
34
|
import { renderedRuns } from "./rendered.ts";
|
|
35
35
|
import { layoutOverridesOf } from "./layout.ts";
|
|
36
|
+
import { filecontentsOf } from "./filecontents.ts";
|
|
36
37
|
|
|
37
38
|
export {
|
|
38
39
|
documentClassOf,
|
|
@@ -69,4 +70,5 @@ export const latexReader: LatexReader = {
|
|
|
69
70
|
template: parseTemplate,
|
|
70
71
|
withDocumentClass: (src, want) => replaceDocumentClass(parseLatex(src), want),
|
|
71
72
|
layoutOverrides: (src) => layoutOverridesOf(parseLatex(src)),
|
|
73
|
+
filecontents: (src, jobname) => filecontentsOf(parseLatex(src), jobname),
|
|
72
74
|
};
|