https://github.com/commercialhaskell/stack-ide

Stack-based JSON interface to ide-backend
https://github.com/commercialhaskell/stack-ide

Last synced: 29 days ago
JSON representation

Stack-based JSON interface to ide-backend

• Host: GitHub
• URL: https://github.com/commercialhaskell/stack-ide
• Owner: commercialhaskell
• Created: 2015-02-28T18:49:00.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2016-01-12T05:30:54.000Z (about 9 years ago)
• Last Synced: 2024-11-09T06:11:56.423Z (3 months ago)
• Language: Emacs Lisp
• Homepage:
• Size: 219 KB
• Stars: 98
• Watchers: 33
• Forks: 23
• Open Issues: 23
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# stack-ide

Stack-based JSON interface to [ide-backend](https://github.com/fpco/ide-backend)

## Project status

While you are certainly free to continue working on stack-ide, FP Complete is no

longer actively working on it.  Check out the following alternatives:

* [ghc-mod](https://github.com/kazu-yamamoto/ghc-mod)

* [ghci-ng](https://github.com/chrisdone/ghci-ng)

* There is also a

  [new community project](https://github.com/haskell/haskell-ide) to work on

  haskell ide integration, which will hopefully grow to subsume the featureset

  and positive attributes of stack-ide.

See

[this blogpost](https://www.fpcomplete.com/blog/2015/10/new-haskell-ide-repo)

for more info.

## Installing

Install with:

    git clone https://github.com/commercialhaskell/stack-ide.git

    cd stack-ide

    git submodule update --init --recursive

    stack build --copy-bins

GHC 7.10 has some GHC API bug fixes which show up in ide-backend in

GHC 7.8, so the `stack.yaml` references a nightly Stackage build which

requires GHC 7.10.

Note that you should install these tools in the same Stack LTS/Nightly

resolver as the projects that you want to work on, so that the

necessary packages are in scope.

## Emacs

There is Emacs integration provided by stack-mode in this repository.

Add the following to your .emacs:

``` lisp

(add-to-list 'load-path "/path/to/stack-ide/stack-mode/")

(require 'stack-mode)

(add-hook 'haskell-mode-hook 'stack-mode)

```

When opening a .hs file it will figure out where your cabal package is

and start a `stack ide` session under that package's directory.

There is an example project on the `stack-mode` branch at

[emacs-haskell-config](https://github.com/chrisdone/emacs-haskell-config/tree/stack-mode). Follow

the instructions.

## Running manually

Make sure you have a recent Git master version of `stack` installed.

Go to a project and run:

    $ stack ide start

If your projects conflict, it might fail to start

successfully. `stack-ide` is such a project, so you should specify the

target explicitly, e.g.

``` javascript

$ stack ide start stack-ide

{"tag":"ResponseWelcome","contents":[0,1,1]}

…

```