badness 0.4.0

An LSP, formatter, and linter for LaTeX
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

version: "3"

tasks:
  default:
    deps: [build]

  build:
    desc: Dev build
    cmds:
      - cargo build

  build-release:
    desc: Build release version
    cmds:
      - cargo build --release

  test:
    desc: Run all tests
    cmds:
      - cargo test

  fmt:
    desc: Format the code
    cmds:
      - cargo fmt

  fmt-check:
    desc: Check formatting (CI)
    cmds:
      - cargo fmt -- --check

  lint:
    desc: Clippy with warnings as errors
    cmds:
      - cargo clippy --all-targets --all-features -- -D warnings

  snapshots:
    desc: Regenerate / accept insta snapshots
    cmds:
      - INSTA_UPDATE=always cargo test

  parse-compat:
    desc: Soft differential parse-concordance report vs texlab (writes PARSE_COMPAT.md)
    cmds:
      - cargo test --test parse_compat -- --ignored --nocapture

  bib-parse-compat:
    desc: Soft differential BibTeX parse-concordance report vs texlab (writes BIB_PARSE_COMPAT.md)
    cmds:
      - cargo test --test bib_parse_compat -- --ignored --nocapture

  bib-fields:check:
    desc: Check data/bib_fields.json is in sync with biblatex's data model (blx-dm.def)
    cmds:
      - python3 scripts/gen_bib_fields.py

  bib-fields:sync:
    desc: Re-sync data/bib_fields.json's mechanical facts from biblatex's data model
    cmds:
      - python3 scripts/gen_bib_fields.py --write

  cwl:check:
    desc: Check data/cwl_signatures.json is in sync with the pinned TeXstudio CWL corpus
    cmds:
      - python3 scripts/gen_cwl_signatures.py

  cwl:sync:
    desc: Re-generate data/cwl_signatures.json from the pinned TeXstudio CWL corpus
    cmds:
      - python3 scripts/gen_cwl_signatures.py --write

  check:
    desc: Everything CI runs
    deps: [fmt-check, lint, test]

  bench:
    desc: Benchmarks (placeholder until Phase 7)
    cmds:
      - echo "no benchmarks yet"

  docs:
    desc: Build the documentation book
    deps: [docs:build]

  docs:build:
    desc: Build the mdBook docs into docs/book
    dir: docs
    cmds:
      - mdbook build

  docs:serve:
    desc: Serve the docs locally with live reload
    dir: docs
    cmds:
      - mdbook serve --open

  docs:clean:
    desc: Remove built docs
    dir: docs
    cmds:
      - mdbook clean

  brand:
    desc: Build all brand artifacts (logo, wordmark, OG card) — PDF + PNG
    deps: [brand:logo, brand:wordmark, brand:og]

  brand:logo:
    desc: Build logo.pdf + logo.png + logo.svg
    dir: branding
    cmds:
      - pdflatex -interaction=nonstopmode -halt-on-error logo.tex >/dev/null
      - magick -density 600 logo.pdf -background none -strip logo.png
      # Vector logo for the README and as the docs favicon/header.
      - dvisvgm --pdf logo.pdf -o logo.svg >/dev/null
    sources:
      - logo.tex
      - _common.tex
    generates:
      - logo.pdf
      - logo.png
      - logo.svg

  brand:wordmark:
    desc: Build wordmark.pdf + wordmark.png
    dir: branding
    cmds:
      - pdflatex -interaction=nonstopmode -halt-on-error wordmark.tex >/dev/null
      - magick -density 600 wordmark.pdf -background none -strip wordmark.png
    sources:
      - wordmark.tex
      - _common.tex
    generates:
      - wordmark.pdf
      - wordmark.png

  brand:og:
    desc: Build og.pdf + og.png (1200x630)
    dir: branding
    cmds:
      - pdflatex -interaction=nonstopmode -halt-on-error og.tex >/dev/null
      # 1200pt @ 72dpi base, scale 2x to 144dpi for crisp social preview.
      - magick -density 144 og.pdf -strip og.png
    sources:
      - og.tex
      - _common.tex
    generates:
      - og.pdf
      - og.png

  brand:clean:
    desc: Remove built brand artifacts and LaTeX scratch files
    dir: branding
    cmds:
      - rm -f *.pdf *.png *.svg *.aux *.log *.out