ormolu

A formatter for Haskell source code

Github星跟蹤圖

Ormolu

License BSD3
Hackage
Stackage Nightly
Stackage LTS
CircleCI

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

$ stack build

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

Current limitations

  • Does not handle CPP (wontfix, see the design document).
  • 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

主要指標

概覽
名稱與所有者tweag/ormolu
主編程語言Haskell
編程語言Haskell (語言數: 4)
平台
許可證Other
所有者活动
創建於2018-11-25 12:16:23
推送於2025-05-12 08:43:03
最后一次提交2025-05-08 10:02:05
發布數34
最新版本名稱0.8.0.0 (發布於 )
第一版名稱0.0.1.0 (發布於 )
用户参与
星數1k
關注者數37
派生數83
提交數779
已啟用問題?
問題數572
打開的問題數67
拉請求數550
打開的拉請求數1
關閉的拉請求數45
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?