mirror of
https://github.com/eth-p/bat-extras.git
synced 2025-06-20 19:57:46 +02:00
Updated documentation
This commit is contained in:
parent
09604dbefc
commit
30416b89b6
@ -7,7 +7,7 @@ Bash scripts that integrate [bat](https://github.com/sharkdp/bat) with various c
|
|||||||
## Scripts
|
## Scripts
|
||||||
|
|
||||||
- [`batgrep`](doc/batgrep.md) (ripgrep + bat)
|
- [`batgrep`](doc/batgrep.md) (ripgrep + bat)
|
||||||
- [`prettybat`](doc/prettybat.md) (prettier + bat)
|
- [`prettybat`](doc/prettybat.md) (pretty printing + bat)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# bat-extras: prettybat
|
# bat-extras: prettybat
|
||||||
|
|
||||||
A script that uses [prettier](https://github.com/burntsushi/ripgrep) for reformatting and bat for syntax highlighting.
|
A script that uses various pretty-printing tools and bat to display code in your terminal.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -18,10 +18,27 @@ See `man bat` for more information.
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Languages
|
||||||
|
|
||||||
|
| Language | Formatter |
|
||||||
|
| -------------------- | ----------------------------------------------- |
|
||||||
|
| JavaScript (JS, JSX) | [prettier](https://prettier.io/) |
|
||||||
|
| TypeScript (TS, TSX) | [prettier](https://prettier.io/) |
|
||||||
|
| CSS, SCSS, SASS | [prettier](https://prettier.io/) |
|
||||||
|
| Markdown | [prettier](https://prettier.io/) |
|
||||||
|
| JSON | [prettier](https://prettier.io/) |
|
||||||
|
| YAML | [prettier](https://prettier.io/) |
|
||||||
|
| HTML | [prettier](https://prettier.io/) |
|
||||||
|
| Rust | [rustfmt](https://github.com/rust-lang/rustfmt) |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Caveats
|
## Caveats
|
||||||
|
|
||||||
The header displayed by bat will show `STDIN` instead of the filename.
|
- The header displayed by bat will show `STDIN` instead of the filename.
|
||||||
There's nothing that can be done about this with the current version of bat.
|
- The git changes sidebar will not work with files that have been formatted.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user