fourmolu: A formatter for Haskell source code

[ bsd3, development, formatting, library, program ] [ Propose Tags ]

A formatter for Haskell source code.


[Skip to Readme]
Versions [RSS] [faq] 0.0.6.0, 0.1.0.0, 0.2.0.0, 0.3.0.0, 0.4.0.0
Change log CHANGELOG.md
Dependencies aeson (>=1.4.0.0 && <2.1), ansi-terminal (>=0.10 && <1.0), base (>=4.12 && <5.0), bytestring (>=0.2 && <0.12), Cabal (==3.4.*), containers (>=0.5 && <0.7), Diff (>=0.4 && <1.0), directory (>=1.3.3 && <1.4), dlist (>=0.8 && <2.0), exceptions (>=0.6 && <0.11), filepath (>=1.4.2.1 && <1.5), fourmolu, ghc-lib-parser (==9.0.*), gitrev (==1.3.*), HsYAML (==0.2.*), HsYAML-aeson (==0.2.*), mtl (>=2.0 && <3.0), optparse-applicative (>=0.14 && <0.17), syb (==0.7.*), text (>=0.2 && <1.3) [details]
License BSD-3-Clause
Author
Maintainer Matt Parsons <parsonsmatt@gmail.com> George Thomas <georgefsthomas@gmail.com>
Revised Revision 1 made by brandonchinn178 at 2021-11-28T23:11:14Z
Category Development, Formatting
Home page https://github.com/parsonsmatt/fourmolu
Bug tracker https://github.com/parsonsmatt/fourmolu/issues
Source repo head: git clone https://github.com/parsonsmatt/fourmolu.git
Uploaded by GeorgeThomas at 2021-10-03T23:05:17Z
Distributions Arch:0.3.0.0, LTSHaskell:0.3.0.0, NixOS:0.3.0.0, Stackage:0.4.0.0
Executables fourmolu
Downloads 4092 total (497 in the last 30 days)
Rating 1.25 (votes: 1) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-10-04 [all 1 reports]

Modules

[Index] [Quick Jump]

Manual Flags

NameDescriptionDefault
dev

Turn on development settings.

Disabled
Automatic Flags
NameDescriptionDefault

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees

Candidates


Readme for fourmolu-0.4.0.0

[back to package description]

Fourmolu

License BSD3 Hackage

Fourmolu is a formatter for Haskell source code. It is a fork of Ormolu, with the intention to continue to merge upstream improvements.

We share all bar one of Ormolu's goals:

  • Using GHC's own parser to avoid parsing problems caused by haskell-src-exts.
  • Let some whitespace be programmable. The layout of the input influences the layout choices in the output. This means that the choices between single-line/multi-line layouts in certain situations 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.
  • That formatting style aims to result in minimal diffs.
  • Choose a style compatible with modern dialects of Haskell. As new Haskell extensions enter broad use, we may change the style to accommodate them.
  • Idempotence: formatting already formatted code doesn't change it.
  • Be well-tested and robust so that the formatter can be used in large projects.
  • Implementing one “true” formatting style which admits no configuration. We allow configuration of various parameters, via CLI options or config files. We encourage any contributions which add further flexibility.

Configuration

Fourmolu looks for a fourmolu.yaml file in all parents of the current directory, followed by the XDG config directory. A complete configuration file, corresponding to Fourmolu's default options, looks like:

indentation: 4
comma-style: leading # for lists, tuples etc. - can also be 'trailing'
record-brace-space: false # rec {x = 1} vs. rec{x = 1}
indent-wheres: false # 'false' means save space by only half-indenting the 'where' keyword
diff-friendly-import-export: true # 'false' uses Ormolu-style lists
respectful: true # don't be too opinionated about newlines etc.
haddock-style: multi-line # '--' vs. '{-'
newlines-between-decls: 1 # number of newlines between top-level declarations

See here for a config to simulate the behaviour of Ormolu.

These options can also be set on the command line (which takes precedence over config files). Run fourmolu -h to see all options.

Building and installation

Simply run cabal v2-install fourmolu, to install the latest release from Hackage.

You can also clone this repository, then build with Cabal or Stack.

Usage

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

$ fourmolu Module.hs

Add -i (or --mode inplace) to replace the contents of the input file with the formatted output.

$ fourmolu -i Module.hs

Use find to format a tree recursively:

$ fourmolu -i $(find . -name '*.hs')

Or find all files in a project with git ls-files:

$ fourmolu --mode inplace $(git ls-files '*.hs')

To check if files are are already formatted (useful on CI):

$ fourmolu --mode check $(find . -name '*.hs')

Editor integration

Fourmolu can be integrated with your editor via the Haskell Language Server.

Magic comments

Fourmolu understands two magic comments:

{- FOURMOLU_DISABLE -}

and

{- FOURMOLU_ENABLE -}

This allows us to disable formatting selectively for code between these markers or disable it for the entire file. To achieve the latter, just put {- FOURMOLU_DISABLE -} at the very top. Note that for Fourmolu to work the fragments where Ormolu is enabled must be parseable on their own. Because of that the magic comments cannot be placed arbitrarily, but rather must enclose independent top-level definitions.

{- ORMOLU_DISABLE -} and {- ORMOLU_ENABLE -}, respectively, can be used to the same effect, and the two styles of magic comments can be mixed.

Account for .cabal files

Many cabal and stack projects use default-extensions to enable GHC language extensions in all source files. With the --cabal-default-extensions flag, Ormolu will take them into consideration during formatting.

When you format input from stdin, you can pass --stdin-input-file which will give Ormolu the location of the Haskell source file that should be used as the starting point for searching for a suitable .cabal file.

Exit codes

Exit code Meaning
0 Success
1 General problem
2 CPP used (deprecated)
3 Parsing of original input failed
4 Parsing of formatted code failed
5 AST of original and formatted code differs
6 Formatting is not idempotent
7 Unrecognized GHC options
8 Cabal file parsing failed
9 Missing input file path when using stdin input and accounting for .cabal files
100 In checking mode: unformatted files
101 Inplace and check modes do not work with stdin
102 Other issue (with multiple input files)
400 Failed to load Fourmolu configuration file

Limitations

  • CPP support is experimental. CPP is virtually impossible to handle correctly, so we process them as a sort of unchangeable snippets. This works only in simple cases when CPP conditionals surround top-level declarations. See the CPP section in the design notes for a discussion of the dangers.
  • Input modules should be parsable by Haddock, which is a bit stricter criterion than just being valid Haskell modules.
  • Various minor idempotence issues, most of them are related to comments.
  • Fourmolu is in a fairly early stage of development. The implementation should be as stable as Ormolu, as it only makes minimal changes, and is extensively tested. But the default configuration style may change in some minor ways in the near future, as we make more options available. It will always be possible to replicate the old default behaviour with a suitable fourmolu.yaml.

Contributing

If there are any options you'd like to see, let us know. If it's not too complicated to implement (and especially if you implement it yourself!) then we'll probably add it.

Run cabal test and ./format.sh before submitting any pull requests.

License

See LICENSE.md.

Copyright © 2018–2020 Tweag I/O, 2020-present Matt Parsons

Acknowledgements

The vast majority of work here has been done by the Ormolu developers, and thus they deserve almost all of the credit. This project is simply intended as a haven for those of us who admire their work, but can't quite get on board with some of their decisions when it comes down to the details.