neovim: Support Lua for plugin configuration

.github/CODEOWNERS

@@ -157,6 +157,9 @@
 /modules/programs/ne.nix                              @cwyc
 /tests/modules/programs/ne                            @cwyc
 
+/modules/programs/neovim.nix                          @cdunster
+/tests/modules/programs/neovim                        @cdunster
+
 /modules/programs/newsboat.nix                        @sumnerevans
 /tests/modules/programs/newsboat                      @sumnerevans
 

modules/lib/maintainers.nix

@@ -205,4 +205,10 @@
     github = "pinage404";
     githubId = 6325757;
   };
+  cdunster = {
+    name = "Callum Dunster";
+    email = "cdunster@users.noreply.github.com";
+    github = "cdunster";
+    githubId = 5011912;
+  };
 }

modules/programs/neovim.nix

@@ -28,8 +28,7 @@ let
       type = mkOption {
         type =
           types.either (types.enum [ "lua" "viml" "teal" "fennel" ]) types.str;
-        description =
-          "Language used in config. Configurations are aggregated per-language.";
+        description = "Language used in config section of this plugin.";
         default = "viml";
       };
 
@@ -311,14 +310,25 @@ in {
         config = "";
         optional = false;
       }) cfg.plugins;
-    suppressNotVimlConfig = p:
-      if p.type != "viml" then p // { config = ""; } else p;
+    convertConfigToViml = p:
+      if p.type == "viml" then
+        p
+      else if p.type == "lua" then
+        p // {
+          config = ''
+            lua << EOF
+          '' + p.config + ''
+
+            EOF'';
+        }
+      else
+        p // { config = ""; };
 
     neovimConfig = pkgs.neovimUtils.makeNeovimConfig {
       inherit (cfg)
         extraPython3Packages withPython3 withNodeJs withRuby viAlias vimAlias;
       configure = cfg.configure // moduleConfigure;
-      plugins = (map suppressNotVimlConfig pluginsNormalized)
+      plugins = (map convertConfigToViml pluginsNormalized)
         ++ optionals cfg.coc.enable [{ plugin = pkgs.vimPlugins.coc-nvim; }];
       customRC = cfg.extraConfig;
     };

tests/modules/programs/neovim/default.nix

@@ -1,6 +1,7 @@
 {
   neovim-plugin-config = ./plugin-config.nix;
   neovim-coc-config = ./coc-config.nix;
+  neovim-plugin-config-lua = ./plugin-config-lua.nix;
   # waiting for a nixpkgs patch
   # neovim-no-init = ./no-init.nix;
 }

tests/modules/programs/neovim/plugin-config-lua.nix

@@ -0,0 +1,34 @@
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+{
+  config = {
+    programs.neovim = {
+      enable = true;
+      extraConfig = ''
+        " This should be present in init.vim
+      '';
+      plugins = with pkgs.vimPlugins; [
+        vim-nix
+        {
+          plugin = vim-commentary;
+          type = "lua";
+          config = ''
+            -- This should be present in a lua block.
+            vim.opt.number = true
+          '';
+        }
+      ];
+    };
+
+    nmt.script = ''
+      vimrc="$TESTED/home-files/.config/nvim/init.vim"
+      vimrcNormalized="$(normalizeStorePaths "$vimrc")"
+
+      assertFileExists "$vimrc"
+      assertFileContent "$vimrcNormalized" "${./plugin-config-lua.vim}"
+    '';
+  };
+}
+

tests/modules/programs/neovim/plugin-config-lua.vim

@@ -0,0 +1,11 @@
+set packpath^=/nix/store/00000000000000000000000000000000-vim-pack-dir
+set runtimepath^=/nix/store/00000000000000000000000000000000-vim-pack-dir
+
+" vim-commentary {{{
+lua << EOF
+-- This should be present in a lua block.
+vim.opt.number = true
+
+EOF
+" }}}
+" This should be present in init.vim