plugins/nvim-autopairs: refactor + update options (#211)

plugins/utils/nvim-autopairs.nix

@@ -3,59 +3,132 @@
   config,
   lib,
   ...
-}:
+} @ args:
 with lib; let
   cfg = config.plugins.nvim-autopairs;
   helpers = import ../helpers.nix {inherit lib;};
+  optionWarnings = import ../../lib/option-warnings.nix args;
+  basePluginPath = ["plugins" "nvim-autopairs"];
 in {
-  options.plugins.nvim-autopairs = {
+  imports = [
-    enable = mkEnableOption "nvim-autopairs";
+    (optionWarnings.mkRemovedOption {
+      option = basePluginPath ++ ["breakLineFiletypes"];
+    })
+    (optionWarnings.mkRemovedOption {
+      option = basePluginPath ++ ["htmlFiletypes"];
+    })
+  ];
 
-    package = helpers.mkPackageOption "nvim-autopairs" pkgs.vimPlugins.nvim-autopairs;
+  options.plugins.nvim-autopairs =
+    helpers.extraOptionsOptions
+    // {
+      enable = mkEnableOption "nvim-autopairs";
 
-    pairs = mkOption {
+      package = helpers.mkPackageOption "nvim-autopairs" pkgs.vimPlugins.nvim-autopairs;
-      type = types.nullOr (types.attrsOf types.str);
+
-      default = null;
+      pairs = helpers.mkNullOrOption (types.attrsOf types.str) "Characters to pair up";
-      description = "Characters to pair up";
+
+      disabledFiletypes =
+        helpers.defaultNullOpts.mkNullable
+        (types.attrsOf types.str)
+        "[ \"TelescopePrompt\" ]"
+        "Disabled filetypes";
+
+      # TODO remove this option at some point (it has been marked as removed since XX-XX-2023)
+      breakLineFiletypes = mkOption {
+        type = types.nullOr (types.listOf types.str);
+        default = null;
+        description = "Filetypes to break lines on";
+      };
+
+      # TODO remove this option at some point (it has been marked as removed since XX-XX-2023)
+      htmlFiletypes = mkOption {
+        type = types.nullOr (types.listOf types.str);
+        default = null;
+        description = "Filetypes to treat as HTML";
+      };
+
+      disableInMacro = helpers.defaultNullOpts.mkBool false ''
+        Disable when recording or executing a macro.
+      '';
+
+      disableInVisualblock = helpers.defaultNullOpts.mkBool false ''
+        Disable when insert after visual block mode.
+      '';
+
+      disableInReplaceMode = helpers.defaultNullOpts.mkBool true "Disable in replace mode.";
+
+      ignoredNextChar = helpers.defaultNullOpts.mkStr "[=[[%w%%%'%[%\"%.%`%$]]=]" ''
+        Regexp to ignore if it matches the next character.
+      '';
+
+      enableMoveright = helpers.defaultNullOpts.mkBool true "Enable moveright.";
+
+      enableAfterQuote = helpers.defaultNullOpts.mkBool true "Add bracket pairs after quote.";
+
+      enableCheckBracketLine = helpers.defaultNullOpts.mkBool true "Check bracket in same line.";
+
+      enableBracketInQuote = helpers.defaultNullOpts.mkBool true "Enable bracket in quote.";
+
+      enableAbbr = helpers.defaultNullOpts.mkBool false "Trigger abbreviation.";
+
+      breakUndo = helpers.defaultNullOpts.mkBool true "Switch for basic rule break undo sequence.";
+
+      checkTs = helpers.defaultNullOpts.mkBool false "Use treesitter to check for a pair.";
+
+      tsConfig = helpers.mkNullOrOption (types.nullOr types.attrs) ''
+        Configuration for TreeSitter.
+
+        Default:
+        ```
+        {
+          lua = [ "string" "source" ];
+          javascript = [ "string" "template_string" ];
+        };
+        ```
+      '';
+
+      mapCr = helpers.defaultNullOpts.mkBool true "Map the <CR> key to confirm the completion.";
+
+      mapBs = helpers.defaultNullOpts.mkBool true "Map the <BS> key to delete the pair.";
+
+      mapCH = helpers.defaultNullOpts.mkBool false "Map the <C-h> key to delete a pair.";
+
+      mapCW = helpers.defaultNullOpts.mkBool false "Map the <C-w> key to delete a pair if possible.";
     };
 
-    disabledFiletypes = mkOption {
-      type = types.nullOr (types.listOf types.str);
-      default = null;
-      description = "Disabled filetypes";
-    };
-
-    breakLineFiletypes = mkOption {
-      type = types.nullOr (types.listOf types.str);
-      default = null;
-      description = "Filetypes to break lines on";
-    };
-
-    htmlFiletypes = mkOption {
-      type = types.nullOr (types.listOf types.str);
-      default = null;
-      description = "Filetypes to treat as HTML";
-    };
-
-    ignoredNextChar = mkOption {
-      type = types.nullOr types.str;
-      default = null;
-      description = "Regexp to ignore if it matches the next character";
-    };
-  };
-
   config = let
-    options = {
+    options =
-      pairs_map = cfg.pairs;
+      {
-      disable_filetype = cfg.disabledFiletypes;
+        pairs_map = cfg.pairs;
-      break_line_filetype = cfg.breakLineFiletypes;
+
-      html_break_line_filetype = cfg.htmlFiletypes;
+        disable_filetype = cfg.disabledFiletypes;
-      ignored_next_char = cfg.ignoredNextChar;
+        disable_in_macro = cfg.disableInMacro;
-    };
+        disable_in_visualblock = cfg.disableInVisualblock;
+        disable_in_replace_mode = cfg.disableInReplaceMode;
+        ignored_next_char =
+          if isNull cfg.ignoredNextChar
+          then null
+          else helpers.mkRaw cfg.ignoredNextChar;
+        enable_moveright = cfg.enableMoveright;
+        enable_afterquote = cfg.enableAfterQuote;
+        enable_check_bracket_line = cfg.enableCheckBracketLine;
+        enable_bracket_in_quote = cfg.enableBracketInQuote;
+        enable_abbr = cfg.enableAbbr;
+        break_undo = cfg.breakUndo;
+        check_ts = cfg.checkTs;
+        map_cr = cfg.mapCr;
+        map_bs = cfg.mapBs;
+        map_c_h = cfg.mapCH;
+        map_c_w = cfg.mapCW;
+      }
+      // cfg.extraOptions;
   in
     mkIf cfg.enable {
       extraPlugins = [cfg.package];
 
+      plugins.treesitter.enable = mkIf (cfg.checkTs == true) true;
+
       extraConfigLua = ''
         require('nvim-autopairs').setup(${helpers.toLuaObject options})
       '';