2021-05-31 23:19:51 +00:00
# haskell-template
2021-06-01 02:27:40 +00:00
Haskell project template optimized for a fully reproducible and friendly development environment. Based on Nix + Flakes + VSCode (HLS) + Relude.
2021-05-31 23:19:51 +00:00
2021-05-31 23:37:01 +00:00
## Getting Started
2021-05-31 23:19:51 +00:00
- [Install Nix ](https://nixos.org/download.html ) & [enable Flakes ](https://nixos.wiki/wiki/Flakes )
- Run `nix-shell --run haskell-language-server` to sanity check your environment
- [Open as single-folder workspace ](https://code.visualstudio.com/docs/editor/workspaces#_singlefolder-workspaces ) in Visual Studio Code
- Install the [workspace recommended ](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions ) extensions
- < kbd > Ctrl+Shift+P</ kbd > to run command "Nix-Env: Select Environment" and select `shell.nix` . The extension will ask you to reload VSCode at the end.
2021-05-31 23:37:01 +00:00
- Press < kbd > Ctrl+Shift+B</ kbd > in VSCode, or run `bin/run` (`bin/run-via-tmux` if you have tmux installed) in terminal, to launch Ghcid running your program.
2021-05-31 23:19:51 +00:00
All but the final step need to be done only once.
2021-05-31 23:37:01 +00:00
Then, before using it for real,
- Rename `haskell-template` to `myproject` as well rename the cabal file to `myproject.cabal` .
- `git add . && git ci -m naming` followed `nix develop` (or `bin/run` ) to verify.
