Updated documentation

This commit is contained in:
Ethan P 2019-06-21 15:51:13 -07:00
parent 09604dbefc
commit 30416b89b6
No known key found for this signature in database
GPG Key ID: 1F8DF8091CD46FBC
2 changed files with 21 additions and 4 deletions

View File

@ -7,7 +7,7 @@ Bash scripts that integrate [bat](https://github.com/sharkdp/bat) with various c
## Scripts
- [`batgrep`](doc/batgrep.md) (ripgrep + bat)
- [`prettybat`](doc/prettybat.md) (prettier + bat)
- [`prettybat`](doc/prettybat.md) (pretty printing + bat)
 

View File

@ -1,6 +1,6 @@
# 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
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 header displayed by bat will show `STDIN` instead of the filename.
- The git changes sidebar will not work with files that have been formatted.