rtx: add module (#4051)

modules/misc/news.nix

@@ -1047,6 +1047,14 @@ in
           A new module is available: 'programs.ripgrep'.
         '';
       }
+
+      {
+        time = "2023-06-07T06:01:16+00:00";
+        message = ''
+          A new module is available: 'programs.rtx'.
+        '';
+      }
+
     ];
   };
 }

modules/modules.nix

@@ -167,6 +167,7 @@ let
     ./programs/rofi-pass.nix
     ./programs/rofi.nix
     ./programs/rtorrent.nix
+    ./programs/rtx.nix
     ./programs/sagemath.nix
     ./programs/sbt.nix
     ./programs/scmpuff.nix

modules/programs/rtx.nix

@@ -0,0 +1,81 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+  cfg = config.programs.rtx;
+  tomlFormat = pkgs.formats.toml { };
+in {
+  meta.maintainers = [ hm.maintainers.pedorich-n ];
+
+  options = {
+    programs.rtx = {
+      enable = mkEnableOption "RTX. Runtime Executor (asdf Rust clone)";
+
+      package = mkPackageOption pkgs "rtx" { };
+
+      enableBashIntegration = mkEnableOption "Bash Integration" // {
+        default = true;
+      };
+
+      enableZshIntegration = mkEnableOption "Zsh Integration" // {
+        default = true;
+      };
+
+      enableFishIntegration = mkEnableOption "Fish Integration" // {
+        default = true;
+      };
+
+      settings = mkOption {
+        type = tomlFormat.type;
+        default = { };
+        example = literalExpression ''
+          tools = {
+            node = "lts";
+            python = ["3.10" "3.11"];
+          };
+
+          settings = {
+            verbose = false;
+            experimental = false;
+          };
+        '';
+        description = ''
+          Settings written to <filename>$XDG_CONFIG_HOME/rtx/config.toml</filename>.
+          </para><para>
+          See <link xlink:href="https://github.com/jdxcode/rtx#global-config-configrtxconfigtoml"/>
+          for details on supported values.
+
+          <warning>
+            <para>
+              Modifying the <literal>tools</literal> section doesn't make RTX install them. 
+              You have to manually run <literal>rtx install</literal> to install the tools.
+            </para>
+          </warning>
+        '';
+      };
+    };
+  };
+
+  config = mkIf cfg.enable {
+    home.packages = [ cfg.package ];
+
+    xdg.configFile."rtx/config.toml" = mkIf (cfg.settings != { }) {
+      source = tomlFormat.generate "rtx-settings" cfg.settings;
+    };
+
+    programs = {
+      bash.initExtra = mkIf cfg.enableBashIntegration ''
+        eval "$(${getExe cfg.package} activate bash)"
+      '';
+
+      zsh.initExtra = mkIf cfg.enableZshIntegration ''
+        eval "$(${getExe cfg.package} activate zsh)"
+      '';
+
+      fish.interactiveShellInit = mkIf cfg.enableFishIntegration ''
+        ${getExe cfg.package} activate fish | source
+      '';
+    };
+  };
+}

tests/default.nix

@@ -116,6 +116,7 @@ import nmt {
     ./modules/programs/qutebrowser
     ./modules/programs/readline
     ./modules/programs/ripgrep
+    ./modules/programs/rtx
     ./modules/programs/sagemath
     ./modules/programs/sbt
     ./modules/programs/scmpuff

tests/modules/programs/rtx/bash-integration.nix

@@ -0,0 +1,16 @@
+{ config, ... }: {
+  programs = {
+    rtx = {
+      package = config.lib.test.mkStubPackage { name = "rtx"; };
+      enable = true;
+      enableBashIntegration = true;
+    };
+
+    bash.enable = true;
+  };
+
+  nmt.script = ''
+    assertFileRegex home-files/.bashrc 'eval "$(/nix/store/.*rtx.*/bin/rtx activate bash)"'
+  '';
+}
+

tests/modules/programs/rtx/custom-settings.nix

@@ -0,0 +1,35 @@
+{ config, pkgs, ... }: {
+  programs = {
+    rtx = {
+      package = config.lib.test.mkStubPackage { name = "rtx"; };
+      enable = true;
+      settings = {
+        tools = {
+          node = "lts";
+          python = [ "3.10" "3.11" ];
+        };
+
+        settings = {
+          verbose = false;
+          experimental = false;
+        };
+      };
+    };
+  };
+
+  nmt.script = ''
+    assertFileExists home-files/.config/rtx/config.toml
+
+    assertFileContent home-files/.config/rtx/config.toml ${
+      pkgs.writeText "rtx.expected" ''
+        [settings]
+        experimental = false
+        verbose = false
+
+        [tools]
+        node = "lts"
+        python = ["3.10", "3.11"]
+      ''
+    }
+  '';
+}

tests/modules/programs/rtx/default-settings.nix

@@ -0,0 +1,12 @@
+{ config, ... }: {
+  config = {
+    programs.rtx = {
+      package = config.lib.test.mkStubPackage { name = "rtx"; };
+      enable = true;
+    };
+
+    nmt.script = ''
+      assertPathNotExists home-files/.config/rtx/config.toml
+    '';
+  };
+}

tests/modules/programs/rtx/default.nix

@@ -0,0 +1,7 @@
+{
+  rtx-default-settings = ./default-settings.nix;
+  rtx-custom-settings = ./custom-settings.nix;
+  rtx-bash-integration = ./bash-integration.nix;
+  rtx-zsh-integration = ./zsh-integration.nix;
+  rtx-fish-integration = ./fish-integration.nix;
+}

tests/modules/programs/rtx/fish-integration.nix

@@ -0,0 +1,16 @@
+{ config, ... }: {
+  programs = {
+    rtx = {
+      package = config.lib.test.mkStubPackage { name = "rtx"; };
+      enable = true;
+      enableFishIntegration = true;
+    };
+
+    fish.enable = true;
+  };
+
+  nmt.script = ''
+    assertFileRegex home-files/.config/fish/config.fish '/nix/store/.*rtx.*/bin/rtx activate fish | source'
+  '';
+}
+

tests/modules/programs/rtx/zsh-integration.nix

@@ -0,0 +1,16 @@
+{ config, ... }: {
+  programs = {
+    rtx = {
+      package = config.lib.test.mkStubPackage { name = "rtx"; };
+      enable = true;
+      enableZshIntegration = true;
+    };
+
+    zsh.enable = true;
+  };
+
+  nmt.script = ''
+    assertFileRegex home-files/.zshrc 'eval "$(/nix/store/.*rtx.*/bin/rtx activate zsh)"'
+  '';
+}
+