haskell/haskell-ide-engine
1
1
Fork 0
mirror of https://github.com/haskell/haskell-ide-engine.git synced 2024-10-26 11:18:42 +03:00
Code Issues Projects Releases Wiki Activity
The engine for haskell ide-integration. Not an IDE
12 Commits 44 Branches 23 Tags 112 MiB
Haskell 99.4%
Shell 0.3%
COBOL 0.2%
18f3a77854
Go to file
Alan Zimmerman 18f3a77854 Add references to incremental parsing in Yi
2015-10-24 12:22:54 +02:00
app Breaking ground. Initial source template 2015-10-23 11:50:15 +02:00
docs Add references to incremental parsing in Yi 2015-10-24 12:22:54 +02:00
src Breaking ground. Initial source template 2015-10-23 11:50:15 +02:00
test Breaking ground. Initial source template 2015-10-23 11:50:15 +02:00
.gitignore Breaking ground. Initial source template 2015-10-23 11:50:15 +02:00
.travis.yml Breaking ground. Initial source template 2015-10-23 11:50:15 +02:00
haskell-ide.cabal Breaking ground. Initial source template 2015-10-23 11:50:15 +02:00
LICENSE Remove reference to Isaac Jones in LICENSE 2015-10-23 20:18:25 -07:00
README.md Make issue link clickable 2015-10-23 15:49:34 +02:00
Setup.hs Breaking ground. Initial source template 2015-10-23 11:50:15 +02:00
stack.yaml Breaking ground. Initial source template 2015-10-23 11:50:15 +02:00
travis_long Correct version of travis_long. 2015-10-23 20:21:07 +02:00

README.md

Home to the community effort to provide a common service backend for any IDE making use of Haskell in general and GHC in particular.

Status

This is currently a blank canvas. There has been a fair amount of discussion about what needs to be done/exist, this is the place where it should all come together.

Right now there is a google group/mailing list for haskell-ide and an empty IRC channel at #haskell-ide on freenode.

The initial discussions have taken place in a number of email threads/IRC channels, this should become the place where these discussions happen in future.

If anyone wants to be a member of this project, contact @alanz or @hvr to add you to it.

Available on Hackage License BSD3 Build Status

Next steps

After lots of discussion around layers and licensing, it looks like the way forward is as follows

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.

Plugin layer

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

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 is built.

Documentation

Rather than use the wiki we will put the documentation in the docs directory here, so collaborators can either edit or provide pull requests.