haskell/haskell-language-server
1
1
Fork 0
mirror of https://github.com/haskell/haskell-language-server.git synced 2024-08-17 04:20:37 +03:00
Code Issues Projects Releases Wiki Activity

Docs: update Emacs section: add eglot with config example (#3509)

Browse Source 
* Docs: update Emacs section: add eglot with config example

Based on the discussion at https://github.com/haskell/haskell-language-server/issues/3157

* Update docs/configuration.md

Co-authored-by: Michael Peyton Jones <me@michaelpj.com>

---------

Co-authored-by: Michael Peyton Jones <me@michaelpj.com>
This commit is contained in:
Malvin Gattinger 2023-03-02 10:14:22 +01:00 committed by GitHub
parent f8e954eb06
commit 2e7961932e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/configuration.md
View File

@ -396,13 +396,17 @@ Install the two Atom packages [atom-ide-ui](https://atom.io/packages/atom-ide-ui
$ apm install language-haskell atom-ide-ui haskell
```
### Emacs
### [Emacs](https://www.gnu.org/software/emacs/)
Emacs support is provided by a combination of the following packages:
Emacs support can be provided by different combinations of 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)
- [eglot](https://github.com/joaotavora/eglot) (built-in from Emacs 29 onwards)
or
- [lsp-mode](https://github.com/emacs-lsp/lsp-mode),
[lsp-ui](https://github.com/emacs-lsp/lsp-ui) and
[lsp-haskell](https://github.com/emacs-lsp/lsp-haskell)
You can install these manually if you are using plain Emacs; instructions for some specific flavours
are included below.
@ -412,6 +416,32 @@ various parts of the Emacs integration.
In particular, `lsp-haskell` provides customization options for the `haskell-language-server`-specific parts,
such as the path to the server executable.
#### [use-package](https://github.com/jwiegley/use-package) [eglot](https://github.com/joaotavora/eglot)
If you are using vanilla emacs with `use-package`, put the following into your `~/.emacs`.
This will install `eglot` and enable it by default in `haskell-mode`.
To configure `haskell-language-server` we use the `eglot-workspace-configuration` variable.
With `M-x eglot-show-workspace-configuration` you can see the JSON that `eglot` will send to `haskell-language-server`.
See <https://joaotavora.github.io/eglot/#Customizing-Eglot> for more information.
As an example, the setting below will disable the `stan` plugin.
```emacs-lisp
(use-package eglot
:ensure t
:config
(add-hook 'haskell-mode-hook 'eglot-ensure)
:config
(setq-default eglot-workspace-configuration
'((haskell
(plugin
(stan
(globalOn . :json-false)))))) ;; disable stan
:custom
(eglot-autoshutdown t) ;; shutdown language server after closing last file
(eglot-confirm-server-initiated-edits nil) ;; allow edits without confirmation
)
```
#### [doom-emacs](https://github.com/hlissner/doom-emacs/tree/develop/modules/lang/haskell#module-flags)
Manual installation of packages is not required.