Merge branch 'main' into more-option-stuff

modules/wrapper/build/config.nix

@@ -1,13 +1,116 @@
 {
-  config,
+  inputs,
   lib,
+  config,
+  pkgs,
   ...
-}: let
-  inherit (lib.attrsets) attrValues;
+}
+: let
+  inherit (pkgs) vimPlugins;
+  inherit (lib.strings) isString;
+  inherit (lib.lists) filter map;
+  inherit (builtins) path;
 
-  cfg = config.vim;
+  # alias to the internal configuration
+  vimOptions = config.vim;
+
+  noBuildPlug = pname: let
+    input = inputs."plugin-${pname}";
+    version = input.shortRev or input.shortDirtyRev or "dirty";
+  in {
+    # vim.lazy.plugins relies on pname, so we only set that here
+    # version isn't needed for anything, but inherit it anyway for correctness
+    inherit pname version;
+    outPath = path {
+      name = "${pname}-0-unstable-${version}";
+      path = input.outPath;
+    };
+    passthru.vimPlugin = false;
+  };
+
+  # 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
+    input = inputs."plugin-${attrs.pname}";
+  in
+    pkgs.vimUtils.buildVimPlugin (
+      {
+        version = input.shortRev or input.shortDirtyRev or "dirty";
+        src = input.outPath;
+      }
+      // attrs
+    );
+
+  buildTreesitterPlug = grammars: vimPlugins.nvim-treesitter.withPlugins (_: grammars);
+
+  pluginBuilders = {
+    nvim-treesitter = buildTreesitterPlug vimOptions.treesitter.grammars;
+    flutter-tools-patched = buildPlug {
+      pname = "flutter-tools";
+      patches = [./patches/flutter-tools.patch];
+    };
+  };
+
+  buildConfigPlugins = plugins:
+    map (
+      plug:
+        if (isString plug)
+        then pluginBuilders.${plug} or (noBuildPlug plug)
+        else plug
+    ) (filter (f: f != null) plugins);
+
+  # built (or "normalized") plugins that are modified
+  builtStartPlugins = buildConfigPlugins vimOptions.startPlugins;
+  builtOptPlugins = map (package: package // {optional = true;}) (buildConfigPlugins vimOptions.optPlugins);
+
+  # additional Lua and Python3 packages, mapped to their respective functions
+  # to conform to the format mnw expects. end user should
+  # only ever need to pass a list of packages, which are modified
+  # here
+  extraLuaPackages = ps: map (x: ps.${x}) vimOptions.luaPackages;
+  extraPython3Packages = ps: map (x: ps.${x}) vimOptions.python3Packages;
+
+  # 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 pkgs {
+    neovim = vimOptions.package;
+    plugins = builtStartPlugins ++ builtOptPlugins;
+    appName = "nvf";
+    extraBinPath = vimOptions.extraPackages;
+    initLua = vimOptions.builtLuaConfigRC;
+    luaFiles = vimOptions.extraLuaFiles;
+
+    inherit (vimOptions) viAlias vimAlias withRuby withNodeJs withPython3;
+    inherit extraLuaPackages extraPython3Packages;
+  };
+
+  dummyInit = pkgs.writeText "nvf-init.lua" vimOptions.builtLuaConfigRC;
+  # Additional helper scripts for printing and displaying nvf configuration
+  # in your commandline.
+  printConfig = pkgs.writers.writeDashBin "nvf-print-config" "cat ${dummyInit}";
+  printConfigPath = pkgs.writers.writeDashBin "nvf-print-config-path" "echo -n ${dummyInit}";
+
+  # Expose wrapped neovim-package for userspace
+  # or module consumption.
+  neovim = pkgs.symlinkJoin {
+    name = "nvf-with-helpers";
+    paths = [neovim-wrapped printConfig printConfigPath];
+    postBuild = "echo Helpers added";
+
+    # Allow evaluating vimOptions, i.e., config.vim from the packages' passthru
+    # attribute. For example, packages.x86_64-linux.neovim.passthru.neovimConfig
+    # will return the configuration in full.
+    passthru.neovimConfig = vimOptions;
+
+    meta =
+      neovim-wrapped.meta
+      // {
+        description = "Wrapped Neovim package with helper scripts to print the config (path)";
+      };
+  };
 in {
-  config = {
-    vim.startPlugins = map (x: x.package) (attrValues cfg.extraPlugins);
+  config.vim.build = {
+    finalPackage = neovim;
   };
 }

modules/wrapper/build/default.nix

@@ -1,6 +1,6 @@
 {
   imports = [
-    ./config.nix
     ./options.nix
+    ./config.nix
   ];
 }

modules/wrapper/build/options.nix

@@ -1,144 +1,12 @@
-{
-  pkgs,
-  lib,
-  ...
-}: let
-  inherit (lib.options) mkOption mkEnableOption literalMD;
-  inherit (lib.types) package bool str listOf attrsOf;
-  inherit (lib.nvim.types) pluginsOpt extraPluginType;
+{lib, ...}: let
+  inherit (lib.types) package;
+  inherit (lib.options) mkOption;
 in {
-  options.vim = {
-    package = mkOption {
+  options.vim.build = {
+    finalPackage = mkOption {
       type = package;
-      default = pkgs.neovim-unwrapped;
-      description = ''
-        The neovim package to use for the wrapper. This
-        corresponds to the package that will be wrapped
-        with your plugins and settings.
-
-        ::: {.warning}
-        You will need to use an unwrapped package for this
-        option to work as intended. Using an already wrapped
-        package here may yield undesirable results.
-        :::
-      '';
-    };
-
-    viAlias = mkOption {
-      type = bool;
-      default = true;
-      description = "Enable the `vi` alias for `nvim`";
-    };
-
-    vimAlias = mkOption {
-      type = bool;
-      default = true;
-      description = "Enable the `vim` alias for `nvim`";
-    };
-
-    startPlugins = pluginsOpt {
-      default = ["plenary-nvim"];
-      example = ''
-        [pkgs.vimPlugins.telescope-nvim]
-      '';
-
-      description = ''
-        List of plugins to load on startup. This is used
-        internally to add plugins to Neovim's runtime.
-
-        To add additional plugins to your configuration, consider
-        using the [{option}`vim.extraPlugins`](#opt-vim.extraPlugins)
-        option.
-      '';
-    };
-
-    optPlugins = pluginsOpt {
-      default = [];
-      example = ''
-        [pkgs.vimPlugins.vim-ghost]
-      '';
-      description = ''
-        List of plugins to optionally load on startup.
-
-        This option has the same type definition as {option}`vim.startPlugins`
-        and plugins in this list are appended to {option}`vim.startPlugins` by
-        the wrapper during the build process.
-
-        To avoid overriding packages and dependencies provided by startPlugins, you
-        are recommended to use this option or {option}`vim.extraPlugins` option.
-      '';
-    };
-
-    extraPlugins = mkOption {
-      type = attrsOf extraPluginType;
-      default = {};
-      description = ''
-        A list of plugins and their configurations that will be
-        set up after builtin plugins.
-
-        This option takes a special type that allows you to order
-        your custom plugins using nvf's modified DAG library.
-      '';
-
-      example = literalMD ''
-        ```nix
-        with pkgs.vimPlugins; {
-          aerial = {
-            package = aerial-nvim;
-            setup = "require('aerial').setup {}";
-          };
-
-          harpoon = {
-            package = harpoon;
-            setup = "require('harpoon').setup {}";
-            after = ["aerial"]; # place harpoon configuration after aerial
-          };
-        }
-        ```
-      '';
-    };
-
-    extraPackages = mkOption {
-      type = listOf package;
-      default = [];
-      example = ''[pkgs.fzf pkgs.ripgrep]'';
-      description = ''
-        List of additional packages to make available to the Neovim
-        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 =
-      mkEnableOption ''
-        Ruby support in the Neovim wrapper.
-      ''
-      // {
-        default = true;
-      };
-
-    withNodeJs = mkEnableOption ''
-      NodeJs support in the Neovim wrapper
-    '';
-
-    luaPackages = mkOption {
-      type = listOf str;
-      default = [];
-      example = ''["magick" "serpent"]'';
-      description = "List of lua packages to install";
-    };
-
-    withPython3 = mkEnableOption ''
-      Python3 support in the Neovim wrapper
-    '';
-
-    python3Packages = mkOption {
-      type = listOf str;
-      default = [];
-      example = ''["pynvim"]'';
-      description = "List of python packages to install";
+      readOnly = true;
+      description = "final output package";
     };
   };
 }

modules/wrapper/build/patches/flutter-tools.patch

@@ -0,0 +1,41 @@
+diff --git a/lua/flutter-tools/executable.lua b/lua/flutter-tools/executable.lua
+index 3807a4f..3345760 100644
+--- a/lua/flutter-tools/executable.lua
++++ b/lua/flutter-tools/executable.lua
+@@ -31,12 +31,12 @@ local function _dart_sdk_root(paths)
+   end
+ 
+   if utils.executable("flutter") then
+-    local flutter_path = fn.resolve(fn.exepath("flutter"))
++    local flutter_path = fn.exepath("flutter")
+     local flutter_bin = fn.fnamemodify(flutter_path, ":h")
+     return path.join(flutter_bin, dart_sdk)
+   end
+ 
+-  if utils.executable("dart") then return fn.resolve(fn.exepath("dart")) end
++  if utils.executable("dart") then return fn.exepath("dart") end
+ 
+   return ""
+ end
+@@ -50,10 +50,10 @@ end
+ ---Get paths for flutter and dart based on the binary locations
+ ---@return table<string, string>
+ local function get_default_binaries()
+-  local flutter_bin = fn.resolve(fn.exepath("flutter"))
++  local flutter_bin = fn.exepath("flutter")
+   return {
+     flutter_bin = flutter_bin,
+-    dart_bin = fn.resolve(fn.exepath("dart")),
++    dart_bin = fn.exepath("dart"),
+     flutter_sdk = _flutter_sdk_root(flutter_bin),
+   }
+ end
+@@ -119,7 +119,7 @@ function M.get(callback)
+   end
+ 
+   if config.flutter_path then
+-    local flutter_path = fn.resolve(config.flutter_path)
++    local flutter_path = config.flutter_path
+     _paths = { flutter_bin = flutter_path, flutter_sdk = _flutter_sdk_root(flutter_path) }
+     _paths.dart_sdk = _dart_sdk_root(_paths)
+     _paths.dart_bin = _flutter_sdk_dart_bin(_paths.flutter_sdk)

modules/wrapper/environment/config.nix

@@ -0,0 +1,13 @@
+{
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib.attrsets) attrValues;
+
+  cfg = config.vim;
+in {
+  config = {
+    vim.startPlugins = map (x: x.package) (attrValues cfg.extraPlugins);
+  };
+}

modules/wrapper/environment/default.nix

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

modules/wrapper/environment/options.nix

@@ -0,0 +1,144 @@
+{
+  pkgs,
+  lib,
+  ...
+}: let
+  inherit (lib.options) mkOption mkEnableOption literalMD;
+  inherit (lib.types) package bool str listOf attrsOf;
+  inherit (lib.nvim.types) pluginsOpt extraPluginType;
+in {
+  options.vim = {
+    package = mkOption {
+      type = package;
+      default = pkgs.neovim-unwrapped;
+      description = ''
+        The neovim package to use for the wrapper. This
+        corresponds to the package that will be wrapped
+        with your plugins and settings.
+
+        ::: {.warning}
+        You will need to use an unwrapped package for this
+        option to work as intended. Using an already wrapped
+        package here may yield undesirable results.
+        :::
+      '';
+    };
+
+    viAlias = mkOption {
+      type = bool;
+      default = true;
+      description = "Enable the `vi` alias for `nvim`";
+    };
+
+    vimAlias = mkOption {
+      type = bool;
+      default = true;
+      description = "Enable the `vim` alias for `nvim`";
+    };
+
+    startPlugins = pluginsOpt {
+      default = ["plenary-nvim"];
+      example = ''
+        [pkgs.vimPlugins.telescope-nvim]
+      '';
+
+      description = ''
+        List of plugins to load on startup. This is used
+        internally to add plugins to Neovim's runtime.
+
+        To add additional plugins to your configuration, consider
+        using the [{option}`vim.extraPlugins`](#opt-vim.extraPlugins)
+        option.
+      '';
+    };
+
+    optPlugins = pluginsOpt {
+      default = [];
+      example = ''
+        [pkgs.vimPlugins.vim-ghost]
+      '';
+      description = ''
+        List of plugins to optionally load on startup.
+
+        This option has the same type definition as {option}`vim.startPlugins`
+        and plugins in this list are appended to {option}`vim.startPlugins` by
+        the wrapper during the build process.
+
+        To avoid overriding packages and dependencies provided by startPlugins, you
+        are recommended to use this option or {option}`vim.extraPlugins` option.
+      '';
+    };
+
+    extraPlugins = mkOption {
+      type = attrsOf extraPluginType;
+      default = {};
+      description = ''
+        A list of plugins and their configurations that will be
+        set up after builtin plugins.
+
+        This option takes a special type that allows you to order
+        your custom plugins using nvf's modified DAG library.
+      '';
+
+      example = literalMD ''
+        ```nix
+        with pkgs.vimPlugins; {
+          aerial = {
+            package = aerial-nvim;
+            setup = "require('aerial').setup {}";
+          };
+
+          harpoon = {
+            package = harpoon;
+            setup = "require('harpoon').setup {}";
+            after = ["aerial"]; # place harpoon configuration after aerial
+          };
+        }
+        ```
+      '';
+    };
+
+    extraPackages = mkOption {
+      type = listOf package;
+      default = [];
+      example = ''[pkgs.fzf pkgs.ripgrep]'';
+      description = ''
+        List of additional packages to make available to the Neovim
+        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 =
+      mkEnableOption ''
+        Ruby support in the Neovim wrapper.
+      ''
+      // {
+        default = true;
+      };
+
+    withNodeJs = mkEnableOption ''
+      NodeJs support in the Neovim wrapper
+    '';
+
+    luaPackages = mkOption {
+      type = listOf str;
+      default = [];
+      example = ''["magick" "serpent"]'';
+      description = "List of lua packages to install";
+    };
+
+    withPython3 = mkEnableOption ''
+      Python3 support in the Neovim wrapper
+    '';
+
+    python3Packages = mkOption {
+      type = listOf str;
+      default = [];
+      example = ''["pynvim"]'';
+      description = "List of python packages to install";
+    };
+  };
+}

modules/wrapper/lazy/config.nix

@@ -76,6 +76,7 @@
         else
           mkLuaInline ''
             function()
+              ${optionalString (spec.beforeSetup != null) spec.beforeSetup}
               ${
               optionalString (spec.setupModule != null)
               "require(${toJSON spec.setupModule}).setup(${toLuaObject spec.setupOpts})"

modules/wrapper/lazy/lazy.nix

@@ -74,6 +74,15 @@
         '';
       };
 
+      beforeSetup = mkOption {
+        type = nullOr lines;
+        default = null;
+        description = ''
+          Lua code to run after the plugin is loaded, but before the setup
+          function is called.
+        '';
+      };
+
       setupModule = mkOption {
         type = nullOr str;
         default = null;

modules/wrapper/rc/options.nix

@@ -143,16 +143,14 @@ in {
 
       example = {"some_variable" = 42;};
       description = ''
-        An attribute set containing global variable values
-        for storing vim variables as early as possible. If
-        populated, this option will set vim variables in the
-        built luaConfigRC as the first item.
+        A freeform attribute set containing global variable values for setting vim
+        variables as early as possible. If populated, this option will set vim variables
+        in the built {option}`luaConfigRC` as the first item.
 
         ::: {.note}
-        `{foo = "bar";}` will set `vim.g.foo` to "bar", where
-        the type of `bar` in the resulting Lua value will be
-        inferred from the type of the value in the `{name = value;}`
-        pair passed to the option.
+        `{foo = "bar";}` will set `vim.g.foo` to "bar", where the type of `bar` in the
+        resulting Lua value will be inferred from the type of the value in the
+        `{name = value;}` pair passed to the option.
         :::
       '';
     };
@@ -237,23 +235,40 @@ in {
               if isBool x
               then toVimBool x # convert to a yes/no str
               else x;
-            description = "Show the sign column";
+            description = "Show the sign column"
+
+          tabstop = mkOption {
+            type = int;
+            default = 8; # Neovim default
+            description = ''
+              Number of spaces that a `<Tab>` in the file counts for. Also see
+              the {command}`:retab` command, and the {option}`softtabstop` option.
+            '';
+          };
+
+          shiftwidth = mkOption {
+            type = int;
+            default = 8; # Neovim default
+            description = ''
+              Number of spaces to use for each step of (auto)indent. Used for
+              {option}`cindent`, `>>`, `<<`, etc.
+
+              When zero the {option}`tabstop` value will be used.
+            '';
           };
         };
       };
 
       example = {visualbell = true;};
       description = ''
-        An attribute set containing vim options to be set
-        as early as possible. If populated, this option will
-        set vim options in the built luaConfigRC after `basic`
-        and before `pluginConfigs` DAG entries.
+        A freeform attribute set containing vim options to be set as early as possible.
+        If populated, this option will set vim options in the built {option}`luaConfigRC`
+        after `basic` and before `pluginConfigs` DAG entries.
 
         ::: {.note}
-        `{foo = "bar";}` will set `vim.o.foo` to "bar", where
-        the type of `bar` in the resulting Lua value will be
-        inferred from the type of the value in the`{name = value;}`
-        pair passed to the option.
+        `{foo = "bar";}` will set `vim.o.foo` to "bar", where the type of `bar` in the
+        resulting Lua value will be inferred from the type of the value in the
+        `{name = value;}` pair passed to the option.
         :::
       '';
     };