Merge 7f5c33605d into 12b650fea7

name should match package.pname

docs/manual/configuring/custom-plugins/configuring.md

@@ -11,8 +11,8 @@ be used if the plugin uses a `require('module').setup(...)` pattern. Otherwise,
 ```nix
 {
   config.vim.lazy.plugins = {
-    aerial-nvim = {
-      # ^^^^^^^^^ this name should match the package.pname or package.name
+    aerial.nvim = {
+    # ^^^^^^^^^ this name should match the package.pname or package.name
       package = aerial-nvim;
 
       setupModule = "aerial";

docs/manual/configuring/custom-plugins/lazy-method.md

@@ -6,9 +6,9 @@ As of version **0.7**, we exposed an API for configuring lazy-loaded plugins via
 ```nix
 {
   config.vim.lazy.plugins = {
-    aerial = {
+    "aerial.nvim" = {
       package = pkgs.vimPlugins.aerial-nvim;
-      setupModule = aerial;
+      setupModule = "aerial";
       setupOpts = {
         option_name = true;
       };

modules/default.nix

@@ -128,9 +128,10 @@ in {
     # will return the configuration in full.
     passthru.neovimConfig = vimOptions;
 
-    meta = {
-      description = "Wrapped version of Neovim with additional helper scripts";
-      mainProgram = "nvim";
-    };
+    meta =
+      neovim-wrapped.meta
+      // {
+        description = "Wrapped Neovim package with helper scripts to print the config (path)";
+      };
   };
 }

modules/plugins/filetree/neo-tree/config.nix

@@ -4,6 +4,7 @@
   ...
 }: let
   inherit (lib.modules) mkIf;
+  inherit (lib.strings) optionalString;
 
   cfg = config.vim.filetree.neo-tree;
 in {
@@ -21,7 +22,28 @@ in {
         setupModule = "neo-tree";
         inherit (cfg) setupOpts;
 
+        beforeAll =
+          optionalString (cfg.setupOpts.filesystem.hijack_netrw_behavior != "disabled")
+          # from https://github.com/nvim-neo-tree/neo-tree.nvim/discussions/1326
+          ''
+            vim.api.nvim_create_autocmd("BufEnter", {
+              group = vim.api.nvim_create_augroup("load_neo_tree", {}),
+              desc = "Loads neo-tree when openning a directory",
+              callback = function(args)
+                local stats = vim.uv.fs_stat(args.file)
+
+                if not stats or stats.type ~= "directory" then
+                  return
+                end
+
+                require("lz.n").trigger_load("neo-tree-nvim")
+
+                return true
+              end,
+            })
+          '';
         cmd = ["Neotree"];
+        event = [];
       };
 
       visuals.nvim-web-devicons.enable = true;

modules/plugins/filetree/neo-tree/neo-tree.nix

@@ -1,5 +1,5 @@
 {lib, ...}: let
-  inherit (lib.types) bool str int submodule enum either listOf;
+  inherit (lib.types) bool str enum either listOf;
   inherit (lib.options) mkOption mkEnableOption literalExpression;
   inherit (lib.nvim.types) mkPluginSetupOption;
 in {
@@ -150,6 +150,14 @@ in {
           A list of filetypes that should not be replaced when opening a file
         '';
       };
+
+      filesystem = {
+        hijack_netrw_behavior = mkOption {
+          type = enum ["disabled" "open_default" "open_current"];
+          default = "open_default";
+          description = "Hijack Netrw behavior";
+        };
+      };
     };
   };
 }

modules/plugins/filetree/nvimtree/config.nix

