From 582830954264080aae93f751c3cdc58df600d2d1 Mon Sep 17 00:00:00 2001
From: aabccd021 <aabccd021@gmail.com>
Date: Fri, 9 Sep 2022 07:42:53 +0700
Subject: [PATCH] vifm: add module

---
 modules/lib/maintainers.nix                   |  6 ++++
 modules/misc/news.nix                         | 10 ++++++
 modules/modules.nix                           |  3 +-
 modules/programs/vifm.nix                     | 33 +++++++++++++++++++
 tests/default.nix                             |  1 +
 tests/modules/programs/vifm/default.nix       |  4 +++
 .../modules/programs/vifm/empty-settings.nix  | 11 +++++++
 .../programs/vifm/example-settings.nix        | 21 ++++++++++++
 8 files changed, 88 insertions(+), 1 deletion(-)
 create mode 100644 modules/programs/vifm.nix
 create mode 100644 tests/modules/programs/vifm/default.nix
 create mode 100644 tests/modules/programs/vifm/empty-settings.nix
 create mode 100644 tests/modules/programs/vifm/example-settings.nix

diff --git a/modules/lib/maintainers.nix b/modules/lib/maintainers.nix
index 70f480d06..501917ffb 100644
--- a/modules/lib/maintainers.nix
+++ b/modules/lib/maintainers.nix
@@ -7,6 +7,12 @@
 # [1] https://github.com/NixOS/nixpkgs/blob/fca0d6e093c82b31103dc0dacc48da2a9b06e24b/maintainers/maintainer-list.nix#LC1
 
 {
+  aabccd021 = {
+    name = "Muhamad Abdurahman";
+    email = "aabccd021@gmail.com";
+    github = "aabccd021";
+    githubId = 33031950;
+  };
   abayomi185 = {
     name = "Yomi";
     email = "yomi+nix@yomitosh.com";
diff --git a/modules/misc/news.nix b/modules/misc/news.nix
index abd9957cb..732c92478 100644
--- a/modules/misc/news.nix
+++ b/modules/misc/news.nix
@@ -1760,6 +1760,16 @@ in {
           Eyes in i3, lxde or mate.
         '';
       }
+
+      {
+        time = "2024-10-11T08:23:19+00:00";
+        message = ''
+          A new module is available: 'programs.vifm'.
+
+          Vifm is a curses based Vim-like file manager extended with some useful
+          ideas from mutt.
+        '';
+      }
     ];
   };
 }
diff --git a/modules/modules.nix b/modules/modules.nix
index c69c66b15..72f4adaae 100644
--- a/modules/modules.nix
+++ b/modules/modules.nix
@@ -241,8 +241,9 @@ let
     ./programs/translate-shell.nix
     ./programs/urxvt.nix
     ./programs/vdirsyncer.nix
-    ./programs/vim.nix
+    ./programs/vifm.nix
     ./programs/vim-vint.nix
+    ./programs/vim.nix
     ./programs/vscode.nix
     ./programs/vscode/haskell.nix
     ./programs/pywal.nix
diff --git a/modules/programs/vifm.nix b/modules/programs/vifm.nix
new file mode 100644
index 000000000..2bf31d52d
--- /dev/null
+++ b/modules/programs/vifm.nix
@@ -0,0 +1,33 @@
+{ config, lib, pkgs, ... }:
+
+let
+
+  inherit (lib) mkIf mkOption types;
+
+  cfg = config.programs.vifm;
+
+in {
+  meta.maintainers = [ lib.hm.maintainers.aabccd021 ];
+
+  options.programs.vifm = {
+    enable = lib.mkEnableOption "vifm, a Vim-like file manager";
+
+    package = lib.mkPackageOption pkgs "vifm" { };
+
+    extraConfig = mkOption {
+      type = types.lines;
+      default = "";
+      example = "mark h ~/";
+      description = ''
+        Extra lines added to the {file}`$XDG_CONFIG_HOME/vifm/vifmrc` file.
+      '';
+    };
+  };
+
+  config = mkIf cfg.enable {
+    home.packages = [ cfg.package ];
+
+    xdg.configFile."vifm/vifmrc" =
+      mkIf (cfg.extraConfig != "") { text = cfg.extraConfig; };
+  };
+}
diff --git a/tests/default.nix b/tests/default.nix
index 4cc705b18..83ed42a70 100644
--- a/tests/default.nix
+++ b/tests/default.nix
@@ -155,6 +155,7 @@ in import nmtSrc {
     ./modules/programs/tmux
     ./modules/programs/topgrade
     ./modules/programs/translate-shell
+    ./modules/programs/vifm
     ./modules/programs/vim-vint
     ./modules/programs/vscode
     ./modules/programs/watson
diff --git a/tests/modules/programs/vifm/default.nix b/tests/modules/programs/vifm/default.nix
new file mode 100644
index 000000000..5a75a54aa
--- /dev/null
+++ b/tests/modules/programs/vifm/default.nix
@@ -0,0 +1,4 @@
+{
+  vifm-example-settings = ./example-settings.nix;
+  vifm-empty-settings = ./empty-settings.nix;
+}
diff --git a/tests/modules/programs/vifm/empty-settings.nix b/tests/modules/programs/vifm/empty-settings.nix
new file mode 100644
index 000000000..4e1df9c18
--- /dev/null
+++ b/tests/modules/programs/vifm/empty-settings.nix
@@ -0,0 +1,11 @@
+{ ... }:
+
+{
+  programs.vifm.enable = true;
+
+  test.stubs.vifm = { };
+
+  nmt.script = ''
+    assertPathNotExists home-files/.config/vifm
+  '';
+}
diff --git a/tests/modules/programs/vifm/example-settings.nix b/tests/modules/programs/vifm/example-settings.nix
new file mode 100644
index 000000000..8f562aa62
--- /dev/null
+++ b/tests/modules/programs/vifm/example-settings.nix
@@ -0,0 +1,21 @@
+{ config, ... }:
+
+{
+  programs.vifm = {
+    enable = true;
+    package = config.lib.test.mkStubPackage { };
+    extraConfig = ''
+      mark h ~/
+    '';
+  };
+
+  nmt.script = ''
+    assertFileContent \
+      home-files/.config/vifm/vifmrc \
+      ${
+        builtins.toFile "vifm-expected.conf" ''
+          mark h ~/
+        ''
+      }
+  '';
+}