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](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
- 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.
  - `.hlint.yaml` is [from relude](https://github.com/kowainik/relude/blob/main/.hlint.yaml)
- Devshell scripts (`,` prefixed) are provided via [mission-control](https://github.com/Platonic-Systems/mission-control)

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 `, 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 `, fmt` in nix shell to autoformat the project. This uses [treefmt](https://github.com/numtide/treefmt).
- Run `, 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://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
init 2021-05-31 23:19:51 +00:00			`# haskell-template`

Delegate the bulk of README to srid.ca 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:`
Update README.md 2022-06-19 19:18:51 +00:00
Add Test Suite and Library (#30) * added library and test scaffoding * Add bin/test * Update comments Co-authored-by: Sridhar Ratnakumar <srid@srid.ca> 2022-08-06 22:45:22 +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
GHC 9 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.`
Add relude's hlint yaml 2022-05-04 21:05:56 +00:00			- `.hlint.yaml` is [from relude](https://github.com/kowainik/relude/blob/main/.hlint.yaml)
Nixify scripts using mission-control (#72) https://github.com/Platonic-Systems/mission-control 2022-12-17 17:29:11 +00:00			- Devshell scripts (`,` prefixed) are provided via [mission-control](https://github.com/Platonic-Systems/mission-control)
init 2021-05-31 23:19:51 +00:00
readme: emphasize haskell-flake 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.`

Update README.md 2021-05-31 23:37:01 +00:00			`## Getting Started`
init 2021-05-31 23:19:51 +00:00
Nixify scripts using mission-control (#72) https://github.com/Platonic-Systems/mission-control 2022-12-17 17:29:11 +00:00			tldr: Install Nix, enable Flakes, open in VSCode and run `, run`.
Get rid of destructive `mv` 2022-03-11 17:23:18 +00:00
Delegate the bulk of README to srid.ca 2022-09-04 15:25:11 +00:00			`For details, see: https://srid.ca/haskell-template/start`
Update README.md 2021-06-01 12:37:15 +00:00
Run 'nix flake update' 2021-08-04 14:33:51 +00:00			`## Tips`

nix: No need to pin the hash; git branch HEAD provides it 2022-05-07 00:27:11 +00:00			- Run `nix flake update` to update all flake inputs.
Add a flake check for HLS (#47) Also use check-flake for .#check package. Deal with network access by disabling sandbox, and excluding in garnix. 2022-08-28 22:50:08 +00:00			- Run `nix --option sandbox false build .#check -L` to run the flake checks.
Revamp treefmt use via `flake-parts` module (#75) Get rid of `treefmt.toml` as that is nixified. 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).
Nixify scripts using mission-control (#72) https://github.com/Platonic-Systems/mission-control 2022-12-17 17:29:11 +00:00			- Run `, docs` to start Hoogle with packages in your cabal file.
readme: mention 'nix run' 2022-05-22 18:53:04 +00:00			- Run the application without installing: `nix run github:srid/haskell-template` (or `nix run .` from checkout)
Delegate the bulk of README to srid.ca 2022-09-04 15:25:11 +00:00			`- Common workflows`
readme: add library dependency page 2022-10-20 22:50:06 +00:00			`- 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`
Remove garnix.yaml (document it instead) 2022-09-03 14:23:45 +00:00
readme: link to Discussions 2022-08-19 23:48:37 +00:00			`## Discussions`

Test 2022-11-03 23:20:57 +00:00			`Questions? Ideas? Suggestions? You may post them here: https://github.com/srid/haskell-template/discussions`