badness 0.5.0

A language server, formatter, and linter for LaTeX
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

# Formatting

`badness format` lays out LaTeX source deterministically. Output is decided
solely by the formatter's rules and its layout engine---there are no
per-construct special cases to memorize.

## In Place, `stdin`, or check

```sh
badness format paper.tex          # rewrite the file in place
cat paper.tex | badness format    # stdin → stdout
badness format --check paper.tex  # report, don't write; non-zero if unformatted
```

## Style Options

  | Flag                 | Default  | Meaning                                                                                        |
  | -------------------- | -------- | ---------------------------------------------------------------------------------------------- |
  | `--line-width <N>`   | `80`     | Maximum line width before the formatter breaks a line.                                         |
  | `--indent-width <N>` | `2`      | Spaces per indent step.                                                                        |
  | `--wrap <mode>`      | `reflow` | How line breaks inside a paragraph are laid out. See [Wrap Modes](../reference/wrap-modes.md). |

A configuration file is not yet read; style is set through these flags. This is
expected to change as badness matures.

## Guarantees

The formatter is built around a small set of invariants that double as test
oracles:

- **Idempotence**: `format(format(x)) == format(x)`.
- **Stability**: formatting does not change the parsed structure of a document.
- **Protected regions**: verbatim-like content (`verbatim`, `lstlisting`,
  `\verb`, comments) is never altered.

If the formatter ever produces output that violates one of these, that is a bug
to report, not behavior to work around.