matrix-media-expanded/README.md

haskell-template

Haskell project template optimized for a fully reproducible and friendly development environment. Based on Nix + Flakes + VSCode (HLS) + ormolu autoformatting + Relude as Prelude.

Getting Started

First-time setup:

• Install Nix & enable Flakes
• Run nix-shell --run haskell-language-server to sanity check your environment
• Open as single-folder workspace in Visual Studio Code
  • When prompted by VSCode, install the workspace recommended extensions
  • Ctrl+Shift+P to run command "Nix-Env: Select Environment" and then select shell.nix.
    • The extension will ask you to reload VSCode at the end. Do it.

To run the program with auto-recompile:

• Press Ctrl+Shift+B in VSCode, or run bin/run (bin/run-via-tmux if you have tmux installed) in terminal, to launch Ghcid running your program.

Open Main.hs, and expect all HLS IDE features like hover-over tooltip to work out of the box. Try changing the source, and expect Ghcid to re-compile and re-run the app in the terminal below.

---

Renaming the project:

NAME=myproject
git mv haskell-template.cabal ${NAME}.cabal
nix run nixpkgs#sd -- haskell-template ${NAME} * */*
git add . && git commit -m rename
cd .. && mv haskell-template ${NAME} && cd ${NAME}

Tips

• Run nix flake update to update all flake inputs. nixpkgs is pinned to a specific a rev in flake.nix, which you can advance to the latest rev reported in status.nixos.org.

Alternatives

• haskell.nix: Getting started with Flakes
• Serokell's Flake template
  • Same, but using haskell.nix