badness 0.3.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

# CLI Reference

> This page is maintained by hand for now. Generated CLI docs (via
> `clap-markdown`) are planned, at which point this page becomes the rendered
> output.

```text
badness <COMMAND>
```

## `badness format`

Format LaTeX source. With paths, formats each file in place. With no paths,
reads standard input and writes the formatted result to standard output.

```text
badness format [OPTIONS] [PATHS]...
```

  | Argument / option    | Default  | Description                                                                                                                          |
  | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
  | `[PATHS]...`         | —        | Files to format. Omit to read from stdin.                                                                                            |
  | `--check`            | off      | Report which files would change without writing them. Exits non-zero if any file is not already formatted.                           |
  | `--line-width <N>`   | `80`     | Maximum line width before the formatter breaks a line.                                                                               |
  | `--indent-width <N>` | `2`      | Number of spaces per indent step.                                                                                                    |
  | `--wrap <MODE>`      | `reflow` | How to lay out line breaks inside a paragraph. One of `reflow`, `sentence`, `semantic`, `preserve`. See [Wrap Modes](wrap-modes.md). |

## `badness lint`

Lint LaTeX source, reporting parse diagnostics. With paths, lints each file.
With no paths, reads standard input. Exits non-zero if any diagnostics are
reported.

```text
badness lint [PATHS]...
```

  | Argument     | Description                             |
  | ------------ | --------------------------------------- |
  | `[PATHS]...` | Files to lint. Omit to read from stdin. |

## `badness lsp`

Run the language server over stdio. See [Editor
Setup](../guide/editor-setup.md).

```text
badness lsp
```

## Global flags

  | Flag        | Description                                          |
  | ----------- | ---------------------------------------------------- |
  | `--version` | Print the version (`badness {{ badness-version }}`). |
  | `--help`    | Print help.                                          |