2021-05-31 23:19:51 +00:00
# haskell-template
2022-09-04 15:25:11 +00:00
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:
2022-06-19 19:18:51 +00:00
2023-01-24 18:02:42 +00:00
- [Nix ](https://srid.ca/haskell-nix ) + [Flakes ](https://serokell.io/blog/practical-nix-flakes ) (via [`github:srid/haskell-flake` ](https://github.com/srid/haskell-flake )) + GHC 9.2
2022-04-06 21:43:03 +00:00
- VSCode + [HLS ](https://github.com/haskell/haskell-language-server )
- [fourmolu ](https://github.com/fourmolu/fourmolu ) autoformatting
- [Relude ](https://github.com/kowainik/relude#relude ) as Prelude.
2022-05-04 21:05:56 +00:00
- `.hlint.yaml` is [from relude ](https://github.com/kowainik/relude/blob/main/.hlint.yaml )
2022-12-17 17:29:11 +00:00
- Devshell scripts (`,` prefixed) are provided via [mission-control ](https://github.com/Platonic-Systems/mission-control )
2021-05-31 23:19:51 +00:00
2022-11-21 13:59:25 +00:00
If you have an *existing* Haskell project, you should probably use https://github.com/srid/haskell-flake instead.
2021-05-31 23:37:01 +00:00
## Getting Started
2021-05-31 23:19:51 +00:00
2022-12-17 17:29:11 +00:00
*tldr: Install Nix, enable Flakes, open in VSCode and run `, run` .*
2022-03-11 17:23:18 +00:00
2023-04-08 14:37:43 +00:00
Full instructions: https://srid.ca/haskell-template/start
Recommended dev environment setup: https://haskell.flake.page/direnv
2021-06-01 12:37:15 +00:00
2021-08-04 14:33:51 +00:00
## Tips
2022-05-07 00:27:11 +00:00
- Run `nix flake update` to update all flake inputs.
2022-12-24 01:16:59 +00:00
- Run `nix build .#check -L` to run the flake checks.
2022-12-21 18:09:33 +00:00
- Run `, fmt` in nix shell to autoformat the project. This uses [treefmt ](https://github.com/numtide/treefmt ).
2022-12-17 17:29:11 +00:00
- Run `, docs` to start Hoogle with packages in your cabal file.
2022-05-22 18:53:04 +00:00
- Run the application without installing: `nix run github:srid/haskell-template` (or `nix run .` from checkout)
2022-09-04 15:25:11 +00:00
- Common workflows
2023-02-27 22:14:08 +00:00
- Adding library dependencies in Nix: https://haskell.flake.page/dependency
2022-10-20 22:50:06 +00:00
- Adding tests: https://srid.ca/haskell-template/tests
2022-09-03 14:23:45 +00:00
2022-08-19 23:48:37 +00:00
## Discussions
2022-11-03 23:20:57 +00:00
Questions? Ideas? Suggestions? You may post them here: https://github.com/srid/haskell-template/discussions
