Hackage :: [Package]

hindent: Extensible Haskell pretty printer

[ bsd3, development, library, program ] [ Propose Tags ] [ Report a vulnerability ]

Extensible Haskell pretty printer. Both a library and an executable.

See the Github page for usage/explanation: https://github.com/chrisdone/hindent

[Skip to Readme]

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

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.0, 1.0, 2.0, 2.1, 2.2, 2.3, 2.4, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.9.1, 4.0, 4.1.0, 4.1.1, 4.2.0, 4.2.1, 4.2.2, 4.2.3, 4.2.4, 4.3.0, 4.3.1, 4.3.2, 4.3.3, 4.3.4, 4.3.5, 4.3.6, 4.3.7, 4.3.8, 4.3.9, 4.3.10, 4.3.11, 4.3.12, 4.4.0, 4.4.1, 4.4.2, 4.5.0, 4.5.1, 4.5.2, 4.5.3, 4.5.4, 4.5.5, 4.5.6, 4.5.7, 4.6.0, 4.6.1, 4.6.2, 4.6.3, 4.6.4, 5.0.0, 5.0.1, 5.1.0, 5.1.1, 5.2.0, 5.2.1, 5.2.2, 5.2.3, 5.2.4, 5.2.4.1, 5.2.5, 5.2.6, 5.2.7, 5.3.0, 5.3.1, 5.3.2, 5.3.3, 5.3.4, 6.0.0, 6.1.0, 6.1.1, 6.2.0, 6.2.1 (info)
Change log CHANGELOG.md
Dependencies base (>=4.7 && <4.11), bytestring, containers, deepseq, descriptive (>=0.7 && <0.10), directory, exceptions, ghc-prim, haskell-src-exts (>=1.18 && <1.20), hindent, monad-loops, mtl (<2.3), path, path-io, text, transformers, unix-compat, utf8-string, yaml [details]
License BSD-3-Clause
Copyright 2014 Chris Done, 2015 Andrew Gibiansky
Author Chris Done, Andrew Gibiansky, Tobias Pflug, Pierre Radermecker
Maintainer chrisdone@gmail.com
Revised Revision 2 made by AndreasAbel at 2023-04-12T12:57:10Z
Category Development
Home page http://www.github.com/chrisdone/hindent
Bug tracker https://github.com/chrisdone/hindent/issues
Source repo head: git clone https://github.com/chrisdone/hindent
Uploaded by ChrisDone at 2016-08-30T10:10:09Z
Distributions Debian:5.3.1, LTSHaskell:6.2.1, NixOS:6.1.1
Reverse Dependencies 4 direct, 0 indirect [details]
Executables hindent
Downloads 66076 total (18 in the last 30 days)
Rating 2.25 (votes: 2) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2016-08-30 [all 1 reports]

Readme for hindent-5.2.0

[back to package description]

hindent Hackage Build Status

Haskell pretty printer

Demonstration site

Examples

Install

$ stack install hindent

Usage

$ hindent --help
hindent --version --help --style STYLE --line-length <...> --tab-size <...> --no-force-newline [-X<...>]* [<FILENAME>]
Version 5.1.1
Default --tab-size is 2. Specify --tab-size 4 if you prefer that.
-X to pass extensions e.g. -XMagicHash etc.
The --style option is now ignored, but preserved for backwards-compatibility.
Johan Tibell is the default and only style.

hindent is used in a pipeline style

$ cat path/to/sourcefile.hs | hindent

The default tab size is 2. Configure tab size with --tab-size:

$ echo 'example = case x of Just p -> foo bar' | hindent --tab-size 2; echo
example =
  case x of
    Just p -> foo bar
$ echo 'example = case x of Just p -> foo bar' | hindent --tab-size 4; echo
example =
    case x of
        Just p -> foo bar

Customization

Create a .hindent.yaml file in your project directory or in your ~/ home directory. The following fields are accepted and are the default:

tab-size: 2
line-length: 80
force-trailing-newline: true

Emacs

In elisp/hindent.el there is hindent-mode, which provides keybindings to reindent parts of the buffer:

  • M-q reformats the current declaration. When inside a comment, it fills the current paragraph instead, like the standard M-q.
  • C-M-\ reformats the current region.

To enable it, add the following to your init file:

(add-to-list 'load-path "/path/to/hindent/elisp")
(require 'hindent)
(add-hook 'haskell-mode-hook #'hindent-mode)

Vim

The 'formatprg' option lets you use an external program (like hindent) to format your text. Put the following line into ~/.vim/ftplugin/haskell.vim to set this option for Haskell files:

setlocal formatprg=hindent

Then you can format with hindent using gq. Read :help gq and help 'formatprg' for more details.

Note that unlike in emacs you have to take care of selecting a sensible buffer region as input to hindent yourself. If that is too much trouble you can try vim-textobj-haskell which provides a text object for top level bindings.

Atom

Basic support is provided through atom/hindent.coffee. Mode should be installed as package into .atom\packages\${PACKAGE_NAME}, here is simple example of atom package.