From e982955540f0ab091f5eaf9ae5caf92dbed46eb0 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Sat, 20 Apr 2024 23:42:48 +0300 Subject: [PATCH] modules: add documentation comments to internal variables --- configuration.nix | 4 ++- flake/modules/home-manager.nix | 20 ++++++------ flake/modules/nixos.nix | 20 ++++++------ modules/default.nix | 59 ++++++++++++++++++++++++---------- 4 files changed, 63 insertions(+), 40 deletions(-) diff --git a/configuration.nix b/configuration.nix index b0d1331..b0e7baa 100644 --- a/configuration.nix +++ b/configuration.nix @@ -7,9 +7,11 @@ inputs: let lib ? pkgs.lib, check ? true, extraSpecialArgs ? {}, + extraModules ? [], + ... }: modulesWithInputs { - inherit pkgs lib check extraSpecialArgs; + inherit pkgs lib check extraSpecialArgs extraModules; configuration.imports = modules; }; diff --git a/flake/modules/home-manager.nix b/flake/modules/home-manager.nix index 677a39e..e879223 100644 --- a/flake/modules/home-manager.nix +++ b/flake/modules/home-manager.nix @@ -74,16 +74,14 @@ in { }; }; - config = mkIf cfg.enable mkMerge [ - { - programs.neovim-flake.finalPackage = neovimConfigured.neovim; + config = mkIf cfg.enable { + programs.neovim-flake.finalPackage = neovimConfigured.neovim-wrapped; - home = { - sessionVariables.EDITOR = mkIf cfg.defaultEditor (lib.mkOverride 900 "nvim"); - packages = - [cfg.finalPackage] - ++ optionals cfg.enableManpages packages.${pkgs.stdenv.system}.docs-manpages; - }; - } - ]; + home = { + sessionVariables.EDITOR = mkIf cfg.defaultEditor (lib.mkOverride 900 "nvim"); + packages = + [cfg.finalPackage] + ++ optionals cfg.enableManpages packages.${pkgs.stdenv.system}.docs-manpages; + }; + }; } diff --git a/flake/modules/nixos.nix b/flake/modules/nixos.nix index a41e3b6..226175f 100644 --- a/flake/modules/nixos.nix +++ b/flake/modules/nixos.nix @@ -74,16 +74,14 @@ in { }; }; - config = mkIf cfg.enable mkMerge [ - { - programs.neovim-flake.finalPackage = neovimConfigured.neovim; + config = mkIf cfg.enable { + programs.neovim-flake.finalPackage = neovimConfigured.neovim-wrapped; - environment = { - variables.EDITOR = mkIf cfg.defaultEditor (lib.mkOverride 900 "nvim"); - systemPackages = - [cfg.finalPackage] - ++ optionals cfg.enableManpages packages.${pkgs.stdenv.system}.docs-manpages; - }; - } - ]; + environment = { + variables.EDITOR = mkIf cfg.defaultEditor (lib.mkOverride 900 "nvim"); + systemPackages = + [cfg.finalPackage] + ++ optionals cfg.enableManpages packages.${pkgs.stdenv.system}.docs-manpages; + }; + }; } diff --git a/modules/default.nix b/modules/default.nix index 17e8ba1..ee3f1fa 100644 --- a/modules/default.nix +++ b/modules/default.nix @@ -4,30 +4,43 @@ inputs: { lib ? pkgs.lib, check ? true, extraSpecialArgs ? {}, + extraModules ? [], }: let inherit (builtins) map filter isString toString getAttr; inherit (pkgs) wrapNeovimUnstable vimPlugins; inherit (pkgs.vimUtils) buildVimPlugin; inherit (pkgs.neovimUtils) makeNeovimConfig; + inherit (lib.lists) concatLists; inherit (lib.attrsets) recursiveUpdate; inherit (lib.asserts) assertMsg; + # call the extedended library with `lib` and `inputs` as arguments + # lib is used to provide the standard library functions to the extended library + # but it can be overridden while this file is being called + # inputs is used to pass inputs to the plugin autodiscovery function extendedLib = import ../lib/stdlib-extended.nix lib inputs; + # import modules.nix with `check`, `pkgs` and `lib` as arguments + # check can be disabled while calling this file is called + # to avoid checking in all modules nvimModules = import ./modules.nix { inherit check pkgs; lib = extendedLib; }; + # evaluate the extended library with the modules + # optionally with any additional modules passed by the user module = extendedLib.evalModules { - modules = [configuration] ++ nvimModules; specialArgs = recursiveUpdate {modulesPath = toString ./.;} extraSpecialArgs; + modules = concatLists [[configuration] nvimModules extraModules]; }; + # alias to the internal configuration vimOptions = module.config.vim; - extraLuaPackages = ps: map (x: ps.${x}) vimOptions.luaPackages; - + # build a vim plugin with the given name and arguments + # if the plugin is nvim-treesitter, warn the user to use buildTreesitterPlug + # instead buildPlug = {pname, ...} @ args: assert assertMsg (pname != "nvim-treesitter") "Use buildTreesitterPlug for building nvim-treesitter."; buildVimPlugin (args @@ -60,24 +73,36 @@ inputs: { (f: f != null) plugins); - plugins = - (buildConfigPlugins vimOptions.startPlugins) - ++ (map (package: { - plugin = package; - optional = false; - }) - (buildConfigPlugins - vimOptions.optPlugins)); + # built (or "normalized") plugins that are modified + builtStartPlugins = buildConfigPlugins vimOptions.startPlugins; + builtOptPlugins = map (package: { + plugin = package; + optional = false; + }) (buildConfigPlugins vimOptions.optPlugins); - neovim = wrapNeovimUnstable vimOptions.package (makeNeovimConfig { - inherit (vimOptions) viAlias; - inherit (vimOptions) vimAlias; - inherit extraLuaPackages; - inherit plugins; + plugins = builtStartPlugins ++ builtOptPlugins; + + extraLuaPackages = ps: map (x: ps.${x}) vimOptions.luaPackages; + + # wrap user's desired neovim package using the neovim wrapper from nixpkgs + # the wrapper takes the following arguments: + # - withPython (bool) + # - extraPython3Packages (lambda) + # - withNodeJs (bool) + # - withRuby (bool) + # - extraLuaPackages (lambda) + # - plugins (list) + # - customRC (string) + # and returns the wrapped package + neovim-wrapped = wrapNeovimUnstable vimOptions.package (makeNeovimConfig { + inherit (vimOptions) viAlias vimAlias; + inherit plugins extraLuaPackages; customRC = vimOptions.builtConfigRC; }); in { inherit (module) options config; inherit (module._module.args) pkgs; - inherit neovim; + + # expose wrapped neovim-package + neovim = neovim-wrapped; }