coddeys/haskell-template

Haskell project template using Nix + Flakes + VSCode (HLS)

haskell-template

Get a Haskell development environment up and running quickly. Thanks to Nix, this template is optimized for a fully reproducible and friendly development environment. It is based on:

• Nix + Flakes (via github:srid/haskell-flake) + GHC 9.4
• VSCode + HLS
• fourmolu autoformatting
• Relude as Prelude.
  • .hlint.yaml is from relude
• Devshell commands are provided via just; run just in devshell.

If you have an existing Haskell project, you should probably use https://github.com/srid/haskell-flake instead.

Getting Started

tldr: Install Nix, enable Flakes, open in VSCode and run just run.

Full instructions: https://srid.ca/haskell-template/start

Recommended dev environment setup: https://nixos.asia/en/direnv

Tips

• Run nix flake update to update all flake inputs.
• Run nix run github:srid/nixci to build all outputs.
• Run just fmt in nix shell to autoformat the project. This uses treefmt.
• Run just docs to start Hoogle with packages in your cabal file.
• Run the application without installing: nix run github:srid/haskell-template (or nix run . from checkout)
• Common workflows
  • Adding library dependencies in Nix: https://zero-to-flakes.com/haskell-flake/dependency
  • Adding tests: https://srid.ca/haskell-template/tests

Discussions

Questions? Ideas? Suggestions? Join our NixOS Zulip or post in Github Discussions.