Table of Contents
This is a DevContainer [1][2] environment for Visual Studio Code, allowing automatically installing the Haskell compiler (GHC), Stack, Cabal, HIE (Haskell IDE Engine), LiquidHaskell and the necessary Visual Studio Code extensions to set up a Haskell development environment with zero additional effort.
Note: For debugging support, please refer to Haskell GHCi Debugger Adapter Phoityne extension documentation.
Follow the Getting Started instructions to configure your Visual Studio Code and Docker to use with DevContainers.
Place the .devcontainer directory in the root of your project, and the next time you load the project, Visual Studio Code will prompt to re-open the project in a container:
Note: building the container might take a few minutes until all dependencies have finished downloading and installing.
Visual Studio Code supports Developing inside a Container - using a Docker image as a development environment. It automates the process of creating the container image, as well as installing additional required extensions into the editor.
Pressing Reopen in Container will perform the automated steps to launch the container, and set up the environment.
For more information and setup, read the official documentation: https://code.visualstudio.com/docs/remote/containers and https://code.visualstudio.com/docs/remote/containers-advanced
TODO
TODO
TODO
.devcontainer/Dockerfile DevContainer Docker image, using pre-built "source" image as a base from the dockerhub, to avoid waiting for image building too much.
Dockerfile.source "source" image, contains the following:
debian:buster as a base image.
Additional software installed:
- Glasgow Haskell Compiler (GHC) version 8.8.3 via ghcup-hs.
- A Haskell LSP server, one of the:
- HIE (haskell-ide-engine) - Selected by default.
- HLS (haskell-language-server).
- GHCIDE (haskell-ide-engine).
- Stack.
- Cabal.
- Following Debian packages:
git, curl, xz-utils, gcc, make, libtinfo5, libgmp-dev, zlib1g-dev, bash, sudo, procps, lsb-release, ca-certificates, build-essential, curl, libffi-dev, libffi6, libgmp-dev, libgmp10, libncurses-dev, libncurses5, libtinfo5, libicu-dev, libncurses-dev, z3. - Following haskell packages (via cabal):
alex, c2hs, cpphs, doctest, greencard, happy hlint, phoityne-vscode, haskell-dap, liquidhaskell, stylish-haskell, hoogle, retrie.
Following VSCode extensions are installed after container is started:
- Haskell Syntax Highlighting.
- Haskell Language Server.
- Haskell GHCi Debugger Adapter Phoityne.
- Integrated Haskell Shell.
- Haskutil.
- Haskell Code Formatter.
- LiquidHaskell.
The devcontainer.json has some additional configuration for VSCode, in particular, the required extensions that have to be installed, and the name of the remote user (must match the one in the Dockerfile).
This was initially based on the DevContainer for HIE (Haskell IDE Engine) by Igal Tabachnik.
To build "source" image locally, just run docker build . --file ./Dockerfile.source --tag haskelldevenv:latest from the repository root.
You can override GHC version, and LSP flavour/backend by specifying -e"GHC_VERSION=x.x.x and -e"HASKELL_LSP_FLAVOUR=xxx" respectively, for example:
docker build . --file ./Dockerfile.source --tag haskelldevenv:latest -e"GHC_VERSION=8.6.5"docker build . --file ./Dockerfile.source --tag haskelldevenv:latest -e"HASKELL_LSP_FLAVOUR=hls"docker build . --file ./Dockerfile.source --tag haskelldevenv:latest -e"GHC_VERSION=8.6.5 -e"HASKELL_LSP_LFAVOUR=all"
Valid values for GHC_VERSION can be found here, HASKELL_LSP_FLAVOUR can be one of hie (default), hls, ghcide and all.
Please NOTE, that if you're building the image from scratch, it can take pretty significant time, since it will be compiling most of the libraries from source.