Merge pull request #2133 from cachix/fix-2127

scripts: fix the `packages` option

Author: domenkozar

examples/scripts/devenv.nix

@@ -5,22 +5,25 @@
 }:
 
 {
+  # Top-level packages to the shell
   packages = [
-    pkgs.curl
     pkgs.jq
   ];
 
-  scripts.silly-example.exec = ''curl "https://httpbin.org/get?$1" | jq .args'';
-  scripts.silly-example.description = "curls httpbin with provided arg";
+  # Scripts have access to the top-level `packages`
+  scripts.silly-example.exec = ''echo "{\"name\":\"$1\",\"greeting\":\"Hello $1!\",\"timestamp\":\"$(date -Iseconds)\"}" | jq '';
+  scripts.silly-example.description = "creates JSON with provided arg and shows it with jq";
 
-  scripts.serious-example.exec = ''${pkgs.cowsay}/bin/cowsay "$*"'';
+  # Scripts can declare their own private `packages`
+  scripts.serious-example.exec = ''cowsay "$*"'';
+  scripts.serious-example.packages = [ pkgs.cowsay ];
   scripts.serious-example.description = ''echoes args in a very serious manner'';
 
-  # Example with custom package
+  # Write scripts using your favourite language.
   scripts.python-hello.exec = ''print("Hello, world!")'';
-  scripts.python-hello.package = pkgs.python311;
+  scripts.python-hello.package = pkgs.python3Minimal;
 
-  # Example when package and binary are different
+  # Handle custom scripts where the binary name doesn't match the package name
   scripts.nushell-greet.exec = ''
     def greet [name] {
     	["hello" $name]
@@ -31,6 +34,7 @@
   scripts.nushell-greet.package = pkgs.nushell;
   scripts.nushell-greet.binary = "nu";
 
+  # Render a help section when you enter the shell, similar to `devenv info`
   enterShell = ''
     echo
     echo 🦾 Helper scripts you can run to make your development richer:
@@ -40,4 +44,19 @@
     EOF
     echo
   '';
+
+  # Test that the scripts work as expected with `devenv test`
+  enterTest = ''
+    echo "Testing silly-example"
+    silly-example world | grep Hello
+
+    echo "Testing serious-example"
+    serious-example hello world | grep hello
+
+    echo "Testing python-hello"
+    python-hello | grep Hello
+
+    echo "Testing nushell-greet"
+    nushell-greet | grep hello
+  '';
 }

src/modules/scripts.nix

@@ -48,22 +48,17 @@ let
             if config.binary != null
             then "${pkgs.lib.getBin config.package}/bin/${config.binary}"
             else pkgs.lib.getExe config.package;
+
+          execScript = pkgs.writeScript "${name}-script" ''
+            #!${binary}
+            ${config.exec}
+          '';
         in
         lib.hiPrioSet (
-          pkgs.runCommand name
-            {
-              buildInputs = config.packages;
-              text = ''
-                #!${binary}
-                ${config.exec}
-              '';
-              passAsFile = [ "text" ];
-              meta.mainProgram = name;
-            } ''
-            target="$out/bin/${name}"
-            mkdir -p "$(dirname "$target")"
-            mv "$textPath" "$target"
-            chmod +x "$target"
+          pkgs.writeScriptBin name ''
+            #!${lib.getExe pkgs.bashInteractive}
+            export PATH=${pkgs.lib.makeBinPath config.packages}:$PATH
+            exec ${execScript} "$@"
           ''
         );
     }