From 7c66ea2e0529dfc546bd75df4b215cbe931430f6 Mon Sep 17 00:00:00 2001
From: NotAShelf <raf@notashelf.dev>
Date: Mon, 19 Feb 2024 13:09:35 +0300
Subject: [PATCH] modules: add comments; formatting

---
 modules/core/mappings/default.nix | 14 +++++------
 modules/default.nix               | 14 ++++++++---
 modules/modules.nix               | 40 ++++++++++++++++---------------
 modules/neovim/default.nix        |  5 ----
 4 files changed, 39 insertions(+), 34 deletions(-)
 delete mode 100644 modules/neovim/default.nix

diff --git a/modules/core/mappings/default.nix b/modules/core/mappings/default.nix
index f9b3f823..dfc0ddac 100644
--- a/modules/core/mappings/default.nix
+++ b/modules/core/mappings/default.nix
@@ -1,32 +1,32 @@
 {lib, ...}: let
   inherit (lib) mkOption types;
   inherit (lib) nvim;
-  inherit (nvim.bool) mkBool;
+  inherit (nvim.modules) mkBoolOption;
 
   # Most of the keybindings code is highly inspired by pta2002/nixvim. Thank you!
   mapConfigOptions = {
     silent =
-      mkBool false
+      mkBoolOption false
       "Whether this mapping should be silent. Equivalent to adding <silent> to a map.";
 
     nowait =
-      mkBool false
+      mkBoolOption false
       "Whether to wait for extra input on ambiguous mappings. Equivalent to adding <nowait> to a map.";
 
     script =
-      mkBool false
+      mkBoolOption false
       "Equivalent to adding <script> to a map.";
 
     expr =
-      mkBool false
+      mkBoolOption false
       "Means that the action is actually an expression. Equivalent to adding <expr> to a map.";
 
     unique =
-      mkBool false
+      mkBoolOption false
       "Whether to fail if the map is already defined. Equivalent to adding <unique> to a map.";
 
     noremap =
-      mkBool true
+      mkBoolOption true
       "Whether to use the 'noremap' variant of the command, ignoring any custom mappings on the defined action. It is highly advised to keep this on, which is the default.";
 
     desc = mkOption {
diff --git a/modules/default.nix b/modules/default.nix
index c9703b90..1b46ba23 100644
--- a/modules/default.nix
+++ b/modules/default.nix
@@ -6,11 +6,12 @@ inputs: {
   extraSpecialArgs ? {},
 }: let
   inherit (builtins) map filter isString toString getAttr;
-  inherit (pkgs) wrapNeovim vimPlugins;
-  inherit (pkgs.vimUtils) buildVimPlugin;
+  inherit (lib.asserts) assertMsg;
 
+  # extend nixpkgs.lib with our own set of functions
   extendedLib = import ../lib/stdlib-extended.nix lib;
 
+  # define neovim modules that will be used to configure neovim
   nvimModules = import ./modules.nix {
     inherit check pkgs;
     lib = extendedLib;
@@ -23,10 +24,13 @@ inputs: {
 
   vimOptions = module.config.vim;
 
+  inherit (pkgs) wrapNeovim vimPlugins;
+  inherit (pkgs.vimUtils) buildVimPlugin;
+
   extraLuaPackages = ps: map (x: ps.${x}) vimOptions.luaPackages;
 
   buildPlug = {pname, ...} @ args:
-    assert lib.asserts.assertMsg (pname != "nvim-treesitter") "Use buildTreesitterPlug for building nvim-treesitter.";
+    assert assertMsg (pname != "nvim-treesitter") "Use buildTreesitterPlug for building nvim-treesitter.";
       buildVimPlugin (args
         // {
           version = "master";
@@ -57,6 +61,10 @@ inputs: {
       (f: f != null)
       plugins);
 
+  # configure the neovim wrapper
+  # for details on how to use the wrapper, see:
+  # - https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/neovim/wrapper.nix
+  # - https://github.com/NixOS/nixpkgs/blob/master/pkgs/applications/editors/neovim/utils.nix
   neovim = wrapNeovim vimOptions.package {
     inherit (vimOptions) viAlias;
     inherit (vimOptions) vimAlias;
diff --git a/modules/modules.nix b/modules/modules.nix
index dc38621b..f69ba829 100644
--- a/modules/modules.nix
+++ b/modules/modules.nix
@@ -8,31 +8,33 @@
   inherit (lib.lists) concatLists;
 
   # map each plugin from our plugins module into a list
+  # while adding a new parent module, it needs to be added
+  # here by name before it can be evaluated
   plugins = map (p: ./plugins + "/${p}") [
+    "assistant"
+    "autopairs"
+    "comments"
     "completion"
-    "theme"
+    "dashboard"
+    "debugger"
+    "filetree"
+    "git"
+    "languages"
+    "lsp"
+    "minimap"
+    "notes"
+    "projects"
+    "rich-presence"
+    "session"
+    "snippets"
     "statusline"
     "tabline"
-    "filetree"
-    "visuals"
-    "lsp"
-    "treesitter"
-    "autopairs"
-    "snippets"
-    "git"
-    "minimap"
-    "dashboard"
-    "utility"
-    "rich-presence"
-    "notes"
     "terminal"
+    "theme"
+    "treesitter"
     "ui"
-    "assistant"
-    "session"
-    "comments"
-    "projects"
-    "languages"
-    "debugger"
+    "utility"
+    "visuals"
   ];
 
   core = map (p: ./core + "/${p}") [
diff --git a/modules/neovim/default.nix b/modules/neovim/default.nix
deleted file mode 100644
index 5de3773f..00000000
--- a/modules/neovim/default.nix
+++ /dev/null
@@ -1,5 +0,0 @@
-  imports = [
-    ./config.nix
-    ./module.nix
-  ];
-}