Haskell for Visual Studio Code

This extension adds language support for Haskell, powered by the Haskell Language Server. As almost all features are provided by the server you might find interesting read its documentation.

Setup

This Extension comes with "batteries"-included and can manage your Haskell Language Server installations for you, powered by GHCup. Installation of GHCup can not happen automatically, so if you want your HLS installations to be managed by the Extension, you will have to follow the installation instructions for GHCup.

Note: Make sure you have a working ghcup installation, before launching the Extension.

Features

You can watch demos for some of these features here.

Warning and error diagnostics from GHC
Type information and documentation on hover, including your own comments.
Jump to definition: for now only for local code definitions
Document symbols
Highlight references in document
Code completion
Show documentation and sources in hackage
Formatting via Brittany, Floskell, Fourmolu, Ormolu or Stylish Haskell
Multi-root workspace support
Code evaluation, see its Tutorial
Integration with retrie, a powerful, easy-to-use codemodding tool
Code lenses for explicit import lists
Generate functions from type signatures, and intelligently complete holes using Wingman (tactics)
Integration with hlint, the most used haskell linter, to show diagnostics and apply hints via apply-refact
Module name suggestions for insertion or correction
Call hierarchy support

Requirements

For standalone .hs/.lhs files, ghc must be installed and on the PATH. The easiest way to install it is with ghcup or Chocolatey on Windows.
For Cabal based projects, both ghc and cabal-install must be installed and on the PATH. It can also be installed with ghcup or Chocolatey on Windows.
For Stack based projects, stack must be installed and on the PATH.
If you are installing from an offline VSIX file, you need to install language-haskell too after installation (either from the marketplace or offline).
Alternatively, you can let the extension manage your entire toolchain automatically (you'll be asked on first startup) via ghcup, which should be pre-installed

Configuration options

For a general picture about the server configuration, including the project setup, you can consult the server documentation about the topic.

Path to server executable

If your server is manually installed and not on your path, you can also manually set the path to the executable.

"haskell.serverExecutablePath": "~/.local/bin/haskell-language-server"

There are a few placeholders which will be expanded:

~, ${HOME} and ${home} will be expanded into your users' home folder.
${workspaceFolder} and ${workspaceRoot} will expand into your current project root.

Security warning

The option has resource scope so it can be changed per workspace. This supposes it could be used to execute arbitrary programs adding a .vscode/settings.json in the workspace folder including this option with the appropiate path. For this reason its scope will be changed to machine so users only will be able to change it globally. See #387 for more details.

Set additional environment variables for the server

You can add additional environment variables for the lsp server using the configuration option haskell.serverEnvironment. For example, to change the cache directory used by the server you could set:

{ "haskell.serverEnvironment": { "XDG_CACHE_HOME": "/path/to/my/cache" } }

as the server uses the XDG specification for cache directories.

The environment only will be visible for the lsp server, not for other extension tasks like find the server executable.

Downloaded binaries

This extension will download haskell-language-server binaries and the rest of the toolchain if you selected to use GHCup during first start. Check the haskell.manageHLS setting.

It will then download the newest version of haskell-language-server which has support for the required ghc. That means it could use an older version than the latest one, without the last features and bug fixes. For example, if a project needs ghc-8.10.4 the extension will download and use haskell-language-server-1.4.0, the latest version which supported ghc-8.10.4. Even if the latest global haskell language-server version is 1.5.1.

If you have disk space issues, check ghcup gc --help.

You can also instruct the extension to use a different installation directory for the toolchain, e.g. to not interfere with system GHCup installation. Depending on your platform, add the full resolved path like so:

  "haskell.serverEnvironment": {
    "GHCUP_INSTALL_BASE_PREFIX": "/home/foo/.config/Code/User/globalStorage/haskell.haskell/"
  }

The internal storage paths for the extension depend on the platform:

Platform	Path
macOS	`~/Library/Application\ Support/Code/User/globalStorage/haskell.haskell/.ghcup`
Windows	`%APPDATA%\Code\User\globalStorage\haskell.haskell\ghcup`
Linux	`$HOME/.config/Code/User/globalStorage/haskell.haskell/.ghcup`

If you want to manage HLS yourself, set haskell.manageHLS to PATH and make sure HLS is in your PATH or set haskell.serverExecutablePath (overrides all other settings) to a valid executable.

If you need to set mirrors for ghcup download info, check the settings haskell.metadataURL and haskell.releasesURL.

Setting a specific toolchain

When manageHLS is set to GHCup, you can define a specific toolchain (hls, ghc, cabal and stack), either globally or per project. E.g.:

{
  "haskell.toolchain": {
    "hls": "1.6.1.1",
    "cabal": "recommended",
    "stack": null
  }
}

This means:

install the ghc version corresponding to the project (default, because it's omitted)
install hls 1.6.1.1
install the recommended cabal version from ghcup
don't install any stack version

Another config could be:

{
  "haskell.toolchain": {
    "ghc": "9.2.2",
    "hls": "latest",
    "cabal": "recommended"
  }
}

Meaning:

install ghc 9.2.2 regardless of what the project requires
always install latest hls, even if it doesn't support the given GHC version
install recommended cabal
install latest stack (default, because it's omitted)

The defaults (when omitted) are as follows:

install the project required ghc (corresponding to with-compiler setting in cabal.project for example)
install the latest hls version that supports the project required ghc version
install latest cabal
install latest stack

When a the value is null, the extension will refrain from installing it.

Supported GHC versions

These are the versions of GHC that there are binaries of haskell-language-server-1.6.1 for. Building from source may support more versions!

GHC	Linux	macOS	Windows
9.2.1 (limited)	✓	✓	✓
9.0.2 (limited)	✓	✓	✓
9.0.1 (limited)	✓	✓	✓
8.10.7	✓	✓	✓
8.10.6	✓	✓	✓
8.10.5	✓	✓	✓
8.8.4	✓	✓	✓
8.8.3	✓	✓
8.6.5	✓	✓	✓

The exact list of binaries can be checked in the last release of haskell-language-server: https://github.com/haskell/haskell-language-server/releases/latest

You can check the current GHC versions support status and the policy followed for deprecations here.

Using multi-root workspaces

First, check out what multi-root workspaces are. The idea of using multi-root workspaces, is to be able to work on several different Haskell projects, where the GHC version or stackage LTS could differ, and have it work smoothly.

The language server is now started for each workspace folder you have in your multi-root workspace, and several configurations are on a resource (i.e. folder) scope, instead of window (i.e. global) scope.

Investigating and reporting problems

Go to extensions and right click Haskell and choose Extensions Settings
Scroll down to Haskell › Trace: Server and set it to messages.
Set Haskell › Trace: Client to debug. It will print all the environment variables so take care it does not contain any sensible information before sharing it.
Restart vscode and reproduce your problem
Go to the main menu and choose View -> Output (Ctrl + Shift + U)
On the new Output panel that opens on the right side in the drop down menu choose Haskell (<your project>)

Please include the output when filing any issues on the haskell-language-server issue tracker.

Troubleshooting

Check issues and tips in the haskell-language-server project

Usually the error or unexpected behaviour is already reported in the haskell language server issue tracker. Finding the issue could be useful to help resolve it and sometimes includes a workaround for the issue.
You can also check the troubleshooting section in the server documentation.

Restarting the language server

Sometimes the language server might get stuck in a rut and stop responding to your latest changes. Should this occur you can try restarting the language server with Ctrl shift P/⌘ shift P > Restart Haskell LSP Server.

`Cradle requires ghc/cabal/stack but it isn't installed`

In Linux/MacOS systems, opening vscode in the windows system could not use the $PATH set in the shell so it will not see required tools as ghc, cabal or stack. This usually happens if you have installed them via ghcup.
It could be fixed changing the $PATH variable in the init config file used by the windows system (f.e. ~/.profile, but i can vary depending on your system setup).
See this stackoverflow question for more tricks.

Contributing

If you want to help, get started by reading Contributing for more details.

Release Notes

See the Changelog for more details.

fendor / vscode-haskell