2021-05-31 23:19:51 +00:00
# haskell-template
2021-06-06 16:12:49 +00:00
Haskell project template optimized for a fully reproducible and friendly development environment. Based on [Nix ](https://notes.srid.ca/haskell-nix ) + [Flakes ](https://serokell.io/blog/practical-nix-flakes ) + VSCode ([HLS](https://github.com/haskell/haskell-language-server)) + [ormolu ](https://github.com/tweag/ormolu ) autoformatting + [Relude ](https://github.com/kowainik/relude#relude ) as Prelude.
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,
2021-06-01 02:39:49 +00:00
- Rename all occurrences of `haskell-template` to `myproject` , as well as rename the cabal file to `myproject.cabal` .
2021-08-04 14:27:17 +00:00
- To do this from commandline, run `nix run nixpkgs#sd -- haskell-template myproject * */*`
2021-06-01 02:40:11 +00:00
- Run `git add . && git commit -m rename` followed by `nix develop` (or `bin/run` ) to verify that everything continues to work.
2021-06-01 12:37:15 +00:00
2021-08-04 14:33:51 +00:00
## Tips
- Run `nix flake update` to nixpkgs and other flake inputs.
2021-09-25 16:52:57 +00:00
## Alternatives
2021-06-01 12:37:15 +00:00
2021-09-25 16:52:57 +00:00
- haskell.nix: [Getting started with Flakes ](https://input-output-hk.github.io/haskell.nix/tutorials/getting-started-flakes/ )
2021-06-02 22:21:30 +00:00
- [Serokell's Flake template ](https://github.com/serokell/templates/tree/master/haskell-cabal2nix )
- [Same, but using haskell.nix ](https://github.com/serokell/templates/pull/2 )
