badness-lint(1)

📦 version 0.28.0, in nixpkgs unstable

🎀 NAME — badness-lint(1) 🎀

Bestie, meet badness-lint, the manual name you need in your life if LaTeX parse diagnostics are your love language. It lives in the General Commands Manual, section (1), and its whole thing is: Lint LaTeX source, reporting parse diagnostics. 💅✨

✨ SYNOPSIS ✨

badness lint [--fix] [--unsafe-fixes] [--stdin-filepath] [--exclude]
[--force-exclude] [--select] [--extend-select] [--ignore] [--explain]
[--output] [-h|--help] [-V|--version] [PATHS]

🌸 DESCRIPTION 🌸

Okay so the main-character job is literally: Lint LaTeX source, reporting parse diagnostics. 🦋

With paths, lints each file. Reads stdin when given -, or when paths are omitted and stdin is not a terminal. Exits non-zero if any diagnostics are reported. No cap, that’s the vibe check. 💖

💖 OPTIONS 💖

  • --fix — Apply safe autofixes in place, then report what remains. Requires path arguments; has no effect on stdin (there is nothing to write). 🔥
  • --unsafe-fixes — Also apply fixes that may change typeset output (requires --fix). Yes bestie, this one is giving “handle with care” energy. 💀
  • --stdin-filepath <PATH> — Name the stdin buffer so its language is dispatched by extension (.bib → BibTeX, anything else → LaTeX). No file is read or written; only the extension is used. Ignored when paths are given. 🎀
  • --exclude <PATTERN> — Gitignore-style pattern to skip during directory discovery (repeatable). Added on top of any exclude/extend-exclude from badness.toml. 🫶
  • --force-exclude — Apply exclude patterns to files named explicitly on the command line too (they are normally always processed). For runners like pre-commit that pass staged files as arguments. ✨
  • --select <RULE> — Set the base rule selection (repeatable). Overrides [lint] select from badness.toml when given. 👑
  • --extend-select <RULE> — Enable additional rules alongside --select or the defaults (repeatable). Added to [lint] extend-select from badness.toml. 🌈
  • --ignore <RULE> — Disable these rules (repeatable). Overrides [lint] ignore from badness.toml when given. 🙈
  • --explain <RULE> — Print the description and examples for a rule id, then exit. Ignores paths, config, and fixes. ⭐
  • --output <OUTPUT> — Output format for findings. The human modes write to stderr; json writes to stdout. [default: pretty] 💖

Possible values:

  • pretty — Source-snippet output with caret spans, on stderr (default). 🌸
  • concise — One path:line:col: severity [rule] message line per finding, on stderr. 🎀
  • json — A machine-readable JSON array of findings on stdout ([] when clean), with byte-offset ranges and fix data. 🦋
  • -h, --help — Print help (see a summary with '-h'). 💅
  • -V, --version — Print version. ✨
  • [PATHS] — Files or directories to lint. Pass - for stdin, which is also read when paths are omitted and stdin is not a terminal. 🌟

🔥 VERSION 🔥

v0.28.0 — periodt. 👑

🌈 SEE ALSO 🌈

badness(1), badness-format(1), badness-parse(1), badness-lsp(1), badness-inverse-search(1), badness-init(1), badness-debug(1)

💖 cute sign-off: source/version is lint 0.28.0, manual is badness-lint(1). The footer date isn’t printed, bestie — the last line only shows lint 0.28.0 and badness-lint(1), so that’s the whole adorable ending. Mwah! 💖🎀
📦 where this page comes from