1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-12-05 01:19:46 +01:00
home-manager/modules/programs/nnn.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

129 lines
3.2 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.nnn;
renderSetting = key: value: "${key}:${value}";
renderSettings = settings:
concatStringsSep ";" (mapAttrsToList renderSetting settings);
pluginModule = types.submodule ({ ... }: {
options = {
src = mkOption {
type = with types; nullOr path;
example = literalExpression ''
(pkgs.fetchFromGitHub {
owner = "jarun";
repo = "nnn";
rev = "v4.0";
sha256 = "sha256-Hpc8YaJeAzJoEi7aJ6DntH2VLkoR6ToP6tPYn3llR7k=";
}) + "/plugins";
'';
default = null;
description = ''
Path to the plugin folder.
'';
};
mappings = mkOption {
type = with types; attrsOf str;
description = ''
Key mappings to the plugins.
'';
default = { };
example = literalExpression ''
{
c = "fzcd";
f = "finder";
v = "imgview";
};
'';
};
};
});
in {
meta.maintainers = with maintainers; [ thiagokokada ];
options = {
programs.nnn = {
enable = mkEnableOption "nnn";
package = mkOption {
type = types.package;
default = pkgs.nnn;
defaultText = literalExpression "pkgs.nnn";
example =
literalExpression "pkgs.nnn.override ({ withNerdIcons = true; });";
description = ''
Package containing the {command}`nnn` program.
'';
};
finalPackage = mkOption {
type = types.package;
readOnly = true;
visible = false;
description = ''
Resulting nnn package.
'';
};
bookmarks = mkOption {
type = with types; attrsOf str;
description = ''
Directory bookmarks.
'';
example = literalExpression ''
{
d = "~/Documents";
D = "~/Downloads";
p = "~/Pictures";
v = "~/Videos";
};
'';
default = { };
};
extraPackages = mkOption {
type = with types; listOf package;
example =
literalExpression "with pkgs; [ ffmpegthumbnailer mediainfo sxiv ]";
description = ''
Extra packages available to nnn.
'';
default = [ ];
};
plugins = mkOption {
type = pluginModule;
description = ''
Manage nnn plugins.
'';
default = { };
};
};
};
config = let
nnnPackage = cfg.package.overrideAttrs (oldAttrs: {
nativeBuildInputs = (oldAttrs.nativeBuildInputs or [ ])
++ [ pkgs.makeWrapper ];
postInstall = ''
${oldAttrs.postInstall or ""}
wrapProgram $out/bin/nnn \
--prefix PATH : "${makeBinPath cfg.extraPackages}" \
--prefix NNN_BMS : "${renderSettings cfg.bookmarks}" \
--prefix NNN_PLUG : "${renderSettings cfg.plugins.mappings}"
'';
});
in mkIf cfg.enable {
programs.nnn.finalPackage = nnnPackage;
home.packages = [ nnnPackage ];
xdg.configFile."nnn/plugins" =
mkIf (cfg.plugins.src != null) { source = cfg.plugins.src; };
};
}