From 30416b89b60cd0b47df58eb0db85496f3ed955d2 Mon Sep 17 00:00:00 2001 From: Ethan P Date: Fri, 21 Jun 2019 15:51:13 -0700 Subject: [PATCH] Updated documentation --- README.md | 2 +- doc/prettybat.md | 23 ++++++++++++++++++++--- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d74323f..b9d257d 100644 --- a/README.md +++ b/README.md @@ -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)   diff --git a/doc/prettybat.md b/doc/prettybat.md index 0708316..a757d80 100644 --- a/doc/prettybat.md +++ b/doc/prettybat.md @@ -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.