@@ -24,6 +24,7 @@ in {
         package = "nvim-tree-lua";
         setupModule = "nvim-tree";
         inherit (cfg) setupOpts;
+
         cmd = ["NvimTreeClipboard" "NvimTreeClose" "NvimTreeCollapse" "NvimTreeCollapseKeepBuffers" "NvimTreeFindFile" "NvimTreeFindFileToggle" "NvimTreeFocus" "NvimTreeHiTest" "NvimTreeOpen" "NvimTreeRefresh" "NvimTreeResize" "NvimTreeToggle"];
         keys = [
           (mkLznBinding ["n"] cfg.mappings.toggle ":NvimTreeToggle<cr>" mappings.toggle.description)
@@ -31,58 +32,76 @@ in {
           (mkLznBinding ["n"] cfg.mappings.findFile ":NvimTreeFindFile<cr>" mappings.findFile.description)
           (mkLznBinding ["n"] cfg.mappings.focus ":NvimTreeFocus<cr>" mappings.focus.description)
         ];
+
+        beforeAll = ''
+          ${
+            optionalString cfg.setupOpts.disable_netrw ''
+              -- disable netrew completely
+              vim.g.loaded_netrw = 1
+              vim.g.loaded_netrwPlugin = 1
+            ''
+          }
+
+          ${optionalString (cfg.setupOpts.hijack_netrw && !cfg.openOnSetup) ''
+            vim.api.nvim_create_autocmd("BufEnter", {
+              group = vim.api.nvim_create_augroup("load_nvim_tree", {}),
+              desc = "Loads nvim-tree when openning a directory",
+              callback = function(args)
+                local stats = vim.uv.fs_stat(args.file)
+
+                if not stats or stats.type ~= "directory" then
+                  return
+                end
+
+                require("lz.n").trigger_load("nvim-tree-lua")
+
+                return true
+              end,
+            })
+          ''}
+
+          ${
+            optionalString cfg.openOnSetup ''
+              ${optionalString config.vim.lazy.enable ''require('lz.n').trigger_load("nvim-tree-lua")''}
+              -- autostart behaviour
+              -- Open on startup has been deprecated
+              -- see https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup
+
+              -- use a nix eval to dynamically insert the open on startup function
+              local function open_nvim_tree(data)
+                local IGNORED_FT = {
+                  "markdown",
+                }
+
+                -- buffer is a real file on the disk
+                local real_file = vim.fn.filereadable(data.file) == 1
+
+                -- buffer is a [No Name]
+                  local no_name = data.file == "" and vim.bo[data.buf].buftype == ""
+
+                -- &ft
+                local filetype = vim.bo[data.buf].ft
+
+                -- only files please
+                if not real_file and not no_name then
+                  return
+                end
+
+                -- skip ignored filetypes
+                if vim.tbl_contains(IGNORED_FT, filetype) then
+                  return
+                end
+
+                -- open the tree but don't focus it
+                require("nvim-tree.api").tree.toggle({ focus = false })
+              end
+
+              -- function to automatically open the tree on VimEnter
+              vim.api.nvim_create_autocmd({ "VimEnter" }, { callback = open_nvim_tree })
+            ''
+          }
+        '';
       };
-
-      pluginRC.nvimtreelua = entryAnywhere ''
-        ${
-          optionalString cfg.setupOpts.disable_netrw ''
-            -- disable netrew completely
-            vim.g.loaded_netrw = 1
-            vim.g.loaded_netrwPlugin = 1
-          ''
-        }
-
-        ${
-          optionalString cfg.openOnSetup ''
-            ${optionalString config.vim.lazy.enable ''require('lz.n').trigger_load("nvim-tree-lua")''}
-            -- autostart behaviour
-            -- Open on startup has been deprecated
-            -- see https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup
-
-            -- use a nix eval to dynamically insert the open on startup function
-            local function open_nvim_tree(data)
-              local IGNORED_FT = {
-                "markdown",
-              }
-
-              -- buffer is a real file on the disk
-              local real_file = vim.fn.filereadable(data.file) == 1
-
-              -- buffer is a [No Name]
-                local no_name = data.file == "" and vim.bo[data.buf].buftype == ""
-
-              -- &ft
-              local filetype = vim.bo[data.buf].ft
-
-              -- only files please
-              if not real_file and not no_name then
-                return
-              end
-
-              -- skip ignored filetypes
-              if vim.tbl_contains(IGNORED_FT, filetype) then
-                return
-              end
-
-              -- open the tree but don't focus it
-              require("nvim-tree.api").tree.toggle({ focus = false })
-            end
-
-            -- function to automatically open the tree on VimEnter
-            vim.api.nvim_create_autocmd({ "VimEnter" }, { callback = open_nvim_tree })
-          ''
-        }
-      '';
     };
   };
 }

modules/wrapper/lazy/config.nix

@@ -26,6 +26,15 @@
     (removeAttrs spec ["package" "setupModule" "setupOpts" "keys"])
     // {
       "@1" = name;
+      beforeAll =
+        if spec.beforeAll != null
+        then
+          mkLuaInline ''
+            function()
+              ${spec.beforeAll}
+            end
+          ''
+        else null;
       before =
         if spec.before != null
         then

modules/wrapper/lazy/lazy.nix

@@ -62,7 +62,7 @@
       };
 
       setupOpts = mkOption {
-        type = submodule {freeformType = attrsOf anything;};
+        type = attrsOf anything;
         description = "Options to pass to the setup function";
         default = {};
       };