Merge pull request #734 from horriblename/lazy-file

lazy: create LazyFile user event, load copilot-lua on LazyFile

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

@@ -38,3 +38,22 @@ As of version **0.7**, we exposed an API for configuring lazy-loaded plugins via
   };
 }
 ```
+
+## LazyFile event {#sec-lazyfile-event}
+
+You can use the `LazyFile` user event to load a plugin when a file is opened:
+
+```nix
+{
+  config.vim.lazy.plugins = {
+    "aerial.nvim" = {
+      package = pkgs.vimPlugins.aerial-nvim;
+      event = [{event = "User"; pattern = "LazyFile";}];
+      # ...
+    };
+  };
+}
+```
+
+You can consider `LazyFile` as an alias to
+`["BufReadPost" "BufNewFile" "BufWritePre"]`

docs/release-notes/rl-0.8.md

@@ -89,6 +89,7 @@
 [blink.cmp]: https://github.com/saghen/blink.cmp
 
 - Add [blink.cmp] support.
+- Add `LazyFile` user event.
 
 [diniamo](https://github.com/diniamo):
 
@@ -244,8 +245,8 @@
   syncing of nvim shell environment with direnv's.
 - Add [blink.cmp] source options and some default-disabled sources.
 - Add [blink.cmp] option to add
-  [friendly-snippets](https://github.com/rafamadriz/friendly-snippets)
-  so blink.cmp can source snippets from it.
+  [friendly-snippets](https://github.com/rafamadriz/friendly-snippets) so
+  blink.cmp can source snippets from it.
 - Fix [blink.cmp] breaking when built-in sources were modified.
 
 [TheColorman](https://github.com/TheColorman):

modules/plugins/assistant/copilot/config.nix

@@ -37,6 +37,12 @@ in {
           inherit (cfg) setupOpts;
           after = mkIf cfg.cmp.enable "require('copilot_cmp').setup()";
 
+          event = [
+            {
+              event = "User";
+              pattern = "LazyFile";
+            }
+          ];
           cmd = ["Copilot" "CopilotAuth" "CopilotDetach" "CopilotPanel" "CopilotStop"];
           keys = [
             (mkLuaKeymap ["n"] cfg.mappings.panel.accept (wrapPanelBinding ''require("copilot.panel").accept'' cfg.mappings.panel.accept) "[copilot] Accept suggestion" {})

modules/wrapper/lazy/config.nix

@@ -134,6 +134,15 @@ in {
       startPlugins = ["lz-n" "lzn-auto-require"];
 
       optPlugins = pluginPackages;
+      augroups = [{name = "nvf_lazy_file_hooks";}];
+      autocmds = [
+        {
+          event = ["BufReadPost" "BufNewFile" "BufWritePre"];
+          group = "nvf_lazy_file_hooks";
+          command = "doautocmd User LazyFile";
+          once = true;
+        }
+      ];
 
       lazy.builtLazyConfig = ''
         require('lz.n').load(${toLuaObject lznSpecs})

modules/wrapper/lazy/lazy.nix

@@ -126,7 +126,7 @@
       };
 
       event = mkOption {
-        type = nullOr (oneOf [str (listOf str) lznEvent]);
+        type = nullOr (oneOf [str lznEvent (listOf (either str lznEvent))]);
         default = null;
         description = "Lazy-load on event";
       };