2017-01-22 23:31:14 +00:00
|
|
|
# ghc-mod: Happy Haskell Hacking
|
|
|
|
|
[](https://gitlab.com/dxld/ghc-mod/commits/master)
|
2013-05-22 03:04:05 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
ghc-mod is a couple of different things depending on what you want to do, you
|
|
|
|
|
should read the corresponding section:
|
2013-05-22 03:04:05 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
- for [all Haskell developers (Using ghc-mod in your development environment)](#using-ghc-mod-in-your-development-environment)
|
|
|
|
|
- for [people developing Haskell IDEs (Using ghc-mod as an IDE backend program)](#using-ghc-mod-as-an-ide-backend-program)
|
|
|
|
|
- for [developing Haskell tooling (Using ghc-mod as a library)](#using-ghc-mod-as-a-library)
|
2014-05-19 07:42:34 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
## Overview
|
2014-09-12 05:02:34 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
### Using ghc-mod in your Development Environment<a name="haskell-dev"></a>
|
2014-05-19 07:25:38 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
To use `ghc-mod` in your development environment of choice you need two things:
|
2014-05-19 07:25:38 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
- The `ghc-mod` program included in the package of the same name, see [Installing](https://github.com/DanielG/ghc-mod/wiki/Installing)
|
|
|
|
|
- A ghc-mod frontend to integrate it into your development environment, see [Frontend](https://github.com/DanielG/ghc-mod/wiki/Frontend)
|
2014-05-19 07:25:38 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
### Using ghc-mod as an IDE Backend Program<a name="ide-dev"></a>
|
2014-05-19 07:35:38 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
Directly using ghc-mod is while still supported for the time being
|
|
|
|
|
discouraged. You should look into working with
|
|
|
|
|
[`haskell-ide-engine`](https://github.com/haskell/haskell-ide-engine) instead.
|
2014-12-16 20:34:04 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
The `ghc-mod` backend program is somewhat crusty and carries a lot of legacy
|
|
|
|
|
baggage so going forward we would like to see frontends use `haskell-ide-engine`
|
|
|
|
|
instead. There we're trying to get the design right from the beginning and fix
|
|
|
|
|
the fragmentation of the Haskell Tooling Ecosystem along the way.
|
2014-12-16 20:34:04 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
### Using ghc-mod as a Library<a name="tool-dev"></a>
|
2014-09-12 05:02:34 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
Internally ghc-mod uses the Glasgow Haskell Compilers's API to implement most of
|
|
|
|
|
it's functionality.
|
2014-09-12 05:02:34 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
In order to provide a hassle free experience to users ghc-mod tries hard to
|
|
|
|
|
automatically, and correctly, detect and if needed tweak the environment GHC
|
|
|
|
|
needs. It also handles some of the more cumbersome parts of getting a working
|
|
|
|
|
compiler session up and running.
|
2014-09-12 05:02:34 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
This functionality can be very useful to all kinds of Haskell development tools
|
|
|
|
|
therefore want to expose all the useful abstractions ghc-mod provides.
|
2014-09-12 05:02:34 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
Right now the ghc-mod API is pretty messy a result major internal rewrites 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 re-do the API but we need more input from downstream tool writers to
|
|
|
|
|
do that properly, see [Library API Redesign](Library-API-Redesign.md).
|
2015-03-03 11:18:54 +00:00
|
|
|
|
2017-01-22 23:34:57 +00:00
|
|
|
Right now tools like
|
|
|
|
|
[The Haskell Refactorer (HaRe)](https://github.com/alanz/HaRe) use this
|
|
|
|
|
environment handling so they can concentrate on their core functionality instead
|
|
|
|
|
of worrying about environments.
|
2015-03-03 11:18:54 +00:00
|
|
|
|
2017-01-22 23:31:14 +00:00
|
|
|
Most recently the
|
|
|
|
|
[`haskell-ide-engine`](https://github.com/haskell/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 definetly look into that. `haskell-ide-engine`
|
2017-01-22 23:34:57 +00:00
|
|
|
uses `ghc-mod` at it's core so you'll want to be familliar with it either way.
|
2017-01-22 23:31:14 +00:00
|
|
|
|
|
|
|
|
API "documentation" is here:
|
2017-01-22 23:34:57 +00:00
|
|
|
[Hackage docs](http://hackage.haskell.org/package/ghc-mod/docs/Language-Haskell-GhcMod.html).
|
2015-03-03 11:18:54 +00:00
|
|
|
|
2014-09-12 05:02:34 +00:00
|
|
|
## IRC
|
2014-05-19 07:35:38 +00:00
|
|
|
|
2014-09-12 05:02:34 +00:00
|
|
|
If you have any problems, suggestions, comments swing by
|
2015-03-28 01:35:36 +00:00
|
|
|
[\#ghc-mod (web client)](https://kiwiirc.com/client/irc.freenode.org/ghc-mod) on
|
|
|
|
|
Freenode. If you're reporting a bug please also create an issue
|
2016-10-12 12:56:15 +00:00
|
|
|
[here](https://github.com/DanielG/ghc-mod/issues) so we have a way to contact
|
2015-03-28 01:35:36 +00:00
|
|
|
you if you don't have time to stay.
|
2015-03-05 15:52:11 +00:00
|
|
|
|
|
|
|
|
Do hang around for a while if no one answers and repeat your question if you
|
2015-03-28 01:35:36 +00:00
|
|
|
still haven't gotten any answer after a day or so. You're most likely to get an
|
|
|
|
|
answer during the day in GMT+1.
|
