matrix-media-expanded/README.md

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
• VSCode + HLS
• fourmolu autoformatting
• Relude as Prelude.
  • .hlint.yaml is from relude

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 bin/run.

For details, see: https://srid.ca/haskell-template/start

Tips

• Run nix flake update to update all flake inputs.
• Run nix --option sandbox false build .#check -L to run the flake checks.
• Run treefmt in nix shell to autoformat the project. This uses treefmt, which uses ./treefmt.toml (where fourmolu and nixpkgs-fmt are specified).
• Run bin/hoogle 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://srid.ca/haskell-template/dependency
  • Adding tests: https://srid.ca/haskell-template/tests
  • Adding Garnix CI: https://srid.ca/haskell-template/garnix

Discussions

Questions? Ideas? Suggestions? You may post them here: https://github.com/srid/haskell-template/discussions