Happy Haskell Hacking for editors. DEPRECATED

License: Other

Language: Haskell

ghc-mod: Happy Haskell Hacking

build status

ghc-mod provides editors/IDEs with support for Haskell compiler features. It supports both Cabal and Stack based projects and integrations exist for Emacs, Vim, Atom, IntelliJ and VSCode.

Note: GHC 8.2 is not currently supported, See #900


Using ghc-mod in your Development Environment

To use ghc-mod in your development environment of choice you need two things:

  • The ghc-mod program included in the package of the same name, see Installing
  • A ghc-mod frontend to integrate it into your development environment, see Frontend

Using ghc-mod as an IDE Backend Program

We provide two modes of operation for frontends: interactive and single shot mode. The former is accessed by calling $ ghc-mod legacy-interactive. This will sit and wait for you to type a command, exiting when an empty line is entered. Interactive mode is pretty much always faster than single shot mode, since it gives ghc-mod the ability to cache the compiler session between commands. On the other hand, it needs more memory because it keeps these things cached.

Single shot mode is pretty much only there for (backwards) compatibility with Vim, since it only recently got the ability to talk to background processes without installing some external plugin. You can use single shot mode by simply calling the sub-commands of the ghc-mod program. Since recompiling large projects can be really, really slow, you really should prefer interactive mode.

As a rule of thumb, all commands available in single shot mode are available in interactive mode. A list of the former can be obtained by running $ ghc-mod --help.

If you're developing a new ghc-mod frontend, we'd love to hear from you! Please open an issue or e-mail the maintainer. Also, we invite you to add installation and configuration instructions to Frontend.

Using ghc-mod as a Library

Internally, ghc-mod uses the Glasgow Haskell Compiler's API to implement most of its functionality.

In order to provide a hassle-free experience to users, ghc-mod tries hard to automatically, and correctly, detect and, if necessary, tweak the environment GHC needs. It also handles some of the more cumbersome parts of getting a working compiler session up and running.

This functionality can be very useful to all kinds of Haskell development tools. Therefore, we want to expose all the useful abstractions ghc-mod provides.

Right now the ghc-mod API is pretty messy; a result of major internal rewrite and reorganization coupled with too little time for cleanups over the course of almost 100 releases! We would like to make a cut during v6.0 or so and completely redo the API, but we need more input from downstream tool writers to do that properly, see Library API Redesign.

For example, The Haskell Refactorer (HaRe) uses the build environment abstraction ghc-mod provides so it can concentrate on its core functionality instead of worrying about build environments and compiler session setup.

Recently the haskell-ide-engine project has sprung up, and if you're planning to write any kind of tool that needs editor integration eventually you should definitely look into that. haskell-ide-engine uses ghc-mod at its core, so you'll want to be familliar with it either way.

API "documentation" is here: Hackage docs.

Reporting Bugs

Please report bugs on the GitHub issue tracker for ghc-mod: https://github.com/DanielG/ghc-mod/issues

Including general environment information like the operating system (distribution, version) you're using and the output of $ ghc-mod debug run in your project directory is probably a good idea.


If you have any problems, suggestions, comments swing by #ghc-mod (web client) on Freenode. If you're reporting a bug please also create an issue here (GitHub issue tracker) so we have a way to contact you if you don't have time to stay.

Do hang around for a while if no one answers, and repeat your question if you still haven't gotten any answer after a day or so (the maintainer was probably asleep). You're most likely to get an answer during the day in GMT+1.

Project Statistics

Sourcerank 4
Repository Size 3.12 MB
Stars 691
Forks 189
Watchers 34
Open issues 115
Dependencies 0
Contributors 88
Tags 99
Last updated
Last pushed

Top Contributors See all

Kazu Yamamoto Nikolay Yakimov Alejandro Serrano Alan Zimmerman Kohei Suzuki Sergey Vinokurov Alexandr Ruchkin Daniel Vigovszky Niklas Hambüchen scturtle 日比野 啓 (Kei Hibino) Hideyuki Tanaka Nicolas Rolland Anthony Cowley Moritz Kiefer Dan Frumin Daniel Schoepe Tim Dysinger Ruben Astudillo Iku Iwasa

Packages Referencing this Repo

ghc-mod is a backend program to enrich Haskell programming in editors. It strives to offer most o...
Latest release - Updated - 691 stars

Recent Tags See all

v5.8.0.0 May 28, 2017
v5.7.0.0 January 16, 2017
v5.6.0.0 July 29, 2016
v5.5.0.0 January 19, 2016
v5.4.0.0 September 16, 2015
v5.3.0.0 August 14, 2015
v5.2.1.2 December 31, 2014
v5.2.1.1 November 03, 2014
v5.2.1.0 November 02, 2014
v5.2.0.0 October 30, 2014
hcar-2014-11 October 08, 2014
v5.1.1.0 October 03, 2014
show October 03, 2014
v5.1.0.2 September 17, 2014
v5.1.0.1 September 16, 2014

Interesting Forks See all

Happy Haskell programming on Emacs/Vim
Haskell - Other - Last pushed - 2 stars - 2 forks
Happy Haskell programming for editors
Haskell - BSD-3-Clause - Last pushed - 1 stars
Happy Haskell programming on Emacs
Emacs Lisp - BSD-3-Clause - Last pushed - 1 stars
Happy Haskell programming for editors
Haskell - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2017-06-11 12:59:49 UTC

Login to resync this repository