bat-extras/doc/prettybat.md
2023-12-13 10:26:22 -08:00

2.4 KiB

bat-extras: prettybat

Pretty-print source code and highlight it with bat.

The only thing better than syntax highlighting? Syntax highlighting and code formatting. This script combines the best of both worlds by using various formatters to format source files before using bat to highlight them.

Usage

prettybat [OPTIONS] [PATH...]

Options

Every option is passed through to bat. See man bat for more information.

Languages

Language Formatter
JavaScript (JS, JSX) prettier
TypeScript (TS, TSX) prettier
CSS, SCSS, SASS prettier
Markdown prettier
JSON prettier
YAML prettier
HTML prettier
SVG prettier
Rust rustfmt
Bash shfmt
C ClangFormat
C++ ClangFormat
Objective-C ClangFormat
Python black
Elixir mix format

Caveats

  • The header displayed by bat will show STDIN instead of the filename (bat 0.13 or older).
  • The git changes sidebar will not work with files that have been formatted.

Installation

This script is a part of the bat-extras suite of scripts. You can find install instructions here.

Issues?

If you find an issue or have a feature suggestion, make a pull request or issue through GitHub! Contributions are always welcome.