Merge branch 'v0.8' into markdown-oxide

.github/workflows/labeler.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     if: "!contains(github.event.pull_request.title, '[skip ci]')"
     steps:
-      - uses: actions/labeler@v5
+      - uses: actions/labeler@v6
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           configuration-path: .github/labels.yml

docs/manual/configuring/autocmds.md

@@ -38,17 +38,17 @@ Autocommands (`autocmd`) trigger actions based on events happening within Neovim
 (e.g., saving a file, entering a buffer). Each entry in the list is a submodule
 with the following options:
 
-| Option     | Type                  | Default | Description                                                                                                                                                                      | Example                                                          |
+| Option     | Type                  | Default | Description                                                                                                             | Example                                                            |
-| :--------- | :-------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------- |
+| :--------- | :-------------------- | :------ | :---------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------- |
-| `enable`   | `bool`                | `true`  | Enables or disables this autocommand definition.                                                                                                                                 | `true`                                                           |
+| `enable`   | `bool`                | `true`  | Enables or disables this autocommand definition.                                                                        | `true`                                                             |
-| `event`    | `nullOr (listOf str)` | `null`  | **Required.** List of Neovim events that trigger this autocommand (e.g., `BufWritePre`, `FileType`).                                                                             | `[ "BufWritePre" ]`                                              |
+| `event`    | `nullOr (listOf str)` | `null`  | **Required.** List of Neovim events that trigger this autocommand (e.g., `BufWritePre`, `FileType`).                    | `[ "BufWritePre" ]`                                                |
-| `pattern`  | `nullOr (listOf str)` | `null`  | List of file patterns (globs) to match against (e.g., `*.py`, `*`). If `null`, matches all files for the given event.                                                            | `[ "*.lua", "*.nix" ]`                                           |
+| `pattern`  | `nullOr (listOf str)` | `null`  | List of file patterns (globs) to match against (e.g., `*.py`, `*`). If `null`, matches all files for the given event.   | `[ "*.lua", "*.nix" ]`                                             |
-| `callback` | `nullOr luaInline`    | `null`  | A Lua function to execute when the event triggers. Use `lib.nvim.types.luaInline` or `lib.options.literalExpression "mkLuaInline '''...'''"`. **Cannot be used with `command`.** | `lib.nvim.types.luaInline "function() print('File saved!') end"` |
+| `callback` | `nullOr luaInline`    | `null`  | A Lua function to execute when the event triggers. Use `lib.generators.mkLuaInline`. **Cannot be used with `command`.** | `lib.generators.mkLuaInline "function() print('File saved!') end"` |
-| `command`  | `nullOr str`          | `null`  | A Vimscript command to execute when the event triggers. **Cannot be used with `callback`.**                                                                                      | `"echo 'File saved!'"`                                           |
+| `command`  | `nullOr str`          | `null`  | A Vimscript command to execute when the event triggers. **Cannot be used with `callback`.**                             | `"echo 'File saved!'"`                                             |
-| `group`    | `nullOr str`          | `null`  | The name of an `augroup` (defined in `vim.augroups`) to associate this autocommand with.                                                                                         | `"MyCustomAuGroup"`                                              |
+| `group`    | `nullOr str`          | `null`  | The name of an `augroup` (defined in `vim.augroups`) to associate this autocommand with.                                | `"MyCustomAuGroup"`                                                |
-| `desc`     | `nullOr str`          | `null`  | A description for the autocommand (useful for introspection).                                                                                                                    | `"Format buffer on save"`                                        |
+| `desc`     | `nullOr str`          | `null`  | A description for the autocommand (useful for introspection).                                                           | `"Format buffer on save"`                                          |
-| `once`     | `bool`                | `false` | If `true`, the autocommand runs only once and then automatically removes itself.                                                                                                 | `false`                                                          |
+| `once`     | `bool`                | `false` | If `true`, the autocommand runs only once and then automatically removes itself.                                        | `false`                                                            |
-| `nested`   | `bool`                | `false` | If `true`, allows this autocommand to trigger other autocommands.                                                                                                                | `false`                                                          |
+| `nested`   | `bool`                | `false` | If `true`, allows this autocommand to trigger other autocommands.                                                       | `false`                                                            |
 
 :::{.warning}
 
@@ -71,7 +71,7 @@ Vimscript) for the same autocommand. Choose one.
       pattern = [ "*.lua" ];
       group = "UserSetup";
       desc = "Notify after saving Lua file";
