modules: move local functions to extended library

lib/build.nix

@@ -0,0 +1,15 @@
+{
+  # TODO: give those section indicators
+  # maybe using mkSection?
+  wrapLuaConfig = {
+    luaConfigBefore,
+    luaConfig,
+    luaConfigAfter,
+  }: ''
+    lua << EOF
+    ${luaConfigBefore}
+    ${luaConfig}
+    ${luaConfigAfter}
+    EOF
+  '';
+}

lib/dag.nix

@@ -126,4 +126,10 @@ in {
       else abort ("Dependency cycle in ${name}: " + toJSON sortedDag);
   in
     result;
+
+  # Create a section in the final output
+  mkSection = section: ''
+    -- SECTION: ${section.name}
+    ${section.data}
+  '';
 }

modules/core/build/default.nix

@@ -1,28 +1,20 @@
 {
   config,
-  pkgs,
   lib,
   ...
 }: let
   inherit (builtins) attrValues attrNames map mapAttrs concatStringsSep filter;
-  inherit (lib) mkOption types mapAttrsFlatten filterAttrs optionalString getAttrs literalExpression;
+  inherit (lib) types;
-  inherit (lib) nvim;
+  inherit (lib.attrsets) mapAttrsFlatten filterAttrs getAttrs;
-  inherit (nvim.lua) toLuaObject;
+  inherit (lib.options) mkOption;
-  inherit (nvim.vim) valToVim;
+  inherit (lib.nvim.lua) toLuaObject;
-  inherit (nvim.bool) mkBool;
+  inherit (lib.nvim.build) wrapLuaConfig;
-  inherit (nvim.dag) resolveDag;
+  inherit (lib.nvim.vim) valToVim;
+  inherit (lib.nvim.bool) mkBool;
+  inherit (lib.nvim.dag) resolveDag mkSection entryAnywhere entryAfter;
 
   cfg = config.vim;
 
