nix-community.nixvim/plugins/utils/spider.nix

{
  lib,
  helpers,
  config,
  pkgs,
  ...
}:
with lib; let
  pluginName = "spider";
  cfg = config.plugins.${pluginName};
in {
  options.plugins.${pluginName} =
    helpers.extraOptionsOptions
    // {
      enable = mkEnableOption pluginName;

      package = helpers.mkPackageOption pluginName pkgs.vimPlugins.nvim-spider;

      skipInsignificantPunctuation =
        helpers.defaultNullOpts.mkBool true "Whether to skip unsignificant punctuation.";

      keymaps = {
        silent = mkOption {
          type = types.bool;
          description = "Whether ${pluginName} keymaps should be silent.";
          default = false;
        };

        motions = mkOption {
          type = types.attrsOf types.str;
          description = ''
            Mappings for spider motions.
            The keys are the motion and the values are the keyboard shortcuts.
            The shortcut might not necessarily be the same as the motion name.
          '';
          default = {};
          example = {
            w = "w";
            e = "e";
            b = "b";
            ge = "ge";
          };
        };
      };
    };

  config = let
    setupOptions =
      {
        inherit (cfg) skipInsignificantPunctuation;
      }
      // cfg.extraOptions;

    mappings =
      mapAttrsToList
      (
        motion: key: {
          mode = ["n" "o" "x"];
          inherit key;
          action = "function() require('spider').motion('${motion}') end";
          lua = true;
          options = {
            inherit (cfg.keymaps) silent;
            desc = "Spider-${motion}";
          };
        }
      )
      cfg.keymaps.motions;
  in
    mkIf cfg.enable {
      extraPlugins = [cfg.package];

      keymaps = mappings;

      extraConfigLua = ''
        require("${pluginName}").setup(${helpers.toLuaObject setupOptions})
      '';
    };
}