eza: add module

This copies the exa configuration for eza, the official fork of the
program.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>

modules/misc/news.nix

@@ -1214,6 +1214,13 @@ in
           A new module is available: 'programs.carapace'.
         '';
       }
+
+      {
+        time = "2023-09-07T14:52:19+00:00";
+        message = ''
+          A new module is available: 'programs.eza'.
+        '';
+      }
     ];
   };
 }

modules/modules.nix

@@ -78,6 +78,7 @@ let
     ./programs/eclipse.nix
     ./programs/emacs.nix
     ./programs/eww.nix
+    ./programs/eza.nix
     ./programs/exa.nix
     ./programs/feh.nix
     ./programs/firefox.nix

modules/programs/eza.nix

@@ -0,0 +1,67 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+{
+  meta.maintainers = [ maintainers.cafkafk ];
+
+  options.programs.eza = {
+    enable = mkEnableOption "eza, a modern replacement for {command}`ls`";
+
+    enableAliases = mkEnableOption "recommended eza aliases (ls, ll…)";
+
+    extraOptions = mkOption {
+      type = types.listOf types.str;
+      default = [ ];
+      example = [ "--group-directories-first" "--header" ];
+      description = ''
+        Extra command line options passed to eza.
+      '';
+    };
+
+    icons = mkOption {
+      type = types.bool;
+      default = false;
+      description = ''
+        Display icons next to file names ({option}`--icons` argument).
+      '';
+    };
+
+    git = mkOption {
+      type = types.bool;
+      default = false;
+      description = ''
+        List each file's Git status if tracked or ignored ({option}`--git` argument).
+      '';
+    };
+
+    package = mkPackageOption pkgs "eza" { };
+  };
+
+  config = let
+    cfg = config.programs.eza;
+
+    args = escapeShellArgs (optional cfg.icons "--icons"
+      ++ optional cfg.git "--git" ++ cfg.extraOptions);
+
+    aliases = {
+      eza = "eza ${args}";
+    } // optionalAttrs cfg.enableAliases {
+      ls = "eza";
+      ll = "eza -l";
+      la = "eza -a";
+      lt = "eza --tree";
+      lla = "eza -la";
+    };
+  in mkIf cfg.enable {
+    home.packages = [ cfg.package ];
+
+    programs.bash.shellAliases = aliases;
+
+    programs.zsh.shellAliases = aliases;
+
+    programs.fish.shellAliases = aliases;
+
+    programs.ion.shellAliases = aliases;
+  };
+}