The engine for haskell ide-integration. Not an IDE
Haskell Emacs Lisp Shell Makefile
Latest commit b3acf4a Sep 23, 2016 @alanz alanz committed on GitHub Merge pull request #214 from jacereda/master
Require buttercup
Permalink
Failed to load latest commit information.
app Fix last ghc-mod tests, except ... Aug 27, 2016
docs Use normal emacs add-to-list Sep 22, 2016
elisp Require buttercup Sep 22, 2016
hie-apply-refact Commit to GHC 8.0.1 and above only Sep 6, 2016
hie-base Commit to GHC 8.0.1 and above only Sep 6, 2016
hie-docs-generator Handles ~ path in Linux Jun 8, 2016
hie-eg-plugin-async Commit to GHC 8.0.1 and above only Sep 6, 2016
hie-example-plugin2 Commit to GHC 8.0.1 and above only Sep 6, 2016
hie-ghc-mod Commit to GHC 8.0.1 and above only Sep 6, 2016
hie-ghc-tree Remove some commented out code Sep 12, 2016
hie-hare Commit to GHC 8.0.1 and above only Sep 6, 2016
hie-plugin-api Commit to GHC 8.0.1 and above only Sep 6, 2016
licenses Add tests for ExtensibleState Dec 16, 2015
src/Haskell/Ide/Engine Commit to GHC 8.0.1 and above only Sep 6, 2016
test Build/test on GHC 8.0.1 using stack and cabal new-build Sep 3, 2016
.gitignore Fixups based on PR comments Sep 5, 2016
.travis.yml Increase timeout for cash upload Jan 19, 2016
LICENSE Just some textual improvements Jan 2, 2016
Makefile Use cask for running the emacs tests Jan 19, 2016
README.md Use cask for running the emacs tests Jan 19, 2016
Setup.hs Breaking ground. Initial source template Oct 23, 2015
cabal.project Re-enable hie-docs-generator Sep 4, 2016
deploy-docs.sh Allow empty commits when deploying docs May 16, 2016
emacs_tests.sh Use tcp in emacs Jan 29, 2016
haskell-ide-engine.cabal Commit to GHC 8.0.1 and above only Sep 6, 2016
pedantic.sh Enable pedantic for haskell-ide-engine too May 2, 2016
stack-lts.yaml Capturing failed attempt at GHC 7.10.3 build Aug 27, 2016
stack.yaml Commit to GHC 8.0.1 and above only Sep 6, 2016
travis_long Correct version of travis_long. Oct 23, 2015

README.md

haskell-ide-engine

Available on Hackage License BSD3 Build Status

This project aims to be the universal interface to a growing number of Haskell tools, providing a full-featured and easy to query backend for editors and IDEs that require Haskell-specific functionality.

Planned features:

  • Cabal / Stack project configuration and compilation
  • Error checking, warnings, linter and dead code detection
  • Refactoring tools, code beautification, 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

This is not yet another ghc-mod or ide-backend project

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 is not started from scratch:

  1. See why we should supersede previous tools
  2. Check the list of existing tools and functionality
  3. See more other tools and IDEs for inspiration

It's time to join the project!

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

Development

Apart from stack you need cask for the emacs tests. You can install it using

curl -fsSL https://raw.githubusercontent.com/cask/cask/master/go | python

Architecture

Below you find a short overview of the main architectural layers of haskell-ide-engine. For more info have a look in the docs folder at the root of this project, especially:

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 layer and IDE layer 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.

Documentation

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