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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
//! The `badness` command-line surface.
//!
//! Kept as a self-contained module (referencing only `std` and `clap`) so that
//! `build.rs` can `#[path = "src/cli.rs"]`-include it to generate man pages,
//! shell completions, and the markdown CLI reference, exactly as arity does.
//! Conversions to library types (e.g. [`WrapArg`] → `formatter::WrapMode`) live
//! in `main.rs`, never here, so the file compiles inside the build script too.
use std::path::PathBuf;
use clap::{Parser, Subcommand, ValueEnum};
/// CLI surface for `formatter::WrapMode`. Kept here (not in the formatter) so the
/// formatter API stays clap-free.
#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]
pub enum WrapArg {
/// Greedy fill: wrap words to the line width (default).
Reflow,
/// Preserve acceptable authored breaks and rebalance only nearby text
/// (revision-stable wrapping).
Stable,
/// One sentence per line (line width ignored).
Sentence,
/// Semantic line breaks (sembr.org): keep authored breaks and add breaks at
/// sentence boundaries.
Semantic,
/// Leave authored line breaks untouched.
Preserve,
}
/// CLI surface for `formatter::MathWrap` (display-math line breaking). Kept
/// here for the same reason as [`WrapArg`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]
pub enum MathWrapArg {
/// Derive from the effective wrap mode: preserve → preserve, else break
/// (default).
Auto,
/// Keep authored line breaks inside display-math bodies.
Preserve,
/// Never insert breaks; a long body overflows the line width.
SingleLine,
/// Break a too-long body before its top-level operators (amsmath style).
Break,
}
#[derive(Parser)]
#[command(
name = "badness",
version,
about = "A formatter, linter, and language server for LaTeX"
)]
pub struct Cli {
#[command(subcommand)]
pub command: Command,
/// Path to a `badness.toml` to use instead of discovering one. Applies to
/// `format` and `lint`; ignored by `parse`, `lsp`, and `init`.
#[arg(long, value_name = "PATH", global = true, conflicts_with = "no_config")]
pub config: Option<PathBuf>,
/// Ignore any `badness.toml` (project, `$BADNESS_CONFIG`, or global) and
/// use built-in defaults.
#[arg(long, global = true)]
pub no_config: bool,
}
#[derive(Subcommand)]
pub enum Command {
/// Format LaTeX source.
///
/// With paths, formats each file in place. With no paths, reads stdin and
/// writes the formatted result to stdout.
Format {
/// Files to format. Omit to read from stdin.
paths: Vec<PathBuf>,
/// Report which files would change without writing them. Exits non-zero
/// if any file is not already formatted.
#[arg(long)]
check: bool,
/// 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.
#[arg(long, value_name = "PATH")]
stdin_filepath: Option<PathBuf>,
/// Maximum line width before the formatter breaks a line.
#[arg(long)]
line_width: Option<usize>,
/// Number of spaces per indent step.
#[arg(long)]
indent_width: Option<usize>,
/// How to lay out line breaks inside a paragraph.
#[arg(long, value_enum)]
wrap: Option<WrapArg>,
/// How to lay out line breaks inside display math.
#[arg(long, value_enum)]
math_wrap: Option<MathWrapArg>,
/// Gitignore-style pattern to skip during directory discovery (repeatable).
/// Added on top of any `exclude`/`extend-exclude` from `badness.toml`.
#[arg(long, value_name = "PATTERN")]
exclude: Vec<String>,
/// 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.
#[arg(long)]
force_exclude: bool,
},
/// Lint LaTeX source, reporting parse diagnostics.
///
/// With paths, lints each file. With no paths, reads stdin. Exits non-zero
/// if any diagnostics are reported.
Lint {
/// Files to lint. Omit to read from stdin.
paths: Vec<PathBuf>,
/// Apply safe autofixes in place, then report what remains. Requires
/// path arguments; has no effect on stdin (there is nothing to write).
#[arg(long)]
fix: bool,
/// Also apply fixes that may change typeset output (requires `--fix`).
#[arg(long)]
unsafe_fixes: bool,
/// 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.
#[arg(long, value_name = "PATH")]
stdin_filepath: Option<PathBuf>,
/// Gitignore-style pattern to skip during directory discovery (repeatable).
/// Added on top of any `exclude`/`extend-exclude` from `badness.toml`.
#[arg(long, value_name = "PATTERN")]
exclude: Vec<String>,
/// 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.
#[arg(long)]
force_exclude: bool,
/// Run only these rules (repeatable). Overrides `[lint] select` from
/// `badness.toml` when given.
#[arg(long, value_name = "RULE")]
select: Vec<String>,
/// Disable these rules (repeatable). Overrides `[lint] ignore` from
/// `badness.toml` when given.
#[arg(long, value_name = "RULE")]
ignore: Vec<String>,
/// Print the description and examples for a rule id, then exit. Ignores
/// paths, config, and fixes.
#[arg(long, value_name = "RULE")]
explain: Option<String>,
},
/// Parse LaTeX source and print its concrete syntax tree (CST).
///
/// A debugging aid: prints the lossless parse tree as an indented
/// `KIND@range` listing, with token text, followed by any parse errors.
/// With a path, parses that file. With no path, reads stdin.
Parse {
/// File to parse. Omit to read from stdin.
path: Option<PathBuf>,
},
/// Run the language server over stdio.
Lsp,
/// Write a commented starter `badness.toml` to the current directory.
Init {
/// Overwrite an existing `badness.toml`.
#[arg(long)]
force: bool,
},
/// Debug utilities for parser and formatter diagnostics.
///
/// Intended for CI smoke tests and local triage; hidden from help and the
/// generated docs, and covered by no stability promise.
#[command(hide = true)]
Debug {
#[command(subcommand)]
command: DebugCommand,
},
}
/// Subcommands under `badness debug`.
#[derive(Subcommand)]
pub enum DebugCommand {
/// Check formatter and parser invariants per file, writing nothing back.
///
/// Runs the selected checks (losslessness: `reconstruct(x) == x`;
/// idempotency: `fmt(fmt(x)) == fmt(x)`) over each input file. `--report`
/// emits a Markdown summary to stdout; `--dump-dir` writes per-pass
/// artifacts for triage.
Format {
/// Files or directories to check.
paths: Vec<PathBuf>,
/// Which invariant checks to run.
#[arg(long, value_enum, default_value = "all")]
checks: DebugChecksArg,
/// Emit a Markdown report to stdout instead of log lines.
#[arg(long)]
report: bool,
/// Directory where per-pass artifacts are written on failure.
#[arg(long, value_name = "DIR")]
dump_dir: Option<PathBuf>,
/// Write pass artifacts even when all checks pass.
#[arg(long, requires = "dump_dir")]
dump_passes: bool,
/// Gitignore-style pattern to skip during directory discovery (repeatable).
/// Added on top of any `exclude`/`extend-exclude` from `badness.toml`.
#[arg(long, value_name = "PATTERN")]
exclude: Vec<String>,
/// Apply exclude patterns to files named explicitly on the command line
/// too (they are normally always processed).
#[arg(long)]
force_exclude: bool,
},
}
/// Which checks `badness debug format` runs.
#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]
pub enum DebugChecksArg {
/// Only the formatter fixed-point check: `fmt(fmt(x)) == fmt(x)`.
Idempotency,
/// Only the parser round-trip check: `reconstruct(x) == x`.
Losslessness,
/// Both checks (default).
All,
}