diff --git a/pages/common/brittany.md b/pages/common/brittany.md new file mode 100644 index 000000000..9a3285d15 --- /dev/null +++ b/pages/common/brittany.md @@ -0,0 +1,24 @@ +# brittany + +> Pretty-print Haskell source files. +> More information: . + +- 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}}`