-      callback = lib.nvim.types.luaInline ''
+      callback = lib.generators.mkLuaInline ''
         function()
           vim.notify("Lua file saved!", vim.log.levels.INFO)
         end

docs/release-notes/rl-0.8.md

@@ -291,6 +291,10 @@
   `null` value to disable them if conform is enabled.
 - Add [markdown-oxide](https://github.com/Feel-ix-343/markdown-oxide) option to
   markdown language module.
+- Fix Helm-YAML language module integration. YAML diagnostics will now remain in
+  `helmfile`s when both are enabled.
+- Fix YAML language module not activating LSP keybinds if the Helm language
+  module was also enabled.
 
 [TheColorman](https://github.com/TheColorman):
 
@@ -546,3 +550,16 @@
 [derethil](https://github.com/derethil):
 
 - Fix `vim.lazy.plugins.<name>.enabled` Lua evaluation.
+
+[Jules](https://github.com/jules-sommer):
+
+[nvim-highlight-colors]: https://github.com/brenoprata10/nvim-highlight-colors
+
+- Add [nvim-highlight-colors] plugin in `vim.ui.nvim-highlight-colors` with
+  `enable` and `setupOpts`
+
+[simon-wg](https://github.com/simon-wg):
+
+- Update `python` language module to use correct lsp binary.
+- Fix `python` pyright and basedpyright language servers not using default on
+  attach behavior.

flake.lock

@@ -23,11 +23,11 @@
         ]
       },
       "locked": {
-        "lastModified": 1754487366,
+        "lastModified": 1756770412,
-        "narHash": "sha256-pHYj8gUBapuUzKV/kN/tR3Zvqc7o6gdFB9XKXIp1SQ8=",
+        "narHash": "sha256-+uWLQZccFHwqpGqr2Yt5VsW/PbeJVTn9Dk6SHWhNRPw=",
         "owner": "hercules-ci",
         "repo": "flake-parts",
-        "rev": "af66ad14b28a127c5c0f3bbb298218fc63528a18",
+        "rev": "4524271976b625a4a605beefd893f270620fd751",
         "type": "github"
       },
       "original": {
@@ -38,11 +38,11 @@
     },
     "mnw": {
       "locked": {
-        "lastModified": 1748710831,
+        "lastModified": 1756659871,
-        "narHash": "sha256-eZu2yH3Y2eA9DD3naKWy/sTxYS5rPK2hO7vj8tvUCSU=",
+        "narHash": "sha256-v6Rh4aQ6RKjM2N02kK9Usn0Ix7+OY66vNpeklc1MnGE=",
         "owner": "Gerg-L",
         "repo": "mnw",
-        "rev": "cff958a4e050f8d917a6ff3a5624bc4681c6187d",
+        "rev": "ed6cc3e48557ba18266e598a5ebb6602499ada16",
         "type": "github"
       },
       "original": {
@@ -53,11 +53,11 @@
     },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1755049066,
+        "lastModified": 1756696532,
-        "narHash": "sha256-ANrc15FSoOAdNbfKHxqEJjZLftIwIsenJGRb/04K41s=",
+        "narHash": "sha256-6FWagzm0b7I/IGigOv9pr6LL7NQ86mextfE8g8Q6HBg=",
         "owner": "nixos",
         "repo": "nixpkgs",
-        "rev": "e45f8f193029378d0aaee5431ba098dc80054e9a",
+        "rev": "58dcbf1ec551914c3756c267b8b9c8c86baa1b2f",
         "type": "github"
       },
       "original": {

flake/pkgs/by-name/avante-nvim/package.nix

@@ -22,7 +22,7 @@
     pname = "avante-nvim-lib";
     inherit version src;
 
-    cargoHash = "sha256-8mBpzndz34RrmhJYezd4hLrJyhVL4S4IHK3plaue1k8=";
+    cargoHash = "sha256-pTWCT2s820mjnfTscFnoSKC37RE7DAPKxP71QuM+JXQ=";
 
     nativeBuildInputs = [
       pkg-config

lib/languages.nix

@@ -46,7 +46,7 @@ in {
       capabilities = mkOption {
         type = nullOr (either luaInline (attrsOf anything));
         default = null;
-        description = "LSP capabilitiess to pass to lspconfig";
+        description = "LSP capabilities to pass to LSP server configuration";
       };
 
       on_attach = mkOption {
@@ -58,7 +58,7 @@ in {
       filetypes = mkOption {
         type = nullOr (listOf str);
         default = null;
-        description = "Filetypes to auto-attach LSP in";
+        description = "Filetypes to auto-attach LSP server in";
       };
 
       cmd = mkOption {

modules/neovim/init/autocmds.nix

@@ -38,7 +38,7 @@
         type = nullOr luaInline;
         default = null;
         example = literalExpression ''
-          mkLuaInline '''
+          lib.generators.mkLuaInline '''
             function()
                 print("Saving a Lua file...")
             end

modules/plugins/languages/helm.nix

@@ -6,7 +6,7 @@
 }: let
   inherit (builtins) attrNames head;
   inherit (lib.options) mkEnableOption mkOption;
-  inherit (lib.modules) mkIf mkMerge;
+  inherit (lib.modules) mkDefault mkIf mkMerge;
   inherit (lib.meta) getExe;
   inherit (lib.types) enum;
   inherit (lib.nvim.types) mkGrammarOption singleOrListOf;
@@ -27,11 +27,13 @@
           dynamicRegistration = true;
         };
       };
-      settings = {
+      settings = mkIf (yamlCfg.enable && yamlCfg.lsp.enable) {
         helm-ls = {
           yamlls = {
-            # TODO: Determine if this is a good enough solution
+            # Without this being enabled, the YAML language module will look broken in helmfiles
-            path = (head yamlCfg.lsp.servers).cmd;
+            # if both modules are enabled at once.
+            enabled = mkDefault yamlCfg.lsp.enable;
+            path = head config.vim.lsp.servers.${head yamlCfg.lsp.servers}.cmd;
           };
         };
       };

modules/plugins/languages/python.nix

@@ -6,7 +6,7 @@
 }: let
   inherit (builtins) attrNames;
   inherit (lib.options) mkEnableOption mkOption literalExpression;
-  inherit (lib.meta) getExe;
+  inherit (lib.meta) getExe getExe';
   inherit (lib.modules) mkIf mkMerge;
   inherit (lib.types) enum package bool;
   inherit (lib.nvim.attrsets) mapListToAttrs;
@@ -20,7 +20,7 @@
   servers = {
     pyright = {
       enable = true;
-      cmd = [(getExe pkgs.pyright) "--stdio"];
+      cmd = [(getExe' pkgs.pyright "pyright-langserver") "--stdio"];
       filetypes = ["python"];
       root_markers = [
         "pyproject.toml"
@@ -42,18 +42,22 @@
       };
       on_attach = mkLuaInline ''
         function(client, bufnr)
+          default_on_attach(client, bufnr);
           vim.api.nvim_buf_create_user_command(bufnr, 'LspPyrightOrganizeImports', function()
-            client:exec_cmd({
+            local params = {
               command = 'pyright.organizeimports',
               arguments = { vim.uri_from_bufnr(bufnr) },
-            })
+            }
+
+            -- Using client.request() directly because "pyright.organizeimports" is private
+            -- (not advertised via capabilities), which client:exec_cmd() refuses to call.
+            -- https://github.com/neovim/neovim/blob/c333d64663d3b6e0dd9aa440e433d346af4a3d81/runtime/lua/vim/lsp/client.lua#L1024-L1030
+            client.request('workspace/executeCommand', params, nil, bufnr)
           end, {
             desc = 'Organize Imports',
           })
-          vim.api.nvim_buf_create_user_command(bufnr, 'LspPyrightSetPythonPath', function(opts)
+          vim.api.nvim_buf_create_user_command(bufnr, 'LspPyrightSetPythonPath', set_python_path, {
-            set_python_path('pyright', opts.args)
+            desc = 'Reconfigure basedpyright with the provided python path',
-          end, {
-            desc = 'Reconfigure pyright with the provided python path',
             nargs = 1,
             complete = 'file',
           })
@@ -63,7 +67,7 @@
 
     basedpyright = {
       enable = true;
-      cmd = [(getExe pkgs.basedpyright) "--stdio"];
+      cmd = [(getExe' pkgs.basedpyright "basedpyright-langserver") "--stdio"];
       filetypes = ["python"];
       root_markers = [
         "pyproject.toml"
@@ -85,18 +89,22 @@
       };
       on_attach = mkLuaInline ''
         function(client, bufnr)
+          default_on_attach(client, bufnr);
           vim.api.nvim_buf_create_user_command(bufnr, 'LspPyrightOrganizeImports', function()
-            client:exec_cmd({
+            local params = {
               command = 'basedpyright.organizeimports',
               arguments = { vim.uri_from_bufnr(bufnr) },
-            })
+            }
+
+            -- Using client.request() directly because "basedpyright.organizeimports" is private
+            -- (not advertised via capabilities), which client:exec_cmd() refuses to call.
+            -- https://github.com/neovim/neovim/blob/c333d64663d3b6e0dd9aa440e433d346af4a3d81/runtime/lua/vim/lsp/client.lua#L1024-L1030
+            client.request('workspace/executeCommand', params, nil, bufnr)
           end, {
             desc = 'Organize Imports',
           })
 
-          vim.api.nvim_buf_create_user_command(bufnr, 'LspPyrightSetPythonPath', function(opts)
+          vim.api.nvim_buf_create_user_command(bufnr, 'LspPyrightSetPythonPath', set_python_path, {
-            set_python_path('basedpyright', opts.args)
-          end, {
             desc = 'Reconfigure basedpyright with the provided python path',
             nargs = 1,
             complete = 'file',
@@ -301,7 +309,8 @@ in {
         lua
         */
         ''
-          local function set_python_path(server_name, path)
+          local function set_python_path(server_name, command)
+            local path = command.args
             local clients = vim.lsp.get_clients {
               bufnr = vim.api.nvim_get_current_buf(),
               name = server_name,
@@ -312,7 +321,7 @@ in {
               else
                 client.config.settings = vim.tbl_deep_extend('force', client.config.settings, { python = { pythonPath = path } })
               end
-              client.notify('workspace/didChangeConfiguration', { settings = nil })
+              client:notify('workspace/didChangeConfiguration', { settings = nil })
             end
           end
         '';

modules/plugins/languages/yaml.nix

@@ -5,6 +5,7 @@
   ...
 }: let
   inherit (builtins) attrNames;
+  inherit (lib.generators) mkLuaInline;
   inherit (lib.options) mkEnableOption mkOption;
   inherit (lib.modules) mkIf mkMerge;
   inherit (lib.meta) getExe;
@@ -14,16 +15,18 @@
 
   cfg = config.vim.languages.yaml;
 
-  onAttach =
+  on_attach = mkLuaInline (
-    if config.vim.languages.helm.lsp.enable
+    if config.vim.languages.helm.lsp.enable && config.vim.languages.helm.enable
     then ''
-      on_attach = function(client, bufnr)
+      function(client, bufnr)
+        default_on_attach()
         local filetype = vim.bo[bufnr].filetype
         if filetype == "helm" then
           client.stop()
         end
       end''
-    else "on_attach = default_on_attach";
+    else "default_on_attach"
+  );
 
   defaultServers = ["yaml-language-server"];
   servers = {
@@ -32,7 +35,7 @@
       cmd = [(getExe pkgs.yaml-language-server) "--stdio"];
       filetypes = ["yaml" "yaml.docker-compose" "yaml.gitlab" "yaml.helm-values"];
       root_markers = [".git"];
-      on_attach = onAttach;
+      inherit on_attach;
       # -- https://github.com/redhat-developer/vscode-redhat-telemetry#how-to-disable-telemetry-reporting
       settings = {
         redhat = {

modules/plugins/tabline/nvim-bufferline/config.nix

@@ -15,7 +15,7 @@ in {
   config = mkIf cfg.enable {
     vim = {
       startPlugins = [
-        "nvim-bufferline-lua"
+        "bufferline-nvim"
         "bufdelete-nvim"
       ];
 

modules/plugins/tabline/nvim-bufferline/nvim-bufferline.nix

@@ -3,7 +3,7 @@
   lib,
   ...
 }: let
-  inherit (lib.options) mkOption mkEnableOption literalExpression;
+  inherit (lib.options) mkOption mkEnableOption literalExpression literalMD;
   inherit (lib.types) enum bool either nullOr str int listOf attrs;
   inherit (lib.generators) mkLuaInline;
   inherit (lib.nvim.binds) mkMappingOption;
@@ -24,17 +24,28 @@ in {
       movePrevious = mkMappingOption "Move previous buffer" "<leader>bmp";
     };
 
-    setupOpts = mkPluginSetupOption "Bufferline-nvim" {
+    setupOpts = mkPluginSetupOption "bufferline-nvim" {
       highlights = mkOption {
         type = either attrs luaInline;
         default =
           if config.vim.theme.enable && config.vim.theme.name == "catppuccin"
           then
-            mkLuaInline
+            mkLuaInline ''
-            ''
+              (function()
-              require("catppuccin.groups.integrations.bufferline").get()
+                local integration = require("catppuccin.groups.integrations.bufferline")
+                return (integration.get_theme or integration.get)()
+              end)()
             ''
           else {};
+        defaultText = literalMD ''
+          ```lua
+          (function()
+            local integration = require("catppuccin.groups.integrations.bufferline")
+            return (integration.get_theme or integration.get)()
+          end)()
+          ```
+          if the active theme is Catppuccin, `{}` otherwise.
+        '';
         description = ''
           Overrides the highlight groups of bufferline.
 
@@ -59,10 +70,11 @@ in {
         themable = mkOption {
           type = bool;
           default = true;
+          example = false;
           description = ''
             Whether or not to allow highlight groups to be overridden.
 
-            While false, bufferline.nvim sets highlights as default.
+            While `false`, bufferline.nvim sets highlights as default.
           '';
         };
 

modules/plugins/theme/supported-themes.nix

@@ -71,6 +71,9 @@ in {
       require('catppuccin').setup {
         flavour = "${style}",
         transparent_background = ${boolToString transparent},
+        float = {
+          transparent = ${boolToString transparent},
+        },
         term_colors = true,
         integrations = {
           nvimtree = {

modules/plugins/ui/default.nix

@@ -3,6 +3,7 @@
     ./borders
     ./breadcrumbs
     ./colorful-menu-nvim
+    ./nvim-highlight-colors
     ./colorizer
     ./fastaction
     ./illuminate

modules/plugins/ui/nvim-highlight-colors/config.nix

@@ -0,0 +1,28 @@
+{
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib.modules) mkIf;
+  inherit (lib.nvim.dag) entryAnywhere;
+  inherit (lib.nvim.lua) toLuaObject;
+
+  cfg = config.vim.ui.nvim-highlight-colors;
+in {
+  config = mkIf cfg.enable {
+    vim = {
+      startPlugins = [
+        "nvim-highlight-colors"
+      ];
+
+      # enable display of 24-bit RGB colors in neovim
+      # via the terminal. This is required for nvim-highlight-colors
+      # to display arbitrary RGB highlights.
+      options.termguicolors = true;
+
+      pluginRC.nvim-highlight-colors = entryAnywhere ''
+        require('nvim-highlight-colors').setup(${toLuaObject cfg.setupOpts})
+      '';
+    };
+  };
+}

modules/plugins/ui/nvim-highlight-colors/default.nix

@@ -0,0 +1,6 @@
+{
+  imports = [
+    ./nvim-highlight-colors.nix
+    ./config.nix
+  ];
+}

modules/plugins/ui/nvim-highlight-colors/nvim-highlight-colors.nix

@@ -0,0 +1,71 @@
+{lib, ...}: let
+  inherit (lib.options) mkOption mkEnableOption;
+  inherit (lib.types) attrsOf enum nullOr submodule bool str;
+  inherit (lib.modules) mkRenamedOptionModule;
+  inherit (lib.nvim.types) mkPluginSetupOption;
+  inherit (lib.nvim.config) mkBool;
+in {
+  options.vim.ui.nvim-highlight-colors = {
+    enable = mkEnableOption "color highlighting [nvim-highlight-colors.lua]";
+
+    setupOpts = mkPluginSetupOption "nvim-highlight-colors" {
+      render = mkOption {
+        type = enum ["background" "foreground" "virtual"];
+        default = "background";
+        example = "virtual";
+        description = ''
+          Style to render color highlighting with.
+
+          ::: {.note}
+          Each render style works as follows:
+            - 'background' sets the background
+              highlight of the matched color string
+              to the RGB color it describes.
+
+            - 'foreground' sets the foreground
+              highlight of the matched color string
+              to the RGB color it describes.
+
+            - 'virtual' displays the matched color
+              with virtual text alongside the color
+              string in the buffer. Virtual text can
+              be configured to display the color in
+              various ways, i.e custom virtual symbol
+              (via `virtual_symbol`) positioning
+              relative to string, suffix/prefix, etc.
+          :::
+        '';
+      };
+
+      virtual_symbol_position = mkOption {
+        type = enum ["inline" "eol" "eow"];
+        default = "inline";
+        example = "eol";
+        description = ''
+          Where to render the virtual symbol in
+          relation to the color string.
+
+          ::: {.note}
+          Each render style works as follows:
+            - 'inline' render virtual text inline,
+              similar to the style of VSCode color
+              hinting.
+
+            - 'eol' render virtual text at the end
+              of the line which the color string
+              occurs (last column). Recommended to
+              set `virtual_symbol_suffix` to an
+              empty string when used.
+
+            - 'eow' render virtual text at the end
+              of the word where the color string
+              occurs. Recommended to set
+              `virtual_symbol_prefix` to a single
+              space for padding and the suffix to
+              an empty string for no padding.
+          :::
+        '';
+      };
+    };
+  };
+}

modules/plugins/utility/images/image-nvim/image-nvim.nix

@@ -9,14 +9,16 @@ in {
 
     setupOpts = mkPluginSetupOption "image.nvim" {
       backend = mkOption {
-        type = enum ["kitty" "ueberzug"];
+        type = enum ["kitty" "ueberzug" "sixel"];
         default = "ueberzug";
         description = ''
           The backend to use for rendering images.
 
-          - kitty - best in class, works great and is very snappy
+          * `kitty` - best in class, works great and is very snappy. Recommended
-          - ueberzug - backed by ueberzugpp, supports any terminal,
+          by upstream.
+          * `ueberzug` - backed by ueberzugpp, supports any terminal,
             but has lower performance
+          * `sixel` - uses the Sixel graphics protocol, widely supported by many terminals
         '';
       };
 

modules/wrapper/build/config.nix

@@ -22,9 +22,7 @@
       passthru.vimPlugin = false;
     };
 
-  # build a vim plugin with the given name and arguments
+  # Build a Vim plugin with the given name and arguments.
-  # if the plugin is nvim-treesitter, warn the user to use buildTreesitterPlug
-  # instead
   buildPlug = attrs: let
     pin = getPin attrs.pname;
   in
@@ -36,6 +34,7 @@
       // attrs
     );
 
+  # Build a given Treesitter grammar.
   buildTreesitterPlug = grammars: vimPlugins.nvim-treesitter.withPlugins (_: grammars);
 
   pluginBuilders = {
@@ -48,6 +47,9 @@
       doCheck = false;
     };
 
+    # Get plugins built from source from self.packages
+    # If adding a new plugin to be built from source, it must also be inherited
+    # here.
     inherit (inputs.self.packages.${pkgs.stdenv.system}) blink-cmp avante-nvim;
   };
 
@@ -71,29 +73,38 @@
   # Wrap the user's desired (unwrapped) Neovim package with arguments that'll be used to
   # generate a wrapped Neovim package.
   neovim-wrapped = inputs.mnw.lib.wrap {inherit pkgs;} {
+    appName = "nvf";
     neovim = config.vim.package;
+    initLua = config.vim.builtLuaConfigRC;
+    luaFiles = config.vim.extraLuaFiles;
+
+    # Plugin configurations
     plugins = {
       start = buildConfigPlugins config.vim.startPlugins;
       opt = buildConfigPlugins config.vim.optPlugins;
     };
-    appName = "nvf";
+
-    extraBinPath = config.vim.extraPackages;
+    # Providers for Neovim
-    initLua = config.vim.builtLuaConfigRC;
-    luaFiles = config.vim.extraLuaFiles;
     providers = {
+      ruby.enable = config.vim.withRuby;
+      nodeJs.enable = config.vim.withNodeJs;
       python3 = {
         enable = config.vim.withPython3;
         extraPackages = ps: map (flip builtins.getAttr ps) config.vim.python3Packages;
       };
-      ruby.enable = config.vim.withRuby;
-      nodeJs.enable = config.vim.withNodeJs;
     };
+
+    # Aliases to link `nvim` to
     aliases = lib.optional config.vim.viAlias "vi" ++ lib.optional config.vim.vimAlias "vim";
 
+    # Additional packages or Lua packages to be made available to Neovim
+    extraBinPath = config.vim.extraPackages;
     extraLuaPackages = ps: map (flip builtins.getAttr ps) config.vim.luaPackages;
   };
 
+  # A store path representing the built Lua configuration.
   dummyInit = pkgs.writeText "nvf-init.lua" config.vim.builtLuaConfigRC;
+
   # Additional helper scripts for printing and displaying nvf configuration
   # in your commandline.
   printConfig = pkgs.writers.writeDashBin "nvf-print-config" "cat ${dummyInit}";
@@ -106,10 +117,20 @@
     paths = [neovim-wrapped printConfig printConfigPath];
     postBuild = "echo Helpers added";
 
-    # Allow evaluating config.vim, i.e., config.vim from the packages' passthru
+    passthru = {
-    # attribute. For example, packages.x86_64-linux.neovim.passthru.neovimConfig
+      # Allow evaluating config.vim, i.e., config.vim from the packages' passthru
-    # will return the configuration in full.
+      # attribute. For example, packages.x86_64-linux.neovim.passthru.neovimConfig
-    passthru.neovimConfig = config.vim;
+      # will return the configuration in full.
+      neovimConfig = config.vim;
+
+      # Also expose the helper scripts in passthru.
+      nvfPrintConfig = printConfig;
+      nvfPrintConfigPath = printConfigPath;
+
+      # In systems where we only have a package and no module, this can be used
+      # to access the built init.lua
+      initLua = dummyInit;
+    };
 
     meta =
       neovim-wrapped.meta

modules/wrapper/environment/options.nix

@@ -3,7 +3,7 @@
   lib,
   ...
 }: let
-  inherit (lib.options) mkOption mkEnableOption literalMD;
+  inherit (lib.options) mkOption mkEnableOption literalMD literalExpression;
   inherit (lib.types) package bool str listOf attrsOf;
   inherit (lib.nvim.types) pluginsOpt extraPluginType;
 in {
@@ -11,6 +11,7 @@ in {
     package = mkOption {
       type = package;
       default = pkgs.neovim-unwrapped;
+      defaultText = literalExpression "pkgs.neovim-unwrapped";
       description = ''
         The neovim package to use for the wrapper. This
         corresponds to the package that will be wrapped
@@ -27,21 +28,20 @@ in {
     viAlias = mkOption {
       type = bool;
       default = true;
+      example = false;
       description = "Enable the `vi` alias for `nvim`";
     };
 
     vimAlias = mkOption {
       type = bool;
       default = true;
+      example = false;
       description = "Enable the `vim` alias for `nvim`";
     };
 
     startPlugins = pluginsOpt {
       default = ["plenary-nvim"];
-      example = ''
+      example = literalExpression "[pkgs.vimPlugins.telescope-nvim]";
-        [pkgs.vimPlugins.telescope-nvim]
-      '';
-
       description = ''
         List of plugins to load on startup. This is used
         internally to add plugins to Neovim's runtime.
@@ -54,9 +54,7 @@ in {
 
     optPlugins = pluginsOpt {
       default = [];
-      example = ''
+      example = literalExpression "[pkgs.vimPlugins.vim-ghost]";
-        [pkgs.vimPlugins.vim-ghost]
-      '';
       description = ''
         List of plugins to optionally load on startup.
 
@@ -108,7 +106,7 @@ in {
       '';
     };
 
-    # this defaults to `true` in the wrapper
+    # This defaults to `true` in the wrapper
     # and since we pass this value to the wrapper
     # with an inherit, it should be `true` here as well
     withRuby =
@@ -120,14 +118,14 @@ in {
       };
 
     withNodeJs = mkEnableOption ''
-      NodeJs support in the Neovim wrapper
+      NodeJS support in the Neovim wrapper
     '';
 
     luaPackages = mkOption {
       type = listOf str;
       default = [];
       example = ''["magick" "serpent"]'';
-      description = "List of lua packages to install";
+      description = "List of Lua packages to install";
     };
 
     withPython3 = mkEnableOption ''
@@ -144,7 +142,7 @@ in {
     pluginOverrides = mkOption {
       type = attrsOf package;
       default = {};
-      example = ''
+      example = literalExpression ''
         {
           lazydev-nvim = pkgs.fetchFromGitHub {
             owner = "folke";

modules/wrapper/lazy/config.nix

@@ -145,7 +145,7 @@ in {
       ];
 
       lazy.builtLazyConfig = ''
-        require('lz.n').load(${toLuaObject lznSpecs})
+        ${optionalString (length lznSpecs > 0) "require('lz.n').load(${toLuaObject lznSpecs})"}
         ${optionalString cfg.enableLznAutoRequire "require('lzn-auto-require').enable()"}
       '';
     })