modules: add autoGroups + refactoring (#147)

modules/autocmd.nix

@@ -1,76 +1,70 @@
 { config, lib, ... }:
 with lib;
 let
-  helpers = import ../plugins/helpers.nix { inherit lib; };
+  helpers = import ../lib/helpers.nix { inherit lib; };
+
+  autoGroupOption = types.submodule {
+    options = {
+      clear = mkOption {
+        type = types.bool;
+        description = "Clear existing commands if the group already exists.";
+        default = true;
+      };
+    };
+  };
 
   autoCmdOption = types.submodule {
     options = {
-      event = mkOption {
+      event = helpers.mkNullOrOption (types.either types.str (types.listOf types.str)) ''
-        type = types.oneOf [
+        The event or events to register this autocommand.
-          types.str
+      '';
-          (types.listOf types.str)
+
-        ];
+      group = helpers.mkNullOrOption (types.either types.str types.int) ''
-        description = "The event or events to register this autocommand.";
+        The autocommand group name or id to match against.
+      '';
+
+      pattern = helpers.mkNullOrOption (types.either types.str (types.listOf types.str)) ''
+        Pattern or patterns to match literally against.
+      '';
+
+      buffer = helpers.defaultNullOpts.mkInt null ''
+        Buffer number for buffer local autocommands |autocmd-buflocal|.
+        Cannot be used with <pattern>.
+      '';
+
+      description = helpers.defaultNullOpts.mkStr "" "A textual description of this autocommand.";
+
+      callback = helpers.defaultNullOpts.mkStr null ''
+        The name of a Vimscript function to call when this autocommand is triggered. Cannot be used with <command>.
+      '';
+
+      command = helpers.defaultNullOpts.mkStr null ''
+        Vim command to execute on event. Cannot be used with <callback>
+      '';
+
+      once = helpers.defaultNullOpts.mkBool false "Run the autocommand only once";
+
+      nested = helpers.defaultNullOpts.mkBool false "Run nested autocommands.";
+    };
   };
 
-      group = mkOption {
-        type = types.nullOr (types.oneOf [
-          types.str
-          types.int
-        ]);
-        description = "The autocommand group name or id to match against.";
-        default = null;
-      };
-
-      pattern = mkOption {
-        type = types.nullOr (types.oneOf [
-          types.str
-          (types.listOf types.str)
-        ]);
-        description = "Pattern or patterns to match literally against.";
-        default = null;
-      };
-
-      buffer = mkOption {
-        type = types.nullOr types.int;
-        description = "Buffer number for buffer local autocommands |autocmd-buflocal|. Cannot be used with <pattern>.";
-        default = null;
-      };
-
-      description = mkOption {
-        type = types.nullOr types.str;
-        description = "A textual description of this autocommand.";
-        default = null;
-      };
-
-      callback = mkOption {
-        type = types.nullOr types.str;
-        description = "The name of a Vimscript function to call when this autocommand is triggered. Cannot be used with <command>.";
-        default = null;
-      };
-
-      command = mkOption {
-        type = types.nullOr types.str;
-        description = "Vim command to execute on event. Cannot be used with <callback>";
-        default = null;
-      };
-
-      once = mkOption {
-        type = types.nullOr types.bool;
-        description = "Run the autocommand only once";
-        default = null;
-      };
-
-      nested = mkOption {
-        type = types.nullOr types.bool;
-        description = "Run nested autocommands.";
-        default = null;
-      };
-    };
-  };
 in
 {
-  options.autoCmd = mkOption {
+  options = {
+    autoGroups = mkOption {
+      type = types.attrsOf autoGroupOption;
+      default = { };
+      description = "augroup definitions";
+      example = ''
+        autoGroups = {
+          my_augroup = {
+            clear = true;
+          }
+        };
+      '';
+    };
+
+    autoCmd = mkOption {
       type = types.listOf autoCmdOption;
       default = [ ];
       description = "autocmd definitions";
@@ -84,10 +78,22 @@ in
         ];
       '';
     };
+  };
 
-  config = {
+  config = mkIf (config.autoGroups != { } || config.autoCmd != { }) {
-    extraConfigLua = optionalString (config.autoCmd != [ ]) ''
+    extraConfigLuaPost = (optionalString (config.autoGroups != { }) ''
-      -- Set up autocommands {{{
+      -- Set up autogroups {{
+      do
+        local __nixvim_autogroups = ${helpers.toLuaObject config.autoGroups}
+
+        for group_name, options in pairs(__nixvim_autogroups) do
+          vim.api.nvim_create_augroup(group_name, options)
+        end
+      end
+      -- }}
+    '') +
+    (optionalString (config.autoCmd != [ ]) ''
+      -- Set up autocommands {{
       do
         local __nixvim_autocommands = ${helpers.toLuaObject config.autoCmd}
 
@@ -107,7 +113,7 @@ in
           )
         end
       end
-      -- }}}
+      -- }}
-    '';
+    '');
   };
 }