Skip to content

Document how to setup VSCode #1969

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
supersven merged 1 commit into from
Dec 6, 2021
Merged

Document how to setup VSCode #1969

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions docs/developer/editor-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,15 @@ If you use sdiehl's module, you you need to collect the language extensions from
If you want to be playful, you can look at how `tools/ormolu.sh`
collects the language extensions automatically and see if you can get
it to work here.

## VSCode

The project can be loaded into the [Haskell Language Server](https://github.com/haskell/haskell-language-server).
This gives type checking, code completion, HLint hints, formatting with Ormolu, lookup of definitions and references, etc..
All needed dependencies (like the `haskell-language-server` and `stack` binaries) are provided by `shell.nix`.

Setup steps:
- Install the plugins `Haskell` (Haskell Language Server support), `Haskell Syntax` and `Nix Environment Selector`
- Generate the `hie.yaml` file: `make hie.yaml`
- Select the nix environment from `shell.nix` with the command `Nix-Env: Select environment`.
- Reload the window as proposed by the `Nix Environment Selector` plugin