-  wrapLuaConfig = luaConfig: ''
-    lua << EOF
-    ${optionalString cfg.enableLuaLoader ''
-      vim.loader.enable()
-    ''}
-    ${luaConfig}
-    EOF
-  '';
-
   # Most of the keybindings code is highly inspired by pta2002/nixvim. Thank you!
   mapConfigOptions = {
     silent =
@@ -90,95 +82,7 @@
       })
       maps);
 in {
-  options = {
+  imports = [./options.nix];
-    vim = {
-      package = mkOption {
-        type = types.package;
-        default = pkgs.neovim-unwrapped;
-        description = ''
-          The neovim package to use. You will need to use an unwrapped package for this option to work as intended.
-        '';
-      };
-
-      viAlias = mkOption {
-        description = "Enable vi alias";
-        type = types.bool;
-        default = true;
-      };
-
-      vimAlias = mkOption {
-        description = "Enable vim alias";
-        type = types.bool;
-        default = true;
-      };
-
-      configRC = mkOption {
-        description = "vimrc contents";
-        type = types.oneOf [(nvim.types.dagOf types.lines) types.str];
-        default = {};
-      };
-
-      luaConfigRC = mkOption {
-        description = "vim lua config";
-        type = types.oneOf [(nvim.types.dagOf types.lines) types.str];
-        default = {};
-      };
-
-      builtConfigRC = mkOption {
-        internal = true;
-        type = types.lines;
-        description = "The built config for neovim after resolving the DAG";
-      };
-
-      startPlugins = nvim.types.pluginsOpt {
-        default = [];
-        description = "List of plugins to startup.";
-      };
-
-      optPlugins = nvim.types.pluginsOpt {
-        default = [];
-        description = "List of plugins to optionally load";
-      };
-
-      extraPlugins = mkOption {
-        type = types.attrsOf nvim.types.extraPluginType;
-        default = {};
-        description = ''
-          List of plugins and related config.
-          Note that these are setup after builtin plugins.
-        '';
-        example = literalExpression ''
-          with pkgs.vimPlugins; {
-            aerial = {
-              package = aerial-nvim;
-              setup = "require('aerial').setup {}";
-            };
-
-            harpoon = {
-              package = harpoon;
-              setup = "require('harpoon').setup {}";
-              after = ["aerial"];
-            };
-          }
-        '';
-      };
-
-      luaPackages = mkOption {
-        type = types.listOf types.str;
-        default = [];
-        description = ''
-          List of lua packages to install.
-        '';
-      };
-
-      globals = mkOption {
-        default = {};
-        description = "Set containing global variable values";
-        type = types.attrs;
-      };
-    };
-  };
-
   config = let
     globalsScript =
       mapAttrsFlatten (name: value: "let g:${name}=${valToVim value}")
@@ -205,17 +109,12 @@ in {
     omap = toLuaBindings "o" config.vim.maps.operator;
     icmap = toLuaBindings "ic" config.vim.maps.insertCommand;
 
-    mkSection = r: ''
-      -- SECTION: ${r.name}
-      ${r.data}
-    '';
-
     mapResult = r: (wrapLuaConfig (concatStringsSep "\n" (map mkSection r)));
   in {
     vim = {
       startPlugins = map (x: x.package) (attrValues cfg.extraPlugins);
       configRC = {
-        globalsScript = nvim.dag.entryAnywhere (concatStringsSep "\n" globalsScript);
+        globalsScript = entryAnywhere (concatStringsSep "\n" globalsScript);
 
         luaScript = let
           luaConfig = resolveDag {
@@ -224,7 +123,7 @@ in {
             inherit mapResult;
           };
         in
-          nvim.dag.entryAfter ["globalsScript"] luaConfig;
+          entryAfter ["globalsScript"] luaConfig;
 
         extraPluginConfigs = let
           extraPluginsDag = mapAttrs (_: {
@@ -232,7 +131,7 @@ in {
             setup,
             ...
           }:
-            nvim.dag.entryAfter after setup)
+            entryAfter after setup)
           cfg.extraPlugins;
 
           pluginConfig = resolveDag {
@@ -241,7 +140,7 @@ in {
             inherit mapResult;
           };
         in
-          nvim.dag.entryAfter ["luaScript"] pluginConfig;
+          entryAfter ["luaScript"] pluginConfig;
 
         # This is probably not the right way to set the config. I'm not sure how it should look like.
         mappings = let
@@ -260,7 +159,7 @@ in {
           ];
           mapConfig = wrapLuaConfig (concatStringsSep "\n" (map (v: concatStringsSep "\n" v) maps));
         in
-          nvim.dag.entryAfter ["globalsScript"] mapConfig;
+          entryAfter ["globalsScript"] mapConfig;
       };
 
       builtConfigRC = let
@@ -271,11 +170,8 @@ in {
           then throw "\nFailed assertions:\n${concatStringsSep "\n" (map (x: "- ${x}") failedAssertions)}"
           else lib.showWarnings config.warnings;
 
-        mkSection = r: ''
-          " SECTION: ${r.name}
-          ${r.data}
-        '';
         mapResult = r: (concatStringsSep "\n" (map mkSection r));
+
         vimConfig = resolveDag {
           name = "vim config script";
           dag = cfg.configRC;

modules/core/build/options.nix

@@ -34,12 +34,24 @@ in {
       default = {};
     };
 
+    prependLuaConfigRC = mkOption {
+      description = "vim lua config";
+      type = oneOf [(dagOf lines) str];
+      default = {};
+    };
+
     luaConfigRC = mkOption {
       description = "vim lua config";
       type = oneOf [(dagOf lines) str];
       default = {};
     };
 
+    appendLuaConfigRC = mkOption {
+      description = "vim lua config";
+      type = oneOf [(dagOf lines) str];
+      default = {};
+    };
+
     builtConfigRC = mkOption {
       internal = true;
       type = lines;

modules/neovim/basic/options.nix

@@ -7,21 +7,6 @@
   inherit (lib.types) types;
 in {
   options.vim = {
-    debugMode = {
-      enable = mkEnableOption "debug mode";
-      level = mkOption {
-        type = types.int;
-        default = 20;
-        description = "Set the debug level";
-      };
-
-      logFile = mkOption {
-        type = types.path;
-        default = "/tmp/nvim.log";
-        description = "Set the log file";
-      };
-    };
-
     enableLuaLoader = mkEnableOption "experimental Lua module loader to speed up the start up process";
 
     leaderKey = mkOption {
@@ -178,5 +163,20 @@ in {
       default = "sensitive";
       description = "Set the case sensitivity of search";
     };
+
+    debugMode = {
+      enable = mkEnableOption "debug mode";
+      level = mkOption {
+        type = types.int;
+        default = 20;
+        description = "Set the debug level";
+      };
+
+      logFile = mkOption {
+        type = types.path;
+        default = "/tmp/nvim.log";
+        description = "Set the log file";
+      };
+    };
   };
 }

modules/visuals/fidget/fidget.nix

@@ -1,393 +0,0 @@
-{
-  config,
-  lib,
-  ...
-}: let
-  inherit (lib) mkRemovedOptionModule mkEnableOption mkOption mapAttrs toUpper nvim types mkRenamedOptionModule;
-  rawLua = lua: {__raw = lua;};
-in {
-  imports = [
-    (mkRenamedOptionModule ["vim" "visuals" "fidget-nvim" "align" "bottom"] ["vim" "visuals" "fidget-nvim" "setupOpts" "notification" "window" "align"])
-    (mkRemovedOptionModule ["vim" "visuals" "fidget-nvim" "align" "right"]
-      "Option `vim.fidget-nvim.align.right` has been removed and does not have an equivalent replacement in rewritten fidget.nvim configuration.")
-  ];
-
-  options.vim.visuals.fidget-nvim = {
-    enable = mkEnableOption "nvim LSP UI element [fidget-nvim]";
-
-    setupOpts = nvim.types.mkPluginSetupOption "Fidget" {
-      progress = {
-        poll_rate = mkOption {
-          description = "How frequently to poll for LSP progress messages";
-          type = types.int;
-          default = 0;
-        };
-        suppress_on_insert = mkOption {
-          description = "Suppress new messages when in insert mode";
-          type = types.bool;
-          default = false;
-        };
-        ignore_done_already = mkOption {
-          description = "Ignore new tasks that are already done";
-          type = types.bool;
-          default = false;
-        };
-        ignore_empty_message = mkOption {
-          description = "Ignore new tasks with empty messages";
-          type = types.bool;
-          default = false;
-        };
-        clear_on_detach = mkOption {
-          description = "Clear notification group when LSP server detaches";
-          type = types.bool;
-          default = true;
-          apply = clear:
-            if clear
-            then
-              rawLua ''
-                function(client_id)
-                  local client = vim.lsp.get_client_by_id(client_id)
-                  return client and client.name or nil
-                end
-              ''
-            else null;
-        };
-        notification_group = mkOption {
-          description = "How to get a progress message's notification group key";
-          type = types.str;
-          default = ''
-            function(msg)
-              return msg.lsp_client.name
-            end
-          '';
-          apply = rawLua;
-        };
-        ignore = mkOption {
-          description = "Ignore LSP servers by name";
-          type = types.listOf types.str;
-          default = [];
-        };
-
-        display = {
-          render_limit = mkOption {
-            description = "Maximum number of messages to render";
-            type = types.int;
-            default = 16;
-          };
-          done_ttl = mkOption {
-            description = "How long a message should persist when complete";
-            type = types.int;
-            default = 3;
-          };
-          done_icon = mkOption {
-            description = "Icon shown when LSP progress tasks are completed";
-            type = types.str;
-            default = "✓";
-          };
-          done_style = mkOption {
-            description = "Highlight group for completed LSP tasks";
-            type = types.str;
-            default = "Constant";
-          };
-          progress_ttl = mkOption {
-            description = "How long a message should persist when in progress";
-            type = types.int;
-            default = 99999;
-          };
-          progress_icon = {
-            pattern = mkOption {
-              description = "Pattern shown when LSP progress tasks are in progress";
-              type = types.enum [
-                "dots"
-                "dots_negative"
-                "dots_snake"
-                "dots_footsteps"
-                "dots_hop"
-                "line"
-                "pipe"
-                "dots_ellipsis"
-                "dots_scrolling"
-                "star"
-                "flip"
-                "hamburger"
-                "grow_vertical"
-                "grow_horizontal"
-                "noise"
-                "dots_bounce"
-                "triangle"
-                "arc"
-                "circle"
-                "square_corners"
-                "circle_quarters"
-                "circle_halves"
-                "dots_toggle"
-                "box_toggle"
-                "arrow"
-                "zip"
-                "bouncing_bar"
-                "bouncing_ball"
-                "clock"
-                "earth"
-                "moon"
-                "dots_pulse"
-                "meter"
-              ];
-              default = "dots";
-            };
-            period = mkOption {
-              description = "Period of the pattern";
-              type = types.int;
-              default = 1;
-            };
-          };
-          progress_style = mkOption {
-            description = "Highlight group for in-progress LSP tasks";
-            type = types.str;
-            default = "WarningMsg";
-          };
-          group_style = mkOption {
-            description = "Highlight group for group name (LSP server name)";
-            type = types.str;
-            default = "Title";
-          };
-          icon_style = mkOption {
-            description = "Highlight group for group icons";
-            type = types.str;
-            default = "Question";
-          };
-          priority = mkOption {
-            description = "Priority of the progress notification";
-            type = types.int;
-            default = 30;
-          };
-          skip_history = mkOption {
-            description = "Skip adding messages to history";
-            type = types.bool;
-            default = true;
-          };
-          format_message = mkOption {
-            description = "How to format a progress message";
-            type = types.str;
-            default = ''
-              require("fidget.progress.display").default_format_message
-            '';
-            apply = rawLua;
-          };
-          format_annote = mkOption {
-            description = "How to format a progress annotation";
-            type = types.str;
-            default = ''
-              function(msg) return msg.title end
-            '';
-            apply = rawLua;
-          };
-          format_group_name = mkOption {
-            description = "How to format a progress notification group's name";
-            type = types.str;
-            default = ''
-              function(group) return tostring(group) end
-            '';
-            apply = rawLua;
-          };
-          overrides = mkOption {
-            description = "Override options from the default notification config";
-            type = types.attrsOf types.str;
-            default = {rust_analyzer = "{ name = 'rust-analyzer' }";};
-            apply = mapAttrs (key: lua: rawLua lua);
-          };
-        };
-
-        lsp = {
-          progress_ringbuf_size = mkOption {
-            description = "Nvim's LSP client ring buffer size";
-            type = types.int;
-            default = 100;
-          };
-          log_handler = mkOption {
-            description = "Log `$/progress` handler invocations";
-            type = types.bool;
-            default = false;
-          };
-        };
-      };
-
-      notification = {
-        poll_rate = mkOption {
-          description = "How frequently to update and render notifications";
-          type = types.int;
-          default = 10;
-        };
-        filter = mkOption {
-          description = "Minimum notifications level";
-          type = types.enum ["debug" "info" "warn" "error"];
-          default = "info";
-          apply = filter: rawLua "vim.log.levels.${toUpper filter}";
-        };
-        history_size = mkOption {
-          description = "Number of removed messages to retain in history";
-          type = types.int;
-          default = 128;
-        };
-        override_vim_notify = mkOption {
-          description = "Automatically override vim.notify() with Fidget";
-          type = types.bool;
-          default = false;
-        };
-        configs = mkOption {
-          description = "How to configure notification groups when instantiated";
-          type = types.attrsOf types.str;
-          default = {default = "require('fidget.notification').default_config";};
-          apply = mapAttrs (key: lua: rawLua lua);
-        };
-        redirect = mkOption {
-          description = "Conditionally redirect notifications to another backend";
-          type = types.str;
-          default = ''
-            function(msg, level, opts)
-              if opts and opts.on_open then
-                return require("fidget.integration.nvim-notify").delegate(msg, level, opts)
-              end
-            end
-          '';
-          apply = rawLua;
-        };
-
-        view = {
-          stack_upwards = mkOption {
-            description = "Display notification items from bottom to top";
-            type = types.bool;
-            default = true;
-          };
-          icon_separator = mkOption {
-            description = "Separator between group name and icon";
-            type = types.str;
-            default = " ";
-          };
-          group_separator = mkOption {
-            description = "Separator between notification groups";
-            type = types.str;
-            default = "---";
-          };
-          group_separator_hl = mkOption {
-            description = "Highlight group used for group separator";
-            type = types.str;
-            default = "Comment";
-          };
-          render_message = mkOption {
-            description = "How to render notification messages";
-            type = types.str;
-            default = ''
-              function(msg, cnt)
-                return cnt == 1 and msg or string.format("(%dx) %s", cnt, msg)
-              end
-            '';
-            apply = rawLua;
-          };
-        };
-
-        window = {
-          normal_hl = mkOption {
-            description = "Base highlight group in the notification window";
-            type = types.str;
-            default = "Comment";
-          };
-          winblend = mkOption {
-            description = "Background color opacity in the notification window";
-            type = types.int;
-            default = 100;
-          };
-          border = mkOption {
-            description = "Border style of the notification window";
-            type = types.enum ["none" "single" "double" "rounded" "solid" "shadow"];
-            default =
-              if config.vim.ui.borders.enable
-              then config.vim.ui.borders.globalStyle
-              else "none";
-          };
-          zindex = mkOption {
-            description = "Stacking priority of the notification window";
-            type = types.int;
-            default = 45;
-          };
-          max_width = mkOption {
-            description = "Maximum width of the notification window";
-            type = types.int;
-            default = 0;
-          };
-          max_height = mkOption {
-            description = "Maximum height of the notification window";
-            type = types.int;
-            default = 0;
-          };
-          x_padding = mkOption {
-            description = "Padding from right edge of window boundary";
-            type = types.int;
-            default = 1;
-          };
-          y_padding = mkOption {
-            description = "Padding from bottom edge of window boundary";
-            type = types.int;
-            default = 0;
-          };
-          align = mkOption {
-            description = "How to align the notification window";
-            type = types.enum ["top" "bottom"];
-            default = "bottom";
-          };
-          relative = mkOption {
-            description = "What the notification window position is relative to";
-            type = types.enum ["editor" "win"];
-            default = "editor";
-          };
-        };
-      };
-
-      integration = {
-        nvim-tree = {
-          enable = mkOption {
-            description = "Integrate with nvim-tree/nvim-tree.lua (if enabled)";
-            type = types.bool;
-            default =
-              if config.vim.filetree.nvimTree.enable
-              then true
-              else false;
-          };
-        };
-        xcodebuild-nvim = {
-          enable = mkOption {
-            description = "Integrate with wojciech-kulik/xcodebuild.nvim (if enabled)";
-            type = types.bool;
-            default = true;
-          };
-        };
-      };
-
-      logger = {
-        level = mkOption {
-          description = "Minimum logging level";
-          type = types.enum ["debug" "error" "info" "trace" "warn" "off"];
-          default = "warn";
-          apply = logLevel: rawLua "vim.log.levels.${toUpper logLevel}";
-        };
-        max_size = mkOption {
-          description = "Maximum log file size, in KB";
-          type = types.int;
-          default = 10000;
-        };
-        float_precision = mkOption {
-          description = "Limit the number of decimals displayed for floats";
-          type = types.float;
-          default = 0.01;
-        };
-        path = mkOption {
-          description = "Where Fidget writes its logs to";
-          type = types.str;
-          default = ''
-            string.format("%s/fidget.nvim.log", vim.fn.stdpath("cache"))
-          '';
-          apply = rawLua;
-        };
-      };
-    };
-  };
-}