modules/options: Allow to add code around the globals

This will be used to implement `luaConfig` for plugins that use global
variables for their configuration

Author: traxys

modules/opts.nix

@@ -36,15 +36,29 @@ let
   };
 in
 {
-  options = lib.mapAttrs (
-    _:
-    { description, ... }:
-    lib.mkOption {
-      type = with lib.types; attrsOf anything;
-      default = { };
-      inherit description;
-    }
-  ) optionsAttrs;
+  options =
+    (lib.mapAttrs (
+      _:
+      { description, ... }:
+      lib.mkOption {
+        type = with lib.types; attrsOf anything;
+        default = { };
+        inherit description;
+      }
+    ) optionsAttrs)
+    // {
+      globalsPre = lib.mkOption {
+        type = lib.types.lines;
+        default = "";
+        internal = true;
+      };
+
+      globalsPost = lib.mkOption {
+        type = lib.types.lines;
+        default = "";
+        internal = true;
+      };
+    };
 
   # Added 2024-03-29 (do not remove)
   imports = lib.mapAttrsToList (old: new: lib.mkRenamedOptionModule [ old ] [ new ]) {
@@ -68,18 +82,27 @@ in
             let
               varName = "nixvim_${luaVariableName}";
               optionDefinitions = helpers.toLuaObject config.${optionName};
+              ifGlobals = lib.optionalString (optionName == "globals");
             in
-            lib.optionalString (optionDefinitions != "{ }") ''
-              -- Set up ${prettyName} {{{
-              do
-                local ${varName} = ${optionDefinitions}
+            lib.optionalString (optionDefinitions != "{ }") (
+              ''
+                -- Set up ${prettyName} {{{
+              ''
+              + (ifGlobals config.globalsPre)
+              + ''
+                do
+                  local ${varName} = ${optionDefinitions}
 
-                for k,v in pairs(${varName}) do
-                  vim.${luaApi}[k] = v
+                  for k,v in pairs(${varName}) do
+                    vim.${luaApi}[k] = v
+                  end
                 end
-              end
-              -- }}}
-            ''
+              ''
+              + (ifGlobals config.globalsPost)
+              + ''
+                -- }}}
+              ''
+            )
           ) optionsAttrs
         );
       in

tests/test-sources/modules/options.nix

@@ -23,10 +23,20 @@
   };
 
   globals = {
+    globalsPre = ''
+      dummy = 45
+    '';
     globals = {
+      with_pre.__raw = "dummy";
       loaded_ruby_provider = 0;
       loaded_perl_provider = 0;
       loaded_python_provider = 0;
     };
+    globalsPost = # lua
+      ''
+        if vim.g.with_pre ~= dummy then
+          print("Mismatch for vim.g.with_pre, expected " .. dummy .. " got " .. vim.g.with_pre)
+        end
+      '';
   };
 }