home-manager/modules/programs/exa.nix
Emily 9f9e277b60 treewide: remove now-redundant lib.mdDoc calls
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.

Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.

To reproduce this commit, run:

    $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
      nix shell nixpkgs#coreutils \
      -c find . -name '*.nix' \
      -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
      --strip {} +
    $ ./format
2023-07-17 18:49:09 +01:00

67 lines
1.5 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
{
meta.maintainers = [ hm.maintainers.kalhauge ];
options.programs.exa = {
enable = mkEnableOption "exa, a modern replacement for {command}`ls`";
enableAliases = mkEnableOption "recommended exa aliases (ls, ll)";
extraOptions = mkOption {
type = types.listOf types.str;
default = [ ];
example = [ "--group-directories-first" "--header" ];
description = ''
Extra command line options passed to exa.
'';
};
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 "exa" { };
};
config = let
cfg = config.programs.exa;
args = escapeShellArgs (optional cfg.icons "--icons"
++ optional cfg.git "--git" ++ cfg.extraOptions);
aliases = {
exa = "exa ${args}";
} // optionalAttrs cfg.enableAliases {
ls = "exa";
ll = "exa -l";
la = "exa -a";
lt = "exa --tree";
lla = "exa -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;
};
}