brittany: Haskell source code formatter

[ agpl, language, library ] [ Propose Tags ]

See the README.

If you are interested in the implementation, have a look at this document;

The implementation is documented in more detail here.


[Skip to Readme]
Versions 0.8.0.2, 0.8.0.3, 0.9.0.0, 0.9.0.1, 0.10.0.0, 0.11.0.0
Change log ChangeLog.md
Dependencies aeson (>=1.0.1.0 && <1.4), base (>=4.9 && <4.12), brittany, butcher (>=1.3.1 && <1.4), bytestring (>=0.10.8.1 && <0.11), cmdargs (>=0.10.14 && <0.11), containers (>=0.5.7.1 && <0.6), czipwith (>=1.0.1.0 && <1.1), data-tree-print, deepseq (>=1.4.2.0 && <1.5), directory (>=1.2.6.2 && <1.4), extra (>=1.4.10 && <1.7), filepath (>=1.4.1.0 && <1.5), ghc (>=8.0.1 && <8.5), ghc-boot-th (>=8.0.1 && <8.5), ghc-exactprint (>=0.5.6.0 && <0.5.7), ghc-paths (>=0.1.0.9 && <0.2), monad-memo (>=0.4.1 && <0.5), mtl (>=2.2.1 && <2.3), multistate (>=0.7.1.1 && <0.9), neat-interpolation (>=0.3.2 && <0.4), pretty (>=1.1.3.3 && <1.2), random (==1.1.*), safe (>=0.3.9 && <0.4), semigroups (>=0.18.2 && <0.19), strict (>=0.3.2 && <0.4), syb (>=0.6 && <0.8), text (==1.2.*), transformers (>=0.5.2.0 && <0.6), uniplate (>=1.6.12 && <1.7), unsafe (==0.0.*), yaml (>=0.8.18 && <0.9) [details]
License AGPL-3.0-only
Copyright Copyright (C) 2016-2018 Lennart Spitzner
Author Lennart Spitzner
Maintainer Lennart Spitzner <hexagoxel@hexagoxel.de>
Revised Revision 1 made by lspitzner at Thu May 10 16:13:07 UTC 2018
Category Language
Home page https://github.com/lspitzner/brittany/
Bug tracker https://github.com/lspitzner/brittany/issues
Source repo head: git clone https://github.com/lspitzner/brittany.git
Uploaded by lspitzner at Wed May 2 16:38:08 UTC 2018
Distributions LTSHaskell:0.9.0.1, NixOS:0.11.0.0, Stackage:0.11.0.0, openSUSE:0.9.0.1
Executables brittany
Downloads 1082 total (93 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-05-02 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
brittany-dev-lib

set buildable false for anything but lib

DisabledManual

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


Readme for brittany-0.11.0.0

[back to package description]

brittany Hackage version Stackage version Build Status

haskell source code formatter

Output sample

(see more examples and comparisons)

This project's goals roughly are to:

  • Always retain the semantics of the source being transformed;
  • Be idempotent;
  • Support the full GHC-haskell syntax including syntactic extensions (but excluding -XCPP which is too hard);
  • Retain newlines and comments unmodified;
  • Be clever about using the available horizontal space while not overflowing the column maximum if it cannot be avoided;
  • Be clever about aligning things horizontally (this can be turned off completely however);
  • Have linear complexity in the size of the input.

In theory, the core algorithm inside brittany reaches these goals. It is rather clever about making use of horizontal space while still being linear in the size of the input (although the constant factor is not small). See these examples of clever layouting.

But brittany is not finished yet, and there are some open issues that yet require fixing:

  • only the module header (imports/exports), type-signatures and function/value bindings are processed; other module elements (data-decls, classes, instances, etc.) are not transformed in any way; this extends to e.g. bindings inside class instance definitions - they won't be touched (yet).
  • By using ghc-exactprint as the parser, brittany supports full GHC including extensions, but some of the less common syntactic elements (even of 2010 haskell) are not handled.
  • There are some known issues regarding handling of in-source comments. There are cases where comments are not copied to the output (this will be detected and the user will get an error); there are other cases where comments are moved slightly; there are also cases where comments result in wonky newline insertion (although this should be a purely aesthetic issue.)

Try without Installing

You can paste haskell code over here to test how it gets formatted by brittany. (Rg. privacy: the server does log the size of the input, but not the full input/output of requests.)

Other usage notes

  • Supports GHC versions 8.0, 8.2 and 8.4.
  • included in stackage with lts>=10.0 (or nightlies dating to >=2017-11-15)
  • config (file) documentation is lacking.
  • some config values can not be configured via commandline yet.
  • uses/creates user config file in ~/.config/brittany/config.yaml; also reads (the first) brittany.yaml found in current or parent directories.

Installation

  • via cabal "old-build"

    # optionally:
    # mkdir brittany
    # cd brittany
    # cabal sandbox init
    cabal install brittany --bindir=$HOME/.cabal/bin # -w $PATH_TO_GHC_8_0
    
  • via cabal new-build

    cabal unpack brittany
    cd brittany-0.11.0.0
    # cabal new-configure -w $PATH_TO_GHC_8_0
    cabal new-build exe:brittany
    # and it should be safe to just copy the executable, e.g.
    cp `./find dist-newstyle/build/ -type f -name brittany` $HOME/.cabal/bin/
    
  • via stack using a sufficiently recent stackage snapshot (dated to >= 2017-11-15)

    stack install brittany # --resolver lts-10.0
    

    (earlier ltss did not include brittany yet, but the repo should contain a stack.yaml that works with ghc-8.0.)

  • on ArchLinux via the britanny AUR package using aura:

    aura -A brittany
    

Editor Integration

Sublime text

In this gist I have described a haskell setup that includes a shortcut to run brittany formatting.

VSCode

This extension connects commandline brittany to VSCode formatting API. Thanks to @MaxGabriel.

Via HIE

haskell-ide-engine includes a brittany plugin that directly uses the brittany library. Relevant for any editors that properly support the language-server-protocol.

Neovim / Vim 8

The Neoformat plugin comes with support for brittany built in.

Usage

  • Default mode of operation: Transform a single module, from stdin to stdout. Can pass one or multiple files as input, and there is a flag to override them in place instead of using stdout (since 0.9.0.0). So:

    brittany                           # stdin -> stdout
    brittany mysource.hs               # ./mysource.hs -> stdout
    brittany --write-mode=inplace *.hs # apply formatting to all ./*.hs inplace
    
  • For stdin/stdout usage it makes sense to enable certain syntactic extensions by default, i.e. to add something like this to your ~/.config/brittany/config.yaml (execute brittany once to create default):

    conf_forward:
      options_ghc:
      - -XLambdaCase
      - -XMultiWayIf
      - -XGADTs
      - -XPatternGuards
      - -XViewPatterns
      - -XRecursiveDo
      - -XTupleSections
      - -XExplicitForAll
      - -XImplicitParams
      - -XQuasiQuotes
      - -XTemplateHaskell
      - -XBangPatterns
    

Feature Requests, Contribution, Documentation

This currently is a one-person project in the sense that 90% of the code is written by one person. And (unfortunately) it is not my job to keep improving this project. Please forgive that as a consequence my time to invest on new features is rather limited.

Nonetheless I consider it "in active development" :)

One way of speeding things up is to make your own contributions. There is a good amount of high-level documentation at

the documentation index

License

Copyright (C) 2016-2018 Lennart Spitzner

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License, version 3, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.