mirror of https://github.com/google/ormolu.git synced 2024-08-15 11:00:28 +03:00

Go to file

mrkkrp 05e420159a Replace current year with the word "present" [skip ci] Saves a lot of effort updating all those thingies every year.		2019-07-02 21:27:45 +02:00
.circleci	Clean nix configuration	2019-06-23 19:17:05 +02:00
app	Use explicit error code in `check` mode	2019-06-19 21:28:22 +02:00
data	Only drop indentation present for every line in multiline comments	2019-07-01 00:07:54 +02:00
nix	Drop redundant trailing newlines in nix files	2019-06-24 20:14:49 +02:00
src	Only drop indentation present for every line in multiline comments	2019-07-01 00:07:54 +02:00
tests	Make test suite failures a bit more readable	2019-06-09 15:03:55 +02:00
.gitignore	Clean nix configuration	2019-06-23 19:17:05 +02:00
CHANGELOG.md	Initial commit	2018-11-25 20:51:22 +07:00
CONTRIBUTING.md	Add ‘CONTRIBUTING.md’ file to the repository	2019-05-31 16:09:35 +02:00
default.nix	Drop redundant trailing newlines in nix files	2019-06-24 20:14:49 +02:00
DESIGN.md	Minor corrections to the design document	2019-02-14 22:12:13 +01:00
EXAMPLES.md	Add examples of comments.	2019-01-08 12:37:42 -03:00
LICENSE.md	Replace current year with the word "present"	2019-07-02 21:27:45 +02:00
ormolu.cabal	Implement printer for ‘WarningD’	2019-06-26 22:26:31 +02:00
README.md	Replace current year with the word "present"	2019-07-02 21:27:45 +02:00
Setup.hs	Initial commit	2018-11-25 20:51:22 +07:00
shell.nix	Clean nix configuration	2019-06-23 19:17:05 +02:00

Ormolu

Ormolu is a formatter for Haskell source code. The projects was created with the following features in mind:

Using GHC's own parser to avoid parsing problems caused by haskell-src-exts.
Let some whitespace be programmable. The layout of the input influence the layout choices in the output. This means that the choices between single-line/multi-line layouts in each particular situation are made by the user, not by an algorithm. This makes the implementation simpler and leaves some control to the user while still guaranteeing that the formatted code is stylistically consistent.
Writing code in such a way so it's easy to modify and maintain. Roughly, it means that the project follows the path of hindent and is very much about printing AST in a particular way.
Implementing one “true” formatting style which admits no configuration.
That formatting style aims to result in minimal diffs while still remaining very close to “conventional” Haskell formatting people use.
Idempotency: formatting already formatted code doesn't change it.
Be well-tested and robust to the point that it can be used in large projects without exposing unfortunate, disappointing bugs here and there.

Building

The easiest way to build the project is with Nix:

$ nix-build

Or with cabal-install from the Nix shell:

$ nix-shell --run "cabal new-build"

Alternatively, stack could be used with a stack.yaml file as follows.

$ cat stack.yaml
resolver: lts-13.19
packages:
- '.'

$ stack build

The following will print the formatted output to the standard output.

$ ormolu Module.hs

Add --mode inplace to replace the contents of the input file with the formatted output.

$ ormolu --mode inplace Module.hs

A configuration file can specify the language extensions to use by default.

$ cat ormolu.yaml
ghc-opts:
  - -XLambdaCase
unsafe: False
debug: False

$ ormolu -c ormolu.yaml Module.hs