badness 0.1.0__py3-none-win_amd64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
Binary file
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: badness
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Classifier: Development Status :: 3 - Alpha
|
|
5
|
+
Classifier: Environment :: Console
|
|
6
|
+
Classifier: Intended Audience :: Developers
|
|
7
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
8
|
+
Classifier: Operating System :: MacOS
|
|
9
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
10
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
11
|
+
Classifier: Programming Language :: Rust
|
|
12
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
13
|
+
Classifier: Topic :: Text Processing :: Markup :: LaTeX
|
|
14
|
+
License-File: LICENSE
|
|
15
|
+
Summary: An LSP, formatter, and linter for LaTeX
|
|
16
|
+
Keywords: latex,language-server,formatter,linter
|
|
17
|
+
Home-Page: https://jolars.github.io/badness/
|
|
18
|
+
Author-email: Johan Larsson <johan@jolars.co>
|
|
19
|
+
License: MIT
|
|
20
|
+
Requires-Python: >=3.10
|
|
21
|
+
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
|
|
22
|
+
Project-URL: Documentation, https://jolars.github.io/badness/
|
|
23
|
+
Project-URL: Homepage, https://jolars.github.io/badness/
|
|
24
|
+
Project-URL: Repository, https://github.com/jolars/badness
|
|
25
|
+
|
|
26
|
+
# Badness <img src='https://raw.githubusercontent.com/jolars/badness/main/branding/logo.svg' align="right" width="120" />
|
|
27
|
+
|
|
28
|
+
[](https://github.com/jolars/badness/actions/workflows/build-and-test.yml)
|
|
30
|
+
[](https://github.com/jolars/badness/actions/workflows/lint.yml)
|
|
31
|
+
[](https://jolars.github.io/badness/)
|
|
32
|
+
[](LICENSE)
|
|
33
|
+
|
|
34
|
+
**Badness** is a formatter, linter, and language server for LaTeX, built on a
|
|
35
|
+
lossless concrete syntax tree.
|
|
36
|
+
|
|
37
|
+
It parses LaTeX once and serves three tools from that tree:
|
|
38
|
+
|
|
39
|
+
- **Formatter** (`badness format`): deterministic, rule-based layout.
|
|
40
|
+
- **Linter** (`badness lint`): diagnostics with source snippets.
|
|
41
|
+
- **Language server** (`badness lsp`): both, live in your editor.
|
|
42
|
+
|
|
43
|
+
The architecture follows [rust-analyzer](https://rust-analyzer.github.io/): a
|
|
44
|
+
generic, error-tolerant, hand-written parser produces a lossless tree, semantics
|
|
45
|
+
are layered on top as a separate concern, and recomputation is incremental.
|
|
46
|
+
badness never *requires* resolving macros or catcodes to succeed—anything it
|
|
47
|
+
cannot statically recognize degrades to generic nodes rather than a crash. Two
|
|
48
|
+
properties hold by construction and are enforced as tests: **losslessness** (the
|
|
49
|
+
tree reconstructs the input byte-for-byte) and **idempotence** (formatting an
|
|
50
|
+
already formatted file changes nothing).
|
|
51
|
+
|
|
52
|
+
## Installation
|
|
53
|
+
|
|
54
|
+
Badness is written in Rust. Build from a checkout:
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
git clone https://github.com/jolars/badness
|
|
58
|
+
cd badness
|
|
59
|
+
cargo install --path .
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Usage
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
# Format a file in place (or stdin → stdout with no path)
|
|
66
|
+
badness format paper.tex
|
|
67
|
+
|
|
68
|
+
# Verify formatting without writing — exits non-zero if anything would change
|
|
69
|
+
badness format --check paper.tex
|
|
70
|
+
|
|
71
|
+
# Lint, reporting parse diagnostics
|
|
72
|
+
badness lint paper.tex
|
|
73
|
+
|
|
74
|
+
# Run the language server over stdio
|
|
75
|
+
badness lsp
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Formatter style is set through flags: `--line-width` (default `80`),
|
|
79
|
+
`--indent-width` (default `2`), and `--wrap` (`reflow` by default; also
|
|
80
|
+
`preserve`, with `sentence`/`semantic` planned). See the documentation for the
|
|
81
|
+
full reference.
|
|
82
|
+
|
|
83
|
+
## Documentation
|
|
84
|
+
|
|
85
|
+
Full documentation lives at **<https://jolars.github.io/badness/>** (built with
|
|
86
|
+
mdBook from [`docs/`](docs/)).
|
|
87
|
+
|
|
88
|
+
## Contributing
|
|
89
|
+
|
|
90
|
+
Architecture, tenets, and conventions are documented in
|
|
91
|
+
[`AGENTS.md`](AGENTS.md), written for both human and AI contributors. In short:
|
|
92
|
+
keep the syntactic layer free of semantic knowledge, every parser feature needs
|
|
93
|
+
corpus and snapshot tests plus a losslessness assertion, and code stays
|
|
94
|
+
`rustfmt`-clean with `clippy` warnings treated as errors.
|
|
95
|
+
|
|
96
|
+
## License
|
|
97
|
+
|
|
98
|
+
[MIT](LICENSE)
|
|
99
|
+
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
badness-0.1.0.data/scripts/badness.exe,sha256=WKH_KOQI18rNx3ypJBwJl-3dd4_sQWvQiq75WGpUitM,2253312
|
|
2
|
+
badness-0.1.0.dist-info/METADATA,sha256=hKbI3kk7Ct-XJfL9GjPPchJAnz6hdIX0sdtXlu6rPqQ,3987
|
|
3
|
+
badness-0.1.0.dist-info/WHEEL,sha256=T1DkkvVlw1bn9taKYXZyic2iz5lp4CFExsOlxcRDXDI,94
|
|
4
|
+
badness-0.1.0.dist-info/licenses/LICENSE,sha256=RoX88MYz0Xi8-eMYKtHfYr3cnZZwzA1dE1Bbu7oWs0w,1091
|
|
5
|
+
badness-0.1.0.dist-info/sboms/badness.cyclonedx.json,sha256=WauUJnCq_pSm3AYtb8-LQLk7bOxW0RZ3PfPv53vpzo4,92281
|
|
6
|
+
badness-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Johan Larsson
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|