feat(wrapperModules.neovim): config.hosts.ruby.gemdir (#194)

also improved tips and tricks documentation

Author: BirdeeHub

wrapperModules/n/neovim/default-config.nix

@@ -339,7 +339,12 @@
       config.package = lib.makeOverridable pkgs.bundlerEnv {
         name = "neovim-ruby-host";
         postBuild = "ln -sf ${pkgs.ruby}/bin/* $out/bin";
-        gemdir = "${pkgs.path}/pkgs/applications/editors/neovim/ruby_provider";
+        gemdir = config.gemdir;
+      };
+      options.gemdir = lib.mkOption {
+        type = wlib.types.stringable;
+        default = "${pkgs.path}/pkgs/applications/editors/neovim/ruby_provider";
+        description = "The path to the ruby gem directory with the neovim gem as required by `pkgs.bundlerEnv`";
       };
       config.exePath = "bin/neovim-ruby-host";
       config.binName = "neovim-ruby-host";

wrapperModules/n/neovim/post_desc.md

@@ -6,6 +6,27 @@ By default, the specs will run after it. Add `before = [ "INIT_MAIN" ]` to the s
 
 ---
 
+- Your `config.settings.config_directory` can point to an impure path (or lua inline value)
+
+Use this for a quick feedback mode while editing, and then switch it back to the pure path when you are done! (or make an option for it)
+
+---
+
+- lazy loading
+
+If you mark a spec as lazy, (or mark a parent spec and don't override the value in the child spec by default),
+it will be placed in `pack/myNeovimPackages/opt/<pname>` on the runtime path.
+
+It will not be loaded yet. Use `vim.cmd.packadd("<pname>")` to load it via `lua` (or `vimscript` or `fennel`) at a time of your choosing.
+
+There are great plugins for this.
+
+See [lze](https://github.com/BirdeeHub/lze) and [lz.n](https://github.com/nvim-neorocks/lz.n), which work beautifully with this method of installing plugins.
+
+They also work great with the builtin `neovim` plugin manager, `vim.pack.add`!
+
+---
+
 - Use `nvim-lib.mkPlugin` to build plugins from sources outside nixpkgs (e.g., git flake inputs)
 
 ```nix
@@ -21,10 +42,6 @@ config.specs.treesj = config.nvim-lib.mkPlugin "treesj" inputs.treesj;
 
 ---
 
-- Use `specMaps` for advanced spec processing only when `specMods` and `specCollect` is not flexible enough
-
----
-
 - Make a new host!
 
 ```nix
@@ -69,3 +86,63 @@ config.specMods = { parentSpec, ... }: {
   config.collateGrammars = lib.mkDefault (parentSpec.collateGrammars or true);
 };
 ```
+
+---
+
+- Use `specMaps` for advanced spec processing only when `specMods` and `specCollect` is not flexible enough
+
+---
+
+- building many plugins from outside nixpkgs at once
+
+In your flake inputs, if you named your inputs like so:
+
+```nix
+inputs.plugins-treesitter-textobjects = {
+  url = "github:nvim-treesitter/nvim-treesitter-textobjects/main";
+  flake = false;
+};
+```
+
+You could identify them and pre-build them as plugins all at once!
+
+Here is a useful module to import which gives you a helper function
+in `config.nvim-lib` for that!
+
+```nix
+{ config, lib, ... }: {
+  options.nvim-lib.pluginsFromPrefix = lib.mkOption {
+    type = lib.types.raw;
+    readOnly = true;
+    default =
+      prefix: inputs:
+      lib.pipe inputs [
+        builtins.attrNames
+        (builtins.filter (s: lib.hasPrefix prefix s))
+        (map (
+          input:
+          let
+            name = lib.removePrefix prefix input;
+          in
+          {
+            inherit name;
+            value = config.nvim-lib.mkPlugin name inputs.${input};
+          }
+        ))
+        builtins.listToAttrs
+      ];
+  };
+}
+```
+
+And then you have access to the plugins like this!:
+
+```nix
+inputs:
+{ config, ... }: let
+  neovimPlugins = config.nvim-lib.pluginsFromPrefix "plugins-" inputs;
+in {
+  imports = [ ./the_above_module.nix ];
+  specs.treesitter-textobjects = neovimPlugins.treesitter-textobjects;
+}
+```