bin: Switch to just

srid · Dec 7, 2023 · 54a9b29 · 54a9b29
1 parent d886942
commit 54a9b29
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 40 deletions.
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
diff --git a/bin/hoogle b/bin/hoogle
diff --git a/bin/repl b/bin/repl
diff --git a/bin/run b/bin/run
diff --git a/bin/test b/bin/test
diff --git a/emanote/README.md b/emanote/README.md
@@ -26,13 +26,13 @@ https://emanote.srid.ca/examples
 
 Emanote is a Haskell software.[^licenses] Thanks to Nix, this repository is pre-configured to provide a delightful development experience with full IDE support in Visual Studio Code. 
 
-See https://srid.ca/haskell-template/start for complete instructions, but the tldr is: Install nix, enable Flakes and run `bin/run`.
+See https://srid.ca/haskell-template/start for complete instructions, but the tldr is: Install nix, enable Flakes and run `just run` in the Nix dev shell.
 
 See [architecture.md](docs/architecture.md) for a high-level overview of the codebase.
 
 ### PR contribution guidelines
 
-Run `nix build .#check -L` when opening a PR.
+Run `nix run nixpkgs#nixci` before opening a PR.
 
 ## Discussion
 

diff --git a/flake.nix b/flake.nix
@@ -140,6 +140,9 @@
                 config.haskellProjects.default.outputs.devShell
                 config.treefmt.build.devShell
               ];
+              packages = with pkgs; [
+                just
+              ];
             });
 
         emanote = {

diff --git a/justfile b/justfile
@@ -0,0 +1,23 @@
+default:
+    @just --list
+
+# Run hoogle
+docs:
+    echo http://127.0.0.1:8888
+    hoogle serve -p 8888 --local
+
+# Run cabal repl
+repl *ARGS:
+    cabal repl --flags=ghcid {{ARGS}}
+
+# Autoformat the project tree
+fmt:
+    treefmt
+
+# Run the app using ghcid (with auto-reload / recompile)
+run:
+  ghcid -c 'cabal repl exe:emanote --flags=ghcid' --warnings -T ":main -L ../docs run --port=9010"
+
+# Run tests (with auto-reload / recompile)
+test:
+    ghcid -c "cabal repl test:test --flags=ghcid" --warnings -T :main