brittany: add page (#8597)

pull/1/head
Juri 2022-10-02 11:07:40 +02:00 committed by GitHub
parent 333a6b7c6e
commit 946688ddd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions

24
pages/common/brittany.md Normal file
View File

@ -0,0 +1,24 @@
# brittany
> Pretty-print Haskell source files.
> More information: <https://github.com/lspitzner/brittany#readme>.
- Format a Haskell source file and print the result to stdout:
`brittany {{path/to/file.hs}}`
- Format all Haskell source files in the current directory in-place:
`brittany --write-mode=inplace {{*.hs}}`
- Check whether a Haskell source file needs changes and indicate the result through the programme's exit code:
`brittany --check-mode {{path/to/file.hs}}`
- Format a Haskell source file using the specified amount of spaces per indentation level and line length:
`brittany --indent {{4}} --columns {{100}} {{path/to/file.hs}}`
- Format a Haskell source file according to the style defined in the specified config file:
`brittany --config-file {{path/to/config.yaml}} {{path/to/file.hs}}`