Skip to content

Add emacs/doom-emacs integration sub-section #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 18, 2020
Merged

Add emacs/doom-emacs integration sub-section #115

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
239e6ff
add editor integration section
yuanw May 17, 2020
f9d8b35
address code review feedback
yuanw May 18, 2020
d42996e
address code review feedback
yuanw May 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,46 @@ dependencies:
- someDep
```

## Editor Integration

Note to editor integrators: there is now a haskell-language-server-wrapper executable, which is installed alongside the haskell-language-server executable. When this is invoked in the project root directory, it attempts to work out the GHC version used in the project, and then launch the matching hie executable.

All of the editor integrations assume that you have already installed HLS (see above) and that stack put the hls binary in your path (usually ~/.local/bin on linux and macOS).
Copy link
Collaborator

@fendor fendor May 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, we ought to be build tool agnostic, since we support stack and cabal. Either mention both or be less specific, such as:

that the installation script put the haskell-language-server binary in your path ...


### Using HLS with Emacs

Install HLS along with the following emacs packages:

[lsp-mode](https://github.com/emacs-lsp/lsp-mode)
[lsp-ui](https://github.com/emacs-lsp/lsp-ui)
[lsp-haskell](https://github.com/emacs-lsp/lsp-haskell)

Make sure to follow the instructions in the README of each of these packages.

``` lisp
(setq lsp-haskell-process-path-hie "haskell-language-server-wrapper")
```



### Using HLS with [doom-emacs](https://github.com/hlissner/doom-emacs/tree/develop/modules/lang/haskell#module-flags)

Install HLS, and then enable haskell lang module with lsp flag in `.doom.d/init.el`
``` emacs-lisp
:lang
(haskell +lsp)
```

in your `.doom.d/config.el` file

``` emacs-lisp
(after! lsp-haskell
(setq lsp-haskell-process-path-hie "haskell-language-server-wrapper")
Copy link
Collaborator

@fendor fendor May 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question as above.

)
```

then do `$HOME/.emacs.d/bin/doom refresh`

## Contributing

### It's time to join the project!
Expand Down