An extremely fast LaTeX formatter written in Rust.
| Input | Output |
\documentclass{article}
\begin{document}
\begin{itemize}
\item Lists with items
over multiple lines
\end{itemize}
\begin{equation}
E = m c^2
\end{equation}
\end{document} |
\documentclass{article}
\begin{document}
\begin{itemize}
\item Lists with items
over multiple lines
\end{itemize}
\begin{equation}
E = m c^2
\end{equation}
\end{document} |
- ⚡ Extremely fast run-time performance
- 🔧 Minimal configuration required
- 📟 Command-line interface
- 📜 Handles LaTeX file types
.tex,.bib,.cls, and.sty - 🦀 Written entirely in safe Rust
Install the stable release with
cargo install tex-fmtInstall from GitHub with
cargo install --git "https://github.com/wgunderwood/tex-fmt"Install from nixpkgs into a temporary shell with
nix-shell -p tex-fmtBuild from source using flakes with
nix build "github:wgunderwood/tex-fmt"Add to your NixOS installation with
environment.systemPackages = [
pkgs.tex-fmt
];Install from the Arch User Repository. For example, using the yay AUR helper:
yay -S tex-fmtBinaries for various platforms are available on the GitHub releases page.
Integration with VS Code is provided by the LaTeX Workshop extension. You will need to first install tex-fmt through one of the above methods.
tex-fmt file.tex # format file.tex and overwrite
tex-fmt --check file.tex # check if file.tex is correctly formatted
tex-fmt --print file.tex # format file.tex and print to STDOUT
tex-fmt --keep file.tex # do not wrap long lines
tex-fmt --stdin # read from STDIN and print to STDOUT
tex-fmt --help # view help informationEnding a source line with % tex-fmt: skip disables formatting for that line.
To disable the formatter for a block, use % tex-fmt: off and % tex-fmt: on.
\documentclass{article}
\begin{document}
This line is skipped % tex-fmt: skip
% tex-fmt: off
These lines are also
not formatted or wrapped
% tex-fmt: on
\end{document}Verbatim environments including verbatim, Verbatim, lstlisting
and minted are automatically skipped.
When formatting all of the test cases, tex-fmt is over a thousand times faster than latexindent.
| Files | Lines | Size | tex-fmt | latexindent | latexindent -m |
|---|---|---|---|---|---|
| 49 | 94k | 3.5M | 0.068s | 99s [x1456] | 132s [x1863] |
Please feel free to open an issue or submit a pull request,
including as much information as you can. Documentation of internals
can be accessed by cloning this repository and running cargo doc.
Alternatively, you can Buy Me a Coffee!
- Semantic parsing of LaTeX code not conducted
- No linting or correction of syntax errors
- Customization via configuration files not supported
- Compliance with existing formatting guidelines not guaranteed
- No spelling or grammar checking
-
latexindent. Perl script, many configuration options, slow on large files
-
LaTeXTidy. Perl script, download links seem to be broken
-
latex-pretty. Browser-based, uses latexindent as the backend
-
latexformat.com. Browser-based
-
texpretty. C program which works sometimes and appears to be fast
-
latex-editor. Browser-based
-
LaTeXFmt. Vim plugin, does not apply indentation
-
latex-formatter. Visual Studio plugin, uses latexindent as the backend