darkkirb/matrix-media-expanded
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
135 commits 1 branch 0 tags 271 KiB
Nix 58.2%
Haskell 41.8%
Find a file
EvanPiro c78eaf81c4
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 18:45:22 -04:00
.github/workflows Periodically update flake.lock (#25) 2022-07-21 15:38:43 -04:00
.vscode vscode: add manageHLS (set to PATH) 2022-06-28 17:11:14 -04:00
bin Add Test Suite and Library (#30) 2022-08-06 18:45:22 -04:00
src Add Test Suite and Library (#30) 2022-08-06 18:45:22 -04:00
tests Add Test Suite and Library (#30) 2022-08-06 18:45:22 -04:00
.envrc Add .envrc 2022-03-17 10:19:17 -04:00
.gitattributes Mark flake.lock as auto generated 2022-01-29 13:56:03 -05:00
.gitignore Add .envrc 2022-03-17 10:19:17 -04:00
.hlint.yaml Add relude's hlint yaml 2022-05-04 17:05:56 -04:00
flake.lock flake.lock: Update (#29) 2022-07-30 20:28:47 -04:00
flake.nix nix: Remove treefmt TODO 2022-07-23 10:03:01 -04:00
fourmolu.yaml Switch to fourmolu 2022-03-23 13:46:51 -04:00
garnix.yaml CI: build for M1 mac (#28) 2022-07-24 11:10:07 -04:00
haskell-template.cabal Add Test Suite and Library (#30) 2022-08-06 18:45:22 -04:00
LICENSE Relicense under MIT 2021-08-04 10:33:15 -04:00
README.md Add Test Suite and Library (#30) 2022-08-06 18:45:22 -04:00
shell.nix Simplify shell.nix using builtins.getFlake 2022-06-17 18:08:17 -04:00
treefmt.toml treefmt: add cabal-fmt 2022-05-08 18:39:45 -04:00

README.md

haskell-template

Get a Haskell development environment up and running quickly, as long as Nix is available on your system1.

This repository is a Haskell project template that is optimized for a fully reproducible and friendly development environment. It is based on:

Getting Started

First-time setup:

  • Install Nix (>= 2.8) & enable Flakes (Using Windows? See footnote1)
  • Run nix develop -c haskell-language-server to sanity check your environment
  • Open as single-folder workspace in Visual Studio Code
    • When prompted by VSCode, install the workspace recommended extensions
    • Ctrl+Shift+P to run command "Nix-Env: Select Environment" and then select shell.nix.
      • The extension will ask you to reload VSCode at the end. Do it.

To run the program with auto-recompile:

  • Press Ctrl+Shift+B in VSCode, or run bin/run in terminal, to launch Ghcid running your program.

Open Main.hs, and expect all HLS IDE features like hover-over tooltip to work out of the box. Try changing the source, and expect Ghcid to re-compile and re-run the app in the terminal below.

Renaming the project:

# First, click the green "Use this template" button on GitHub to create your copy.
git clone <your-clone-url>
cd your-project
NAME=myproject

git mv haskell-template.cabal ${NAME}.cabal
nix run nixpkgs#sd -- haskell-template ${NAME} * */*
git add . && git commit -m rename

Tips

  • Run nix flake update to update all flake inputs.
  • 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 bin/test to run the test suite.
  • Run the application without installing: nix run github:srid/haskell-template (or nix run . from checkout)

Alternatives

  1. On Windows, you may install Nix under WSL2 and use the Remote - WSL extension to connect from the native VSCode. This runs your project under Linux while providing a near-native development experience on Windows. ↩︎