docs: fix mkEnableOption usage for autogenerated documentation

modules/assistant/copilot/copilot.nix

@@ -9,7 +9,7 @@ with builtins; let
   cfg = config.vim.assistant.copilot;
 in {
   options.vim.assistant.copilot = {
-    enable = mkEnableOption "Enable GitHub Copilot";
+    enable = mkEnableOption "GitHub Copilot AI assistant";
 
     panel = {
       position = mkOption {

modules/assistant/tabnine/tabnine.nix

@@ -2,7 +2,7 @@
 with lib;
 with builtins; {
   options.vim.assistant.tabnine = {
-    enable = mkEnableOption "Enable TabNine assistant";
+    enable = mkEnableOption "Tabnine assistant";
 
     disable_auto_comment = mkOption {
       type = types.bool;

modules/autopairs/nvim-autopairs/nvim-autopairs.nix

@@ -1,17 +1,9 @@
-{
+{lib, ...}:
-  lib,
-  config,
-  ...
-}:
 with lib;
 with builtins; {
   options.vim = {
     autopairs = {
-      enable = mkOption {
+      enable = mkEnableOption "autopairs" // {default = false;};
-        type = types.bool;
-        default = false;
-        description = "Enable autopairs";
-      };
 
       type = mkOption {
         type = types.enum ["nvim-autopairs"];

modules/basic/module.nix

@@ -7,7 +7,7 @@ with lib;
 with builtins; {
   options.vim = {
     debugMode = {
-      enable = mkEnableOption "Enable debug mode";
+      enable = mkEnableOption "debug mode";
       level = mkOption {
         type = types.int;
         default = 20;
@@ -151,6 +151,6 @@ with builtins; {
       description = "Highlight the text line of the cursor with CursorLine hl-CursorLine";
     };
 
-    enableLuaLoader = mkEnableOption "Enable the experimental Lua module loader to speed up the start up process";
+    enableLuaLoader = mkEnableOption "experimental Lua module loader to speed up the start up process";
   };
 }

modules/comments/comment-nvim/comment-nvim.nix

@@ -2,7 +2,7 @@
 with lib;
 with builtins; {
   options.vim.comments.comment-nvim = {
-    enable = mkEnableOption "Enable comment-nvim";
+    enable = mkEnableOption "smart and powerful comment plugin for neovim comment-nvim";
 
     mappings = {
       toggleCurrentLine = mkMappingOption "Toggle current line comment" "gcc";

modules/completion/nvim-cmp/nvim-cmp.nix

@@ -3,11 +3,7 @@ with lib;
 with builtins; {
   options.vim = {
     autocomplete = {
-      enable = mkOption {
+      enable = mkEnableOption "enable autocomplete" // {default = false;};
-        type = types.bool;
-        default = false;
-        description = "enable autocomplete";
-      };
 
       mappings = {
         complete = mkMappingOption "Complete [nvim-cmp]" "<C-Space>";

modules/dashboard/alpha/alpha.nix

@@ -6,6 +6,6 @@
 with lib;
 with builtins; {
   options.vim.dashboard.alpha = {
-    enable = mkEnableOption "Enable alpha.nvim";
+    enable = mkEnableOption "dashboard via alpha.nvim";
   };
 }

modules/dashboard/dashboard-nvim/dashboard-nvim.nix

@@ -6,6 +6,6 @@
 with lib;
 with builtins; {
   options.vim.dashboard.dashboard-nvim = {
-    enable = mkEnableOption "Enable dashboard.nvim";
+    enable = mkEnableOption "dashboard via dashboard.nvim";
   };
 }

modules/dashboard/startify/startify.nix

@@ -6,7 +6,7 @@
 with builtins;
 with lib; {
   options.vim.dashboard.startify = {
-    enable = mkEnableOption "Enable vim-startify";
+    enable = mkEnableOption "dashboard via vim-startify";
 
     bookmarks = mkOption {
       default = [];

modules/filetree/nvimtree-lua/nvimtree-lua.nix

@@ -6,11 +6,7 @@
 with lib;
 with builtins; {
   options.vim.filetree.nvimTreeLua = {
-    enable = mkOption {
+    enable = mkEnableOption "filetree via nvim-tree-lua" // {default = false;};
-      type = types.bool;
-      default = false;
-      description = "Enable nvim-tree-lua";
-    };
 
     mappings = {
       toggle = mkOption {

modules/git/git.nix

@@ -2,7 +2,7 @@
 with lib;
 with builtins; {
   options.vim.git = {
-    enable = mkEnableOption "Git support";
+    enable = mkEnableOption "git tools via gitsigns";
 
     gitsigns = {
       enable = mkEnableOption "gitsigns";

modules/languages/clang.nix

@@ -47,31 +47,26 @@ in {
     };
 
     treesitter = {
-      enable = mkOption {
+      enable = mkEnableOption "C/C++ treesitter" // {default = config.vim.languages.enableTreesitter;};
-        description = "Enable C/C++ treesitter";
-        type = types.bool;
-        default = config.vim.languages.enableTreesitter;
-      };
       cPackage = nvim.types.mkGrammarOption pkgs "c";
       cppPackage = nvim.types.mkGrammarOption pkgs "cpp";
     };
 
     lsp = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable clang LSP support" // {default = config.vim.languages.enableLSP;};
-        description = "Enable clang LSP support";
+
-        type = types.bool;
-        default = config.vim.languages.enableLSP;
-      };
       server = mkOption {
         description = "The clang LSP server to use";
         type = with types; enum (attrNames servers);
         default = defaultServer;
       };
+
       package = mkOption {
         description = "clang LSP server package";
         type = types.package;
         default = servers.${cfg.lsp.server}.package;
       };
+
       opts = mkOption {
         description = "Options to pass to clang LSP server";
         type = with types; nullOr str;

modules/languages/dart/dart.nix

@@ -26,16 +26,12 @@ in {
     enable = mkEnableOption "Dart language support";
 
     treesitter = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Dart treesitter" // {default = config.vim.languages.enableTreesitter;};
-        description = "Enable Dart treesitter";
-        type = types.bool;
-        default = config.vim.languages.enableTreesitter;
-      };
       package = nvim.types.mkGrammarOption pkgs "dart";
     };
 
     lsp = {
-      enable = mkEnableOption "Enable Dart LSP support";
+      enable = mkEnableOption "Dart LSP support";
       server = mkOption {
         description = "The Dart LSP server to use";
         type = with types; enum (attrNames servers);

modules/languages/elixir/elixir-tools.nix

@@ -6,6 +6,6 @@
 with lib;
 with builtins; {
   options.vim.languages.elixir = {
-    enable = mkEnableOption "elixir support";
+    enable = mkEnableOption "Elixir language support";
   };
 }

modules/languages/go.nix

@@ -26,25 +26,20 @@ in {
     enable = mkEnableOption "Go language support";
 
     treesitter = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Go treesitter" // {default = config.vim.languages.enableTreesitter;};
-        description = "Enable Go treesitter";
+
-        type = types.bool;
-        default = config.vim.languages.enableTreesitter;
-      };
       package = nvim.types.mkGrammarOption pkgs "go";
     };
 
     lsp = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Go LSP support" // {default = config.vim.languages.enableLSP;};
-        description = "Enable Go LSP support";
+
-        type = types.bool;
-        default = config.vim.languages.enableLSP;
-      };
       server = mkOption {
         description = "Go LSP server to use";
         type = with types; enum (attrNames servers);
         default = defaultServer;
       };
+
       package = mkOption {
         description = "Go LSP server package";
         type = types.package;

modules/languages/markdown/markdown.nix

@@ -9,7 +9,7 @@ with builtins; let
   cfg = config.vim.languages.markdown;
 in {
   options.vim.languages.markdown = {
-    enable = mkEnableOption "Markdown language support";
+    enable = mkEnableOption "Markdown markup language support";
 
     glow.enable = mkOption {
       type = types.bool;

modules/languages/nix.nix

@@ -96,11 +96,8 @@ in {
     };
 
     lsp = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Nix LSP support" // {default = config.vim.languages.enableLSP;};
-        description = "Enable Nix LSP support";
+
-        type = types.bool;
-        default = config.vim.languages.enableLSP;
-      };
       server = mkOption {
         description = "Nix LSP server to use";
         type = types.str;
@@ -114,11 +111,8 @@ in {
     };
 
     format = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Nix formatting" // {default = config.vim.languages.enableFormat;};
-        description = "Enable Nix formatting";
+
-        type = types.bool;
-        default = config.vim.languages.enableFormat;
-      };
       type = mkOption {
         description = "Nix formatter to use";
         type = with types; enum (attrNames formats);

modules/languages/python.nix

@@ -41,11 +41,7 @@ in {
     enable = mkEnableOption "Python language support";
 
     treesitter = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Python treesitter" // {default = config.vim.languages.enableTreesitter;};
-        description = "Enable Python treesitter";
-        type = types.bool;
-        default = config.vim.languages.enableTreesitter;
-      };
       package = mkOption {
         description = "Python treesitter grammar to use";
         type = types.package;
@@ -54,16 +50,14 @@ in {
     };
 
     lsp = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Python LSP support" // {default = config.vim.languages.enableLSP;};
-        description = "Enable Python LSP support";
+
-        type = types.bool;
-        default = config.vim.languages.enableLSP;
-      };
       server = mkOption {
         description = "Python LSP server to use";
         type = with types; enum (attrNames servers);
         default = defaultServer;
       };
+
       package = mkOption {
         description = "python LSP server package";
         type = types.package;
@@ -72,16 +66,14 @@ in {
     };
 
     format = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Python formatting" // {default = config.vim.languages.enableFormat;};
-        description = "Enable Python formatting";
+
-        type = types.bool;
-        default = config.vim.languages.enableFormat;
-      };
       type = mkOption {
         description = "Python formatter to use";
         type = with types; enum (attrNames formats);
         default = defaultFormat;
       };
+
       package = mkOption {
         description = "Python formatter package";
         type = types.package;

modules/languages/rust.nix

@@ -12,11 +12,7 @@ in {
     enable = mkEnableOption "Rust language support";
 
     treesitter = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Rust treesitter" // {default = config.vim.languages.enableTreesitter;};
-        description = "Enable Rust treesitter";
-        type = types.bool;
-        default = config.vim.languages.enableTreesitter;
-      };
       package = nvim.types.mkGrammarOption pkgs "rust";
     };
 
@@ -30,16 +26,14 @@ in {
     };
 
     lsp = {
-      enable = mkOption {
+      enable = mkEnableOption "Rust LSP support (rust-analyzer with extra tools)" // {default = config.vim.languages.enableLSP;};
-        description = "Rust LSP support (rust-analyzer with extra tools)";
+
-        type = types.bool;
-        default = config.vim.languages.enableLSP;
-      };
       package = mkOption {
         description = "rust-analyzer package";
         type = types.package;
         default = pkgs.rust-analyzer;
       };
+
       opts = mkOption {
         description = "Options to pass to rust analyzer";
         type = types.str;

modules/languages/sql.nix

@@ -68,11 +68,8 @@ in {
     };
 
     treesitter = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable SQL treesitter" // {default = config.vim.languages.enableTreesitter;};
-        description = "Enable SQL treesitter";
+
-        type = types.bool;
-        default = config.vim.languages.enableTreesitter;
-      };
       package = mkOption {
         description = "SQL treesitter grammar to use";
         type = types.package;
@@ -81,16 +78,14 @@ in {
     };
 
     lsp = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable SQL LSP support" // {default = config.vim.languages.enableLSP;};
-        description = "Enable SQL LSP support";
+
-        type = types.bool;
-        default = config.vim.languages.enableLSP;
-      };
       server = mkOption {
         description = "SQL LSP server to use";
         type = with types; enum (attrNames servers);
         default = defaultServer;
       };
+
       package = mkOption {
         description = "SQL LSP server package";
         type = types.package;
@@ -99,16 +94,14 @@ in {
     };
 
     format = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable SQL formatting" // {default = config.vim.languages.enableFormat;};
-        description = "Enable SQL formatting";
+
-        type = types.bool;
-        default = config.vim.languages.enableFormat;
-      };
       type = mkOption {
         description = "SQL formatter to use";
         type = with types; enum (attrNames formats);
         default = defaultFormat;
       };
+
       package = mkOption {
         description = "SQL formatter package";
         type = types.package;
@@ -117,11 +110,8 @@ in {
     };
 
     extraDiagnostics = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable extra SQL diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
-        description = "Enable extra SQL diagnostics";
+
-        type = types.bool;
-        default = config.vim.languages.enableExtraDiagnostics;
-      };
       types = lib.nvim.types.diagnostics {
         langDesc = "SQL";
         inherit diagnostics;

modules/languages/svelte.nix

@@ -58,25 +58,20 @@ in {
     enable = mkEnableOption "Svelte language support";
 
     treesitter = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Svelte treesitter" // {default = config.vim.languages.enableTreesitter;};
-        description = "Enable Svelte treesitter";
+
-        type = types.bool;
-        default = config.vim.languages.enableTreesitter;
-      };
       sveltePackage = nvim.types.mkGrammarOption pkgs "svelte";
     };
 
     lsp = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Svelte LSP support" // {default = config.vim.languages.enableLSP;};
-        description = "Enable Svelte LSP support";
+
-        type = types.bool;
-        default = config.vim.languages.enableLSP;
-      };
       server = mkOption {
         description = "Svelte LSP server to use";
         type = with types; enum (attrNames servers);
         default = defaultServer;
       };
+
       package = mkOption {
         description = "Svelte LSP server package";
         type = types.package;
@@ -85,16 +80,14 @@ in {
     };
 
     format = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Svelte formatting" // {default = config.vim.languages.enableFormat;};
-        description = "Enable Svelte formatting";
+
-        type = types.bool;
-        default = config.vim.languages.enableFormat;
-      };
       type = mkOption {
         description = "Svelte formatter to use";
         type = with types; enum (attrNames formats);
         default = defaultFormat;
       };
+
       package = mkOption {
         description = "Svelte formatter package";
         type = types.package;
@@ -103,11 +96,8 @@ in {
     };
 
     extraDiagnostics = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable extra Svelte diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
-        description = "Enable extra Svelte diagnostics";
+
-        type = types.bool;
-        default = config.vim.languages.enableExtraDiagnostics;
-      };
       types = lib.nvim.types.diagnostics {
         langDesc = "Svelte";
         inherit diagnostics;

modules/languages/tidal/tidal.nix

@@ -6,7 +6,7 @@
 with lib;
 with builtins; {
   options.vim.tidal = {
-    enable = mkEnableOption "Enable tidalcycles tools and plugins";
+    enable = mkEnableOption "tidalcycles tools and plugins";
 
     flash = mkOption {
       description = ''When sending a paragraph or a single line, vim-tidal will "flash" the selection for some milliseconds'';

modules/languages/ts.nix

@@ -58,26 +58,20 @@ in {
     enable = mkEnableOption "Typescript/Javascript language support";
 
     treesitter = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Typescript/Javascript treesitter" // {default = config.vim.languages.enableTreesitter;};
-        description = "Enable Typescript/Javascript treesitter";
-        type = types.bool;
-        default = config.vim.languages.enableTreesitter;
-      };
       tsPackage = nvim.types.mkGrammarOption pkgs "tsx";
       jsPackage = nvim.types.mkGrammarOption pkgs "javascript";
     };
 
     lsp = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Typescript/Javascript LSP support" // {default = config.vim.languages.enableLSP;};
-        description = "Enable Typescript/Javascript LSP support";
+
-        type = types.bool;
-        default = config.vim.languages.enableLSP;
-      };
       server = mkOption {
         description = "Typescript/Javascript LSP server to use";
         type = with types; enum (attrNames servers);
         default = defaultServer;
       };
+
       package = mkOption {
         description = "Typescript/Javascript LSP server package";
         type = types.package;
@@ -86,16 +80,14 @@ in {
     };
 
     format = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Typescript/Javascript formatting" // {default = config.vim.languages.enableFormat;};
-        description = "Enable Typescript/Javascript formatting";
+
-        type = types.bool;
-        default = config.vim.languages.enableFormat;
-      };
       type = mkOption {
         description = "Typescript/Javascript formatter to use";
         type = with types; enum (attrNames formats);
         default = defaultFormat;
       };
+
       package = mkOption {
         description = "Typescript/Javascript formatter package";
         type = types.package;
@@ -104,11 +96,8 @@ in {
     };
 
     extraDiagnostics = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable extra Typescript/Javascript diagnostics" // {default = config.vim.languages.enableExtraDiagnostics;};
-        description = "Enable extra Typescript/Javascript diagnostics";
+
-        type = types.bool;
-        default = config.vim.languages.enableExtraDiagnostics;
-      };
       types = lib.nvim.types.diagnostics {
         langDesc = "Typescript/Javascript";
         inherit diagnostics;

modules/languages/zig.nix

@@ -12,24 +12,19 @@ in {
     enable = mkEnableOption "SQL language support";
 
     treesitter = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable Zig treesitter" // {default = config.vim.languages.enableTreesitter;};
-        description = "Enable Zig treesitter";
-        type = types.bool;
-        default = config.vim.languages.enableTreesitter;
-      };
       package = nvim.types.mkGrammarOption pkgs "zig";
     };
+
     lsp = {
-      enable = mkOption {
+      enable = mkEnableOption "Zig LSP support (zls)" // {default = config.vim.languages.enableLSP;};
-        description = "Zig LSP support (zls)";
+
-        type = types.bool;
-        default = config.vim.languages.enableLSP;
-      };
       package = mkOption {
         description = "ZLS package";
         type = types.package;
         default = pkgs.zls;
       };
+
       zigPackage = mkOption {
         description = "Zig package used by ZLS";
         type = types.package;

modules/minimap/codewindow/codewindow.nix

@@ -1,7 +1,7 @@
 {lib, ...}:
 with lib; {
   options.vim.minimap.codewindow = {
-    enable = mkEnableOption "Enable codewindow plugin for minimap view";
+    enable = mkEnableOption "codewindow plugin for minimap view";
 
     mappings = {
       open = mkMappingOption "Open minimap [codewindow]" "<leader>mo";

modules/minimap/minimap-vim/minimap-vim.nix

@@ -6,6 +6,6 @@
 with lib;
 with builtins; {
   options.vim.minimap.minimap-vim = {
-    enable = mkEnableOption "Enable minimap-vim plugin for minimap view";
+    enable = mkEnableOption "minimap-vim plugin for minimap view";
   };
 }

modules/notes/mind-nvim/mind-nvim.nix

@@ -6,6 +6,6 @@
 with lib;
 with builtins; {
   options.vim.notes.mind-nvim = {
-    enable = mkEnableOption "The power of trees at your fingertips. ";
+    enable = mkEnableOption "organizer tool for Neovim.";
   };
 }

modules/notes/obsidian/obsidian.nix

@@ -7,7 +7,7 @@ with lib;
 with builtins; {
   options.vim.notes = {
     obsidian = {
-      enable = mkEnableOption "Complementary neovim plugins for Obsidian editor";
+      enable = mkEnableOption "complementary neovim plugins for Obsidian editor";
       dir = mkOption {
         type = types.str;
         default = "~/my-vault";

modules/notes/orgmode/orgmode.nix

@@ -6,15 +6,15 @@
 with lib;
 with builtins; {
   options.vim.notes.orgmode = {
-    enable = mkEnableOption "Enable nvim-orgmode: Neovim plugin for Emac Orgmode. Get the best of both worlds";
+    enable = mkEnableOption "nvim-orgmode: Neovim plugin for Emac Orgmode. Get the best of both worlds";
     orgAgendaFiles = mkOption {
       type = types.str;
-      default = "{'~/Dropbox/org/*', '~/my-orgs/**/*'}";
+      default = "{'~/Documents/org/*', '~/my-orgs/**/*'}";
       description = "List of org files to be used as agenda files.";
     };
     orgDefaultNotesFile = mkOption {
       type = types.str;
-      default = "~/Dropbox/org/refile.org";
+      default = "~/Documents/org/refile.org";
       description = "Default org file to be used for notes.";
     };
   };

modules/notes/todo-comments/todo-comments.nix

@@ -2,7 +2,7 @@
 with lib;
 with builtins; {
   options.vim.notes.todo-comments = {
-    enable = mkEnableOption "Enable todo-comments";
+    enable = mkEnableOption "todo-comments: highlight and search for todo comments like TODO, HACK, BUG in your code base";
 
     patterns = {
       highlight = mkOption {

modules/projects/project-nvim/config.nix

@@ -4,59 +4,49 @@
   ...
 }:
 with lib;
-with builtins; {
+with builtins; let
-  options.vim.projects.project-nvim = {
+  cfg = config.vim.projects.project-nvim;
-    enable = mkEnableOption "Enable project-nvim for project management";
+in {
+  config = mkIf cfg.enable {
+    vim.startPlugins = [
+      "project-nvim"
+    ];
 
-    manualMode = mkOption {
+    vim.luaConfigRC.project-nvim = nvim.dag.entryAnywhere ''
-      type = types.bool;
+      require('project_nvim').setup({
-      default = true;
+        manual_mode = ${boolToString cfg.manualMode},
-      description = "don't automatically change the root directory so the user has the option to manually do so using `:ProjectRoot` command";
+        detection_methods = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.detectionMethods)} },
-    };
 
-    # detection methods should accept one or more strings from a list
+        -- All the patterns used to detect root dir, when **"pattern"** is in
-    detectionMethods = mkOption {
+        -- detection_methods
-      type = types.listOf types.str;
+        patterns = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.patterns)} },
-      default = ["lsp" "pattern"];
-      description = "Detection methods to use";
-    };
 
-    # patterns
+        -- Table of lsp clients to ignore by name
-    patterns = mkOption {
+        -- eg: { "efm", ... }
-      type = types.listOf types.str;
+        ignore_lsp = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.lspIgnored)} },
-      default = [".git" "_darcs" ".hg" ".bzr" ".svn" "Makefile" "package.json" "flake.nix" "cargo.toml"];
-      description = "Patterns to use for pattern detection method";
-    };
 
-    # table of lsp servers to ignore by name
+        -- Don't calculate root dir on specific directories
-    lspIgnored = mkOption {
+        -- Ex: { "~/.cargo/*", ... }
-      type = types.listOf types.str;
+        exclude_dirs = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.excludeDirs)} },
-      default = [];
-      description = "LSP servers no ignore by name";
-    };
 
-    excludeDirs = mkOption {
+        -- Show hidden files in telescope
-      type = types.listOf types.str;
+        show_hidden = ${boolToString cfg.showHidden},
-      default = [];
-      description = "Directories to exclude from project root search";
-    };
 
-    showHidden = mkOption {
+        -- When set to false, you will get a message when project.nvim changes your
-      type = types.bool;
+        -- directory.
-      default = false;
+        silent_chdir = ${boolToString cfg.silentChdir},
-      description = "Show hidden files in telescope picker";
-    };
 
-    silentChdir = mkOption {
+        -- What scope to change the directory, valid options are
-      type = types.bool;
+        -- * global (default)
-      default = true;
+        -- * tab
-      description = "Silently change directory when changing project";
+        -- * win
-    };
+        scope_chdir = '${toString cfg.scopeChdir}',
 
-    scopeChdir = mkOption {
+        -- Path where project.nvim will store the project history for use in
-      type = types.enum ["global" "tab" "win"];
+        -- telescope
-      default = "global";
+        datapath = vim.fn.stdpath("data"),
-      description = "What scope to change the directory";
+      })
-    };
+    '';
   };
 }
+

modules/projects/project-nvim/project-nvim.nix

@@ -4,48 +4,60 @@
   ...
 }:
 with lib;
-with builtins; let
+with builtins; {
-  cfg = config.vim.projects.project-nvim;
+  options.vim.projects.project-nvim = {
-in {
+    enable = mkEnableOption "Enable project-nvim for project management";
-  config = mkIf cfg.enable {
-    vim.startPlugins = [
-      "project-nvim"
-    ];
 
-    vim.luaConfigRC.project-nvim = nvim.dag.entryAnywhere ''
+    manualMode = mkOption {
-      require('project_nvim').setup({
+      type = types.bool;
-        manual_mode = ${boolToString cfg.manualMode},
+      default = true;
-        detection_methods = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.detectionMethods)} },
+      description = "don't automatically change the root directory so the user has the option to manually do so using `:ProjectRoot` command";
+    };
 
-        -- All the patterns used to detect root dir, when **"pattern"** is in
+    # detection methods should accept one or more strings from a list
-        -- detection_methods
+    detectionMethods = mkOption {
-        patterns = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.patterns)} },
+      type = types.listOf types.str;
+      default = ["lsp" "pattern"];
+      description = "Detection methods to use";
+    };
 
-        -- Table of lsp clients to ignore by name
+    # patterns
-        -- eg: { "efm", ... }
+    patterns = mkOption {
-        ignore_lsp = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.lspIgnored)} },
+      type = types.listOf types.str;
+      default = [".git" "_darcs" ".hg" ".bzr" ".svn" "Makefile" "package.json" "flake.nix" "cargo.toml"];
+      description = "Patterns to use for pattern detection method";
+    };
 
-        -- Don't calculate root dir on specific directories
+    # table of lsp servers to ignore by name
-        -- Ex: { "~/.cargo/*", ... }
+    lspIgnored = mkOption {
-        exclude_dirs = { ${concatStringsSep ", " (map (x: "\"" + x + "\"") cfg.excludeDirs)} },
+      type = types.listOf types.str;
+      default = [];
+      description = "LSP servers no ignore by name";
+    };
 
-        -- Show hidden files in telescope
+    excludeDirs = mkOption {
-        show_hidden = ${boolToString cfg.showHidden},
+      type = types.listOf types.str;
+      default = [];
+      description = "Directories to exclude from project root search";
+    };
 
-        -- When set to false, you will get a message when project.nvim changes your
+    showHidden = mkOption {
-        -- directory.
+      type = types.bool;
-        silent_chdir = ${boolToString cfg.silentChdir},
+      default = false;
+      description = "Show hidden files in telescope picker";
+    };
 
-        -- What scope to change the directory, valid options are
+    silentChdir = mkOption {
-        -- * global (default)
+      type = types.bool;
-        -- * tab
+      default = true;
-        -- * win
+      description = "Silently change directory when changing project";
-        scope_chdir = '${toString cfg.scopeChdir}',
+    };
 
-        -- Path where project.nvim will store the project history for use in
+    scopeChdir = mkOption {
-        -- telescope
+      type = types.enum ["global" "tab" "win"];
-        datapath = vim.fn.stdpath("data"),
+      default = "global";
-      })
+      description = "What scope to change the directory";
-    '';
+    };
   };
 }
+

modules/rich-presence/presence-nvim/presence-nvim.nix

@@ -6,7 +6,7 @@
 with lib;
 with builtins; {
   options.vim.presence.presence-nvim = {
-    enable = mkEnableOption "Enable presence.nvim plugin for discord rich presence";
+    enable = mkEnableOption "presence.nvim plugin for discord rich presence";
 
     image_text = mkOption {
       type = types.str;

modules/session/nvim-session-manager/nvim-session-manager.nix

@@ -6,7 +6,7 @@
 with lib;
 with builtins; {
   options.vim.session.nvim-session-manager = {
-    enable = mkEnableOption "Enable nvim-session-manager";
+    enable = mkEnableOption "nvim-session-manager: manage sessions like folders in VSCode";
 
     mappings = {
       loadSession = mkOption {

modules/snippets/vsnip/vsnip.nix

@@ -1,11 +1,6 @@
-{
+{lib, ...}:
-  config,
+with lib; {
-  lib,
-  ...
-}:
-with lib;
-with builtins; {
   options.vim.snippets.vsnip = {
-    enable = mkEnableOption "Enable vim-vsnip";
+    enable = mkEnableOption "vim-vsnip: snippet LSP/VSCode's format";
   };
 }

modules/statusline/lualine/lualine.nix

@@ -8,14 +8,10 @@ with builtins; let
   supported_themes = import ./supported_themes.nix;
 in {
   options.vim.statusline.lualine = {
-    enable = mkEnableOption "lualine";
+    enable = mkEnableOption "lualine statusline plugin";
 
     icons = {
-      enable = mkOption {
+      enable = mkEnableOption "icons for lualine" // {default = true;};
-        type = types.bool;
-        description = "Enable icons for lualine";
-        default = true;
-      };
     };
 
     refresh = {
@@ -125,6 +121,7 @@ in {
               "mode",
               separator = {
                 left = '▎',
+                right = ''
               },
             },
           }
@@ -184,7 +181,12 @@ in {
             {
               "diagnostics",
               sources = {'nvim_lsp', 'nvim_diagnostic', 'coc'},
-              symbols = {error = '󰅙 ', warn = ' ', info = ' ', hint = '󰌵 '}
+              symbols = {error = '󰅙 ', warn = ' ', info = ' ', hint = '󰌵 '},
+              diagnostics_color = {
+                color_error = { fg = colors.red },
+                color_warn = { fg = colors.yellow },
+                color_info = { fg = colors.cyan },
+              },
             },
           }
         '';
@@ -224,12 +226,7 @@ in {
             {
               "branch",
               icon = ' •',
-              separator = {
-                left = '(',
-                right = ')'
-              },
               color = {bg='none', fg='lavender'},
-
             },
           }
         '';

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

@@ -2,6 +2,8 @@
 with lib;
 with builtins; {
   options.vim.tabline.nvimBufferline = {
+    enable = mkEnableOption "nvim-bufferline-lua as a bufferline";
+
     mappings = {
       closeCurrent = mkMappingOption "Close buffer" null;
       cycleNext = mkMappingOption "Next buffer" "<leader>bn";
@@ -13,7 +15,5 @@ with builtins; {
       moveNext = mkMappingOption "Move next buffer" "<leader>bmn";
       movePrevious = mkMappingOption "Move previous buffer" "<leader>bmp";
     };
-
-    enable = mkEnableOption "Enable nvim-bufferline-lua as a bufferline";
   };
 }

modules/terminal/toggleterm/toggleterm.nix

@@ -15,23 +15,27 @@ with builtins; {
         default = "<c-t>";
       };
     };
+
     direction = mkOption {
       type = types.enum ["horizontal" "vertical" "tab" "float"];
       default = "horizontal";
       description = "Direction of the terminal";
     };
+
     enable_winbar = mkOption {
       type = types.bool;
       default = false;
       description = "Enable winbar";
     };
+
     lazygit = {
-      enable = mkEnableOption "Enable LazyGit integration";
+      enable = mkEnableOption "LazyGit integration";
       direction = mkOption {
         type = types.enum ["horizontal" "vertical" "tab" "float"];
         default = "float";
         description = "Direction of the lazygit window";
       };
+
       package = mkOption {
         type = with types; nullOr package;
         default = pkgs.lazygit;

modules/ui/colorizer/colorizer.nix

@@ -6,7 +6,7 @@
 with lib;
 with builtins; {
   options.vim.ui.colorizer = {
-    enable = mkEnableOption "Enable nvim-colorizer.lua for color highlighting";
+    enable = mkEnableOption "nvim-colorizer.lua for color highlighting";
 
     options = {
       rgb = mkOption {

modules/ui/modes/modes.nix

@@ -6,6 +6,6 @@
 with lib;
 with builtins; {
   options.vim.ui.modes-nvim = {
-    enable = mkEnableOption "Enable modes.nvim UI elements";
+    enable = mkEnableOption "modes.nvim's prismatic line decorations";
   };
 }

modules/ui/noice/noice.nix

@@ -6,6 +6,6 @@
 with lib;
 with builtins; {
   options.vim.ui.noice = {
-    enable = mkEnableOption "Enable noice-nvim UI modifications";
+    enable = mkEnableOption "noice-nvim UI modification library";
   };
 }

modules/ui/notifications/nvim-notify/nvim-notify.nix

@@ -6,29 +6,34 @@
 with lib;
 with builtins; {
   options.vim.notify.nvim-notify = {
-    enable = mkEnableOption "Enable nvim-notify plugin";
+    enable = mkEnableOption "nvim-notify notifications";
     stages = mkOption {
       type = types.enum ["fade_in_slide_out" "fade_in" "slide_out" "none"];
       default = "fade_in_slide_out";
       description = "The stages of the notification";
     };
+
     timeout = mkOption {
       type = types.int;
       default = 1000;
       description = "The timeout of the notification";
     };
+
     background_colour = mkOption {
       type = types.str;
       default = "#000000";
       description = "The background colour of the notification";
     };
+
     position = mkOption {
       type = types.enum ["top_left" "top_right" "bottom_left" "bottom_right"];
       default = "top_right";
       description = "The position of the notification";
     };
+
     icons = mkOption {
       type = types.attrsOf types.str;
+      description = "The icons of the notification";
       default = {
         ERROR = "";
         WARN = "";
@@ -36,7 +41,6 @@ with builtins; {
         DEBUG = "";
         TRACE = "";
       };
-      description = "The icons of the notification";
     };
   };
 }

modules/ui/smartcolumn/smartcolumn.nix

@@ -2,7 +2,7 @@
 with lib;
 with builtins; {
   options.vim.ui.smartcolumn = {
-    enable = mkEnableOption "Enable Smartcolumn line length indicator";
+    enable = mkEnableOption "line length indicator";
 
     showColumnAt = mkOption {
       type = types.nullOr types.int;

modules/utility/binds/cheatsheet/cheatsheet.nix

@@ -6,6 +6,6 @@
 with lib;
 with builtins; {
   options.vim.binds.cheatsheet = {
-    enable = mkEnableOption "Enable cheatsheet-nvim: searchable cheatsheet for nvim using telescope";
+    enable = mkEnableOption "cheatsheet-nvim: searchable cheatsheet for nvim using telescope";
   };
 }

modules/utility/binds/which-key/which-key.nix

@@ -1,11 +1,7 @@
-{
+{lib, ...}:
-  config,
-  lib,
-  ...
-}:
 with lib;
 with builtins; {
   options.vim.binds.whichKey = {
-    enable = mkEnableOption "Enable which-key keybind menu";
+    enable = mkEnableOption "which-key keybind helper menu";
   };
 }

modules/utility/ccc/ccc.nix

@@ -2,7 +2,7 @@
 with lib;
 with builtins; {
   options.vim.utility.ccc = {
-    enable = mkEnableOption "Enable ccc color picker for neovim";
+    enable = mkEnableOption "ccc color picker for neovim";
 
     mappings = {
       quit = mkMappingOption "Cancel and close the UI without replace or insert" "<Esc>";

modules/utility/diffview/diffview.nix

@@ -1,11 +1,7 @@
-{
+{lib, ...}:
-  config,
-  lib,
-  ...
-}:
 with lib;
 with builtins; {
   options.vim.utility.diffview-nvim = {
-    enable = mkEnableOption "Enable diffview-nvim";
+    enable = mkEnableOption "diffview-nvim: cycle through diffs for all modified files for any git rev";
   };
 }

modules/utility/gestures/gesture-nvim/gesture-nvim.nix

@@ -1,7 +1,7 @@
 {lib, ...}:
 with lib; {
   options.vim.gestures.gesture-nvim = {
-    enable = mkEnableOption "Enable gesture-nvim plugin";
+    enable = mkEnableOption "gesture-nvim: mouse gestures";
 
     mappings = {
       draw = mkMappingOption "Start drawing [gesture.nvim]" "<LeftDrag>";

modules/utility/icon-picker/icon-picker.nix

@@ -1,11 +1,7 @@
-{
+{lib, ...}:
-  config,
-  lib,
-  ...
-}:
 with lib;
 with builtins; {
   options.vim.utility.icon-picker = {
-    enable = mkEnableOption "Enable nerdfonts icon picker for nvim";
+    enable = mkEnableOption "nerdfonts icon picker for nvim";
   };
 }

modules/utility/motion/hop/hop.nix

@@ -5,6 +5,6 @@ with lib; {
       hop = mkMappingOption "Jump to occurences [hop.nvim]" "<leader>h";
     };
 
-    enable = mkEnableOption "Enable Hop.nvim plugin (easy motion)";
+    enable = mkEnableOption "Hop.nvim plugin (easy motion)";
   };
 }

modules/utility/motion/leap/leap.nix

@@ -2,7 +2,7 @@
 with lib;
 with builtins; {
   options.vim.utility.motion.leap = {
-    enable = mkEnableOption "Enable leap.nvim plugin (easy motion)";
+    enable = mkEnableOption "leap.nvim plugin (easy motion)";
 
     mappings = {
       leapForwardTo = mkOption {

modules/utility/telescope/config.nix

@@ -45,6 +45,11 @@ in {
         mkIf config.vim.treesitter.enable
         (mkSetBinding mappings.treesitter "<cmd> Telescope treesitter<CR>")
       )
+
+      (
+        mkIf config.vim.projects.project-nvim.enable
+        (mkSetBinding mappings.findProjects "<cmd Telescope projects<CR>")
+      )
     ];
 
     vim.luaConfigRC.telescope = nvim.dag.entryAnywhere ''

modules/utility/telescope/telescope.nix

@@ -3,6 +3,8 @@ with lib;
 with builtins; {
   options.vim.telescope = {
     mappings = {
+      findProjects = mkMappingOption "Find files [Telescope]" "<leader>fp";
+
       findFiles = mkMappingOption "Find files [Telescope]" "<leader>ff";
       liveGrep = mkMappingOption "Live grep [Telescope]" "<leader>fg";
       buffers = mkMappingOption "Buffers [Telescope]" "<leader>fb";
@@ -26,6 +28,6 @@ with builtins; {
       treesitter = mkMappingOption "Treesitter [Telescope]" "<leader>fs";
     };
 
-    enable = mkEnableOption "Enable multi-purpose telescope utility";
+    enable = mkEnableOption "telescope.nvim: multi-purpose search & picker utility";
   };
 }

modules/utility/wakatime/vim-wakatime.nix

@@ -6,7 +6,7 @@
 with lib;
 with builtins; {
   options.vim.utility.vim-wakatime = {
-    enable = mkEnableOption "Enable vim-wakatime";
+    enable = mkEnableOption "vim-wakatime: live code statistics";
 
     cli-package = mkOption {
       type = with types; nullOr package;

modules/visuals/visuals.nix

@@ -12,24 +12,12 @@ in {
 
     nvimWebDevicons.enable = mkEnableOption "dev icons. Required for certain plugins [nvim-web-devicons].";
 
-    scrollBar.enable = mkOption {
+    scrollBar.enable = mkEnableOption "Enable scrollbar [scrollbar.nvim]";
-      type = types.bool;
-      description = "Enable scrollbar [scrollbar.nvim]";
-      default = false;
-    };
 
-    smoothScroll.enable = mkOption {
+    smoothScroll.enable = mkEnableOption "Enable smooth scrolling [cinnamon-nvim]";
-      type = types.bool;
-      description = "Enable smooth scrolling [cinnamon-nvim]";
-      default = false;
-    };
 
     cellularAutomaton = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable cellular automaton [cellular-automaton]";
-        type = types.bool;
-        description = "Enable cellular automaton [cellular-automaton]";
-        default = false;
-      };
 
       mappings = {
         makeItRain = mkMappingOption "Make it rain [cellular-automaton]" "<leader>fml";
@@ -37,11 +25,8 @@ in {
     };
 
     fidget-nvim = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable nvim LSP UI element [fidget-nvim]";
-        type = types.bool;
+
-        description = "Enable nvim LSP UI element [fidget-nvim]";
-        default = false;
-      };
       align = {
         bottom = mkOption {
           type = types.bool;
@@ -68,11 +53,7 @@ in {
     };
 
     indentBlankline = {
-      enable = mkOption {
+      enable = mkEnableOption "Enable indentation guides [indent-blankline]";
-        type = types.bool;
-        description = "Enable indentation guides [indent-blankline]";
-        default = false;
-      };
 
       listChar = mkOption {
         type = types.str;