Update readme: Add editor integration paragraph

pull/106/head
Lennart Spitzner 2018-01-13 18:02:00 +01:00 committed by GitHub
parent bcdd058485
commit 8fe9ba1f43
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions

View File

@ -96,6 +96,19 @@ log the size of the input, but _not_ the full requests.)
aura -A brittany
~~~~
# Editor Integration
#### Sublime text
[In this gist](https://gist.github.com/lspitzner/097c33177248a65e7657f0c6d0d12075)
I have described a haskell setup that includes a shortcut to run brittany formatting.
#### VSCode
[This extension](https://marketplace.visualstudio.com/items?itemName=MaxGabriel.brittany)
connects commandline `brittany` to VSCode formatting API. Thanks to Max Garbriel.
#### Via HIE
[haskell-ide-engine](https://github.com/haskell/haskell-ide-engine)
includes a `brittany` plugin that directly uses the brittany library.
Relevant for any editors that properly support the language-server-protocol.
# Usage
- Default mode of operation: Transform a single module, from `stdin` to `stdout`.