home-manager/modules/programs/vim.nix

{
  config,
  lib,
  pkgs,
  ...
}:
let
  inherit (lib)
    concatStringsSep
    literalExpression
    mkOption
    types
    ;

  cfg = config.programs.vim;
  defaultPlugins = [ pkgs.vimPlugins.vim-sensible ];

  knownSettings = {
    background = types.enum [
      "dark"
      "light"
    ];
    backupdir = types.listOf types.str;
    copyindent = types.bool;
    directory = types.listOf types.str;
    expandtab = types.bool;
    hidden = types.bool;
    history = types.int;
    ignorecase = types.bool;
    modeline = types.bool;
    mouse = types.enum [
      "n"
      "v"
      "i"
      "c"
      "h"
      "a"
      "r"
    ];
    mousefocus = types.bool;
    mousehide = types.bool;
    mousemodel = types.enum [
      "extend"
      "popup"
      "popup_setpos"
    ];
    number = types.bool;
    relativenumber = types.bool;
    shiftwidth = types.int;
    smartcase = types.bool;
    tabstop = types.int;
    undodir = types.listOf types.str;
    undofile = types.bool;
  };

  vimSettingsType = types.submodule {
    options =
      let
        opt =
          _name: type:
          mkOption {
            type = types.nullOr type;
            default = null;
            visible = false;
          };
      in
      lib.mapAttrs opt knownSettings;
  };

  setExpr =
    name: value:
    let
      v =
        if lib.isBool value then
          (if value then "" else "no") + name
        else
          "${name}=${if lib.isList value then concatStringsSep "," value else toString value}";
    in
    lib.optionalString (value != null) ("set " + v);

  plugins =
    let
      vpkgs = pkgs.vimPlugins;
      getPkg =
        p:
        if lib.isDerivation p then
          [ p ]
        else
          lib.optional (lib.isString p && lib.hasAttr p vpkgs) vpkgs.${p};
    in
    lib.concatMap getPkg cfg.plugins;

in
{
  options = {
    programs.vim = {
      enable = lib.mkEnableOption "Vim";

      plugins = mkOption {
        type = with types; listOf (either str package);
        default = defaultPlugins;
        example = literalExpression "[ pkgs.vimPlugins.YankRing ]";
        description = ''
          List of vim plugins to install. To get a list of supported plugins run:
          {command}`nix-env -f '<nixpkgs>' -qaP -A vimPlugins`.

          Note: String values are deprecated, please use actual packages.
        '';
      };

      settings = mkOption {
        type = vimSettingsType;
        default = { };
        example = {
          expandtab = true;
          history = 1000;
          background = "dark";
        };
        description = ''
          At attribute set of Vim settings. The attribute names and
          corresponding values must be among the following supported
          options.

          ${concatStringsSep "\n" (
            lib.mapAttrsToList (n: v: ''
              {var}`${n}`
              : ${v.description}
            '') knownSettings
          )}

          See the Vim documentation for detailed descriptions of these
          options. Use [](#opt-programs.vim.extraConfig) to manually
          set any options not listed above.
        '';
      };

      extraConfig = mkOption {
        type = types.lines;
        default = "";
        example = ''
          set nocompatible
          set nobackup
        '';
        description = "Custom .vimrc lines";
      };

      package = mkOption {
        type = types.package;
        description = "Resulting customized vim package";
        readOnly = true;
      };

      packageConfigurable = lib.mkPackageOption pkgs "vim-full" {
        extraDescription = "Vim package to customize";
        example = "pkgs.vim";
      };

      defaultEditor = mkOption {
        type = types.bool;
        default = false;
        description = ''
          Whether to configure {command}`vim` as the default
          editor using the {env}`EDITOR` and {env}`VISUAL`
          environment variables.
        '';
      };
    };
  };

  config = (
    let
      customRC = ''
        ${concatStringsSep "\n" (
          lib.remove "" (lib.mapAttrsToList setExpr (builtins.intersectAttrs knownSettings cfg.settings))
        )}

        ${cfg.extraConfig}
      '';

      vim = cfg.packageConfigurable.customize {
        name = "vim";
        vimrcConfig = {
          inherit customRC;

          packages.home-manager.start = plugins;
        };
      };
    in
    lib.mkIf cfg.enable {
      assertions =
        let
          packagesNotFound = lib.filter (p: lib.isString p && (!lib.hasAttr p pkgs.vimPlugins)) cfg.plugins;
        in
        [
          {
            assertion = packagesNotFound == [ ];
            message = "Following VIM plugin not found in pkgs.vimPlugins: ${
              lib.concatMapStringsSep ", " (p: ''"${p}"'') packagesNotFound
            }";
          }
        ];

      warnings =
        let
          stringPlugins = lib.filter lib.isString cfg.plugins;
        in
        lib.optional (stringPlugins != [ ]) ''
          Specifying VIM plugins using strings is deprecated, found ${
            lib.concatMapStringsSep ", " (p: ''"${p}"'') stringPlugins
          } as strings.
        '';

      home.packages = [ cfg.package ];

      home.sessionVariables = lib.mkIf cfg.defaultEditor {
        EDITOR = "vim";
        VISUAL = "vim";
      };

      programs.vim = {
        package = vim;
        plugins = defaultPlugins;
      };
    }
  );
}