haskell-ide-engine

This project aims to be the universal IDE interface to all haskell tools, proving a full-featured and easy to query ide-backend.

Features: (planned)

• cabal / stack project Configuration and Compilation
• Errors Checking, Warnings, Linter, Dead code detection
• Refactoring tools, Code beautify, Auto-apply suggestion
• Code generation
• Run testing Suite, check coverage
• Autocompletion
• Get type at point
• Jump to definition, find Usages, Browse documentation, Generate ctags
• REPL

Is this again an other ghc-mod or ide-backend like project ?

No:

Both the ghc-mod and ide-backend maintainers have agreed to contribute code to this new repository and then rebase the old repos on this. The reason we're using a new repo instead of modifying one of the existing ones is so that the existing projects experience no disruption during this migration process. If this was a new set of people starting a new project without support from existing projects, I'd agree with you. But Alan's reached out to existing players already, which is an important distinction.

This project doesn't start from scratch:

1. See why we should supersede previous tools
2. Check the list of existing tools / features
3. See more other tools / ide for inspiration

It's time to join the project !

❤️ Haskell tooling dream is near, we need your help ! ❤️

• Register in our google group mailing list
• Join our IRC channel at #haskell-ide-engine on freenode.
• Fork this repo and hack as much as you can.
• Ask @alanz or @hvr to join the project.

---

Architecture

1. BIOS layer:

   ghc-mod stays an AGPL project, and is used for its "awesome sauce" in terms of the BIOS functions that it does so well. This interface is straightforward to use, and if a license-constrained user wants to do something else it is also easy to replace, if there is strong control of the operating environment.

2. Plugin layer:

   A layer providing a point to integrate tools and existing functions, probably including ghci.

3. IDE interfacing layer:

   This provides a set of logical channels that can be integrated into standard IDEs. The details still need to be worked out, but I would imagine something like a channel for querying information about a project, one for a ghci session, and whatever others are needed. These logical channels can then run over whatever transport is appropriate to the specific IDE being integrated.

   According to #2 it seems the consensus is toward (re) using the Idris protocol, as the languages are similar enough and it offers cross-IDE support already.

   The Plugin and IDE layers are very fuzzy at this point, and there has been some discussion on IRC around it. These layers may well live in a single repository (this one), as two separate layers or just be a feature of how haskell-ide-engine is built.

You can see more info in the docs folder at the root of the project, especially:

• The Architecture discussion
• The Protocol discussion
• The Design discussion

Documentation

All the documentation is in the docs folder at the root of the project.