ormolu

A formatter for Haskell source code https://github.com/tweag/ormolu

Version on this page:0.1.2.0@rev:2
LTS Haskell 16.16:0.1.3.0
Stackage Nightly 2020-09-29:0.1.3.0
Latest on Hackage:0.1.3.0

See all snapshots ormolu appears in

Ormolu

License BSD3 Hackage Stackage Nightly Stackage LTS Build status

Ormolu is a formatter for Haskell source code. The project was created with the following goals 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 influences 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.
  • 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.
  • Choose a style compatible with modern dialects of Haskell. As new Haskell extensions enter broad use, we may change the style to accomodate them.
  • Idempotence: 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 -A ormolu

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-16.0
packages:
- '.'

$ stack build # to build
$ stack install # to install

To use Ormolu directly from GitHub with Nix, this snippet may come in handy:

# This overlay adds Ormolu straight from GitHub.
self: super:

let source = super.fetchFromGitHub {
      owner = "tweag";
      repo = "ormolu";
      rev = "de279d80122b287374d4ed87c7b630db1f157642"; # update as necessary
      sha256 = "0qrxfk62ww6b60ha9sqcgl4nb2n5fhf66a65wszjngwkybwlzmrv"; # as well
    };
    ormolu = import source { pkgs = self; };
in {
  haskell = super.haskell // {
    packages = super.haskell.packages // {
      "${ormolu.ormoluCompiler}" = super.haskell.packages.${ormolu.ormoluCompiler}.override {
        overrides = ormolu.ormoluOverlay;
      };
    };
  };
}

Usage

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

Use find to format a tree recursively:

$ ormolu --mode inplace $(find . -name '*.hs')

Magic comments

Ormolu understands two magic comments:

{- ORMOLU_DISABLE -}

and

{- ORMOLU_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 {- ORMOLU_DISABLE -} at the very top. Note that the source code should still be parseable even without the “excluded” part. Because of that the magic comments cannot be placed arbitrary, but should rather enclose independent top-level definitions.

Current 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.

Editor integration

We know of the following editor integrations:

Running on Hackage

It’s possible to try Ormolu on arbitrary packages from Hackage. For that execute (from the root of the cloned repo):

$ nix-build -A hackage.<package>

Then inspect result/log.txt for possible problems. The derivation will also contain formatted .hs files for inspection and original inputs with .hs-original extension (those are with CPP dropped, exactly what is fed into Ormolu).

Contributing

See CONTRIBUTING.md.

License

See LICENSE.md.

Copyright © 2018–present Tweag I/O

Changes

Ormolu 0.1.2.0

  • Fixed the bug when comments in different styles got glued together after formatting. Issue 589.

  • Added -i as a shortcut for --mode inplace. Issue 467.

  • Improved grouping of top-level declarations. Issue 466.

Ormolu 0.1.1.0

  • Imports in a import lists are now normalized: duplicate imports are combined/eliminated intelligently.

  • Import declarations that can be merged are now automatically merged. Issue 414.

  • The magic comments for disabling and enabling Ormolu now can encompass any fragment of code provided that the remaining code after exclusion of the disabled part is still syntactically correct. Issue 601.

  • Improved sorting of operators in imports. Issue 602.

  • Fixed a bug related to trailing space in multiline comments in certain cases. Issue 603.

  • Added support for formatting linked lists with (:) as line terminator. Issue 478.

  • Fixed rendering of function arguments in multiline layout. Issue 609.

  • Blank lines between definitions in let and while bindings are now preserved. Issue 554.

  • Fixed the bug when type applications stuck to the $ of TH splices that followed them. Issue 613.

  • Improved region formatting so that indented fragments—such as definitions inside of where clauses—can be formatted. Issue 572.

  • Fixed the bug related to the de-association of pragma comments. Issue 619.

Ormolu 0.1.0.0

  • Fixed rendering of type signatures concerning several identifiers. Issue 566.

  • Fixed an idempotence issue with inline comments in tuples and parentheses. Issue 450.

  • Fixed an idempotence issue when certain comments were picked up as “continuation” of a series of comments Issue 449.

  • Fixed an idempotence issue related to different indentation levels in a comment series. Issue 512.

  • Fixed an idempotence issue related to comments which may happen to be separated from the elements they are attached to by the equality sign. Issue 340.

  • Fixed an idempotence issue with type synonym and data declarations where the type has a Haddock. Issue 578.

  • Fix the false positive about AST differences in presence of comments with multiple blank lines in a row. Issue 518.

  • Fixed rendering of comments around if expressions. Issue 458.

  • Unnamed fields of data constructors are now documented using the -- ^ syntax. Issue 445 and Issue 428.

  • Fixed non-idempotent transformation of partly documented data definition. Issue 590.

  • Fixed an idempotence issue related to operators. Issue 522.

  • Renamed the --check-idempotency flag to --check-idempotence. Apparently only the latter is correct.

Ormolu 0.0.5.0

  • Grouping of statements in do-blocks is now preserved. Issue 74.

  • Grouping of TH splices is now preserved. Issue 507.

  • Comments on pragmas are now preserved. Issue 216.

  • Ormolu can now be enabled and disabled via special comments. Issue 435.

  • Added experimental support for simple CPP. Issue 415.

  • Added two new options --start-line and --end-line that allow us to select a region to format. Issue 516.

  • Fixed rendering of module headers in the presence of preceding comments or Haddocks. Issue 561.

Ormolu 0.0.4.0

  • When given several files to format, Ormolu does not stop on the first failure, but tries to format all the files. Issue 502.

  • Made rendering of pattern matches involving operators consistent with other cases of rendering of operators. Issue 500.

  • More compact rendering of type family injectivity constraints. Issue 482.

  • Improved rendering of the keyword where in class, data, and type family declarations. When headers of these declarations are multi-line where is now put on its own line. Issue 509.

  • Fixed the bug pertaining to rendering of arrow notation with multiline expressions. Issue 513.

  • Made rendering of data type definitions, value-level applications, and application of types use the same style. Moreover, existential now doesn’t cause the data constructor be unconditionally rendered in multiline layout. Issue 427.

  • Records with a single data constructor are now formatted more compactly. Issue 425.

  • Switched to ghc-lib-parser-8.10.1.

  • Implemented support for the new language extensions ImportQualifiedPost and StandaloneKindSignatures.

Ormolu 0.0.3.1

  • Fixed rendering of record updates with the record dot preprocessor syntax Issue 498.

Ormolu 0.0.3.0

  • Fixed an issue related to unnecessary use of curly braces. Issue 473.

  • Fixed the issue with formatting multi-way if when it happens to be a function applied to arguments Issue 488. This changed the way multi-line if is formatted in general.

  • Added support for record dot pre-processor when used via the plugin. Issue 486.

  • Stopped hanging record constructors and improved placing potentially-hanging consturctions in the presence of comments. Issue 447.

  • Fixed indentation in presence of type applications. Issue 493.

  • Class and instance declarations now do not have a blank line after where. Grouping of methods from the original input is also preserved with some normalizations. Issue 431.

Ormolu 0.0.2.0

  • Switched to ghc-lib-parser instead of depending on the ghc package directly. This should allow us to use newest features of GHC while not necessarily depending on the newest version of the compiler. In addition to that Ormolu is now GHCJS-compatible.

  • Now unrecognized GHC options passed with --ghc-opt cause Ormolu to fail (exit code 7).

  • Fixed formatting of result type in closed type families. See issue 420.

  • Fixed a minor inconsistency between formatting of normal and foreign type signatures. See issue 408.

  • Fixed a bug when comment before module header with Haddock was moved inside the export list. See issue 430.

  • Empty foralls are now correctly preserved. See issue 429.

  • Fixed issue 446, which involved braces and operators.

  • When there are comments between preceding Haddock (pipe-style) and its corresponding declaration they are preserved like this in the output instead of being shifted. To be clear, this is not a very good idea to have comments in that position because the Haddock will end up not being associated with the declarations. Issues 440 and 448.

  • Implemented correct handling of shebangs. Issue 377.

  • Implemented correct handling of stack headers. Issue 393.

  • Sorting language pragmas cannot not change meaning of the input program anymore. Issue 404.

  • Fixed formatting of applications where function is a complex expression. Issue 444.

Ormolu 0.0.1.0

  • Initial release.