Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
The Haskell Refactoring Tool
Haskell TeX HTML Bison Emacs Lisp Shell Other

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
docker
elisp
experiments
hareview
misc
old
src
test
.ghci
.gitignore
.travis.yml
ChangeLog
GHC-NOTES
HaRe.cabal
HaReLogo.svg
LAYOUT.md
LICENSE
NOTES
README.markdown
Setup.hs
Setup.lhs
TODO
TODO.org
buildall.sh
mkModmap.sh
rundocker.sh

README.markdown

HaRe : The Haskell Refactorer

Build Status

Getting Started

cabal install HaRe

Check that it works from the command line

$ ghc-hare --version
0.7.0.x

Running the bare command lists available refactorings and their parameters

Emacs integration

Currently only emacs integration is offered. Add the following to your ~/.emacs using the load-path entry that matches the installation on your machine.

(add-to-list 'load-path
    "~/.cabal/share/HaRe-0.7.0.8/elisp")
(add-to-list 'load-path
    "~/.cabal/share/i386-linux-ghc-7.6.3/HaRe-0.7.0.8/elisp")
(require 'hare)
(autoload 'hare-init "hare" nil t)

Add an intializer hook to the ghc-mode command

(add-hook 'haskell-mode-hook (lambda () (ghc-init) (hare-init) (flymake-mode)))

Alternatively, if using haskell-mode, and initializing via a function

;; Haskell main editing mode key bindings.
(defun haskell-hook ()

  ;(lambda nil (ghc-init) (flymake-mode))
  (ghc-init)
  (flymake-mode)
  (hare-init)
  ...
)

If this is done correctly, there should be an additional Refactorer menu entry when opening a haskell file. The refactorings can be initiated via the menu, or using the keyboard shortcuts displayed in the menu.

The installation can be fine-tuned using

M-x customize-variable

on

hare-search-paths
ghc-hare-command

Each refactoring will first ask for any information it requires, e.g. a new name if renaming, and then attempt the refactoring. If any precondition is not met this will be reported and the refactoring will abort.

If it succeeds, you will be given the option to look at an ediff session to see what changes would be made, and each file can be individually accepted or declined.

If the refactoring is commited, the original file is renamed to have a suffix containing the current timestamp.

E.g., after renaming in Foo.hs, there will be two files

Foo.hs
Foo.hs.2013-08-22T19:32:31+0200

This allows a sequence of refactorings to be undone manually if required. In theory.

Development & Support

Join in at #haskell-refactorer on freenode.

Running test suite

To run the test suite do:

cabal configure --enable-tests && cabal build && cabal test

See http://hspec.github.com/ for details on hspec

see http://travis-ci.org/#alanz/HaRe for continuous build results

Resources

Coding style

Contributors: please try to follow https://github.com/tibbe/haskell-style-guide Note:A consistent coding layout style is more important than what specific on is used.

Contributors

  • Simon Thompson
  • Christopher Brown
  • Huiqing Li
  • Alan Zimmerman
  • Many others, ..

Logo

The logo was designed by Christi du Toit, http://www.behance.net/christidutoit

Something went wrong with that request. Please try again.