badness(1)

πŸ“¦ version 0.28.0, in nixpkgs unstable

πŸ’… badness(1) β€” like, the manual page bestie πŸŽ€

okay so welcome to the General Commands Manual entry for badness(1) β€” yes that's the manual-name situation, we're in section 1, it's giving core-utils-adjacent but make it LaTeX ✨


🌸 NAME 🌸

badness β€” a formatter, linter, and language server for LaTeX. that's it. that's the whole personality. she formats, she lints, she serves language, she does it all πŸ’–


✨ SYNOPSIS ✨

badness [--config] [--no-config] [--color] [-q|--quiet] [-h|--help]
[-V|--version] <subcommands>

like, flags first, then you point her at a subcommand. iconic behavior fr fr 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

A formatter, linter, and language server for LaTeX. (yes bestie, that's the description, and honestly it ate β€” short, sweet, no notes πŸ’…)


πŸ‘‘ OPTIONS πŸ‘‘

  • --config <PATH> β€” Path to a badness.toml to use instead of discovering one. okay so important detail: this one applies to format and lint, and it is ignored by parse, lsp, and init. so don't come crying to me when parse doesn't read your config, she simply does not see it πŸ™ˆ
  • --no-config β€” Ignore any badness.toml (project, $BADNESS_CONFIG, or global) and use built-in defaults. full factory-reset energy, no cap. the three sources she's ignoring are project, $BADNESS_CONFIG, and global β€” all three, gone 🧚
  • --color <WHEN> β€” When to use color in output. default is auto. possible values are giving a whole little menu:
    • auto: Colorize when writing to a terminal and NO_COLOR is unset (default) β€” the "read the room" option πŸ’œ
    • always: Always colorize. periodt. 🌈
    • never: Never colorize. beige mode. respect. 🀍
  • -q, --quiet β€” Suppress non-essential output (errors are still shown). and here's the tea: under format --check this drops the per-file diff, leaving the list of files that would be reformatted and the summary. so you still get the receipts, just less of the page-long drama 😭
  • -h, --help β€” Print help (see a summary with -h). yes she's telling you -h does a summary, it's in the text, i don't make the rules ✨
  • -V, --version β€” Print version. slay.

πŸŽ€ SUBCOMMANDS πŸŽ€

it's a whole friend group, let me introduce you:

  • badness-format(1) β€” Format LaTeX source. the glow-up department πŸ’–
  • badness-lint(1) β€” Lint LaTeX source, reporting parse diagnostics. she WILL tell you what's wrong, lovingly 🫢
  • badness-parse(1) β€” Parse LaTeX source and print its concrete syntax tree (CST). tree reveal, but make it syntax 🌳
  • badness-lsp(1) β€” Run the language server over stdio. the main character of editor integration πŸ‘‘
  • badness-inverse-search(1) β€” Answer a PDF viewer's inverse (backward) search. yes backwards, yes it's hot, don't question it πŸ”₯
  • badness-init(1) β€” Write a commented starter badness.toml to the current directory. baby's first config, so cute πŸ“
  • badness-help(1) β€” Print this message or the help of the given subcommand(s). help-ception, iykyk πŸ’€

⭐ VERSION ⭐

v0.28.0


🌈 SEE ALSO 🌈

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

(and yes, badness-debug(1) is in SEE ALSO even though it's not in the subcommands list up there β€” the manpage said it, so i said it, i don't gatekeep πŸ’…)


okay bestie that's the whole page, go forth and format πŸ¦‹

signing off with love β€” this was badness version 0.28.0, straight from the badness(1) manual page, and yes i kept the footer facts too: badness 0.28.0, section badness(1) πŸ’œβœ¨πŸŒΈ

πŸ“¦ where this page comes from