Nixify rundoc.sh

Author: srid

dev/flake.nix

@@ -27,6 +27,11 @@
           packages = with pkgs; [
             just
           ];
+          shellHook = ''
+            echo
+            echo "🍎🍎 Run 'just <recipe>' to get started"
+            just
+          '';
         };
       };
     };

doc/flake.nix

@@ -37,6 +37,22 @@
         };
         formatter = pkgs.nixpkgs-fmt;
         checks.linkcheck = inputs'.flake-parts-website.checks.linkcheck;
+        packages.flake-parts = inputs'.flake-parts-website.packages.default;
+        apps.flake-parts.program = pkgs.writeShellApplication {
+          name = "docs-flake-parts";
+          meta.description = "Open flake.parts docs, previewing local haskell-flake version";
+          text = ''
+            DOCSHTML="${self'.packages.flake-parts}/options/haskell-flake.html"
+
+            if [ "$(uname)" == "Darwin" ]; then
+              open $DOCSHTML
+            else 
+              if type xdg-open &>/dev/null; then
+                xdg-open $DOCSHTML
+              fi
+            fi
+          '';
+        };
       };
     };
 }

flake.nix

@@ -30,6 +30,8 @@
           dir = "doc";
           overrideInputs = {
             "haskell-flake" = ./.;
+            # TODO: It is better to add a update-flake-lock.yaml CI action to
+            # update this just like ./example inputs.
             "flake-parts-website" = "github:hercules-ci/flake.parts-website";
           };
         };

justfile

@@ -12,3 +12,11 @@ check:
 # Auto-format the Nix files in project tree
 fmt:
     treefmt
+
+# Open haskell-flake docs live preview
+docs:
+    cd ./doc && nix run
+
+# Open flake.parts docs, previewing local haskell-flake version
+docs-flake-parts:
+    cd ./doc && nix run .#flake-parts