Merge pull request #890 from mmlb/add-scripts.script.description

Add description to script

Author: domenkozar

docs/scripts.md

@@ -57,3 +57,42 @@ Entering shell ...
   "foo": "1"
 }
 ```
+
+Scripts can also have an optional description, which can be useful in your `enterShell`.
+
+```nix title="devenv.nix"
+{ pkgs, config, lib, ... }:
+
+{
+  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.serious-example.exec = ''${pkgs.cowsay}/bin/cowsay "$*"'';
+  scripts.serious-example.description = ''echoes args in a very serious manner'';
+
+  enterShell = ''
+      echo
+      echo 🦾 Helper scripts you can run to make your development richer:
+      echo 🦾
+      ${pkgs.gnused}/bin/sed -e 's| |••|g' -e 's|=| |' <<EOF | ${pkgs.util-linuxMinimal}/bin/column -t | ${pkgs.gnused}/bin/sed -e 's|^|🦾 |' -e 's|••| |g'
+      ${lib.generators.toKeyValue {} (lib.mapAttrs (name: value: value.description) config.scripts)}
+      EOF
+      echo
+    '';
+}
+```
+
+```shell-session
+$ devenv shell
+Building shell ...
+Entering shell ...
+
+🦾 Helper scripts you can run to make your development richer:
+🦾
+🦾 serious-example  echoes args in a very serious manner
+🦾 silly-example    curls httpbin with provided arg
+
+(devenv) $
+```

examples/scripts/devenv.nix

@@ -1,7 +1,21 @@
-{ pkgs, ... }:
+{ config, lib, pkgs, ... }:
 
 {
-  scripts."gitversion".exec = ''
-    echo hello $(${pkgs.git}/bin/git --version)
+  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.serious-example.exec = ''${pkgs.cowsay}/bin/cowsay "$*"'';
+  scripts.serious-example.description = ''echoes args in a very serious manner'';
+
+  enterShell = ''
+    echo
+    echo 🦾 Helper scripts you can run to make your development richer:
+    echo 🦾
+    ${pkgs.gnused}/bin/sed -e 's| |••|g' -e 's|=| |' <<EOF | ${pkgs.util-linuxMinimal}/bin/column -t | ${pkgs.gnused}/bin/sed -e 's|^|🦾 |' -e 's|••| |g'
+    ${lib.generators.toKeyValue {} (lib.mapAttrs (name: value: value.description) config.scripts)}
+    EOF
+    echo
   '';
 }

src/modules/scripts.nix

@@ -8,6 +8,11 @@ let
         type = types.str;
         description = "Bash code to execute when the script is run.";
       };
+      description = lib.mkOption {
+        type = types.str;
+        description = "Description of the script.";
+        default = "";
+      };
     };
   });
   # lib.hiPrioSet: prioritize scripts over plain packages