Merge branch 'main' into more-option-stuff

modules/plugins/filetree/nvimtree/config.nix

@@ -1,7 +1,7 @@
 {
+  options,
   config,
   lib,
-  pkgs,
   ...
 }: let
   inherit (lib.strings) optionalString;
@@ -11,8 +11,7 @@
   inherit (lib.nvim.binds) pushDownDefault;
 
   cfg = config.vim.filetree.nvimTree;
-  self = import ./nvimtree.nix {inherit pkgs lib;};
-  inherit (self.options.vim.filetree.nvimTree) mappings;
+  inherit (options.vim.filetree.nvimTree) mappings;
 in {
   config = mkIf cfg.enable {
     vim = {
@@ -77,6 +76,9 @@ in {
               -- buffer is a real file on the disk
               local real_file = vim.fn.filereadable(data.file) == 1
 
+              -- buffer is a directory
+              local directory = vim.fn.isdirectory(data.file) == 1
+
               -- buffer is a [No Name]
                 local no_name = data.file == "" and vim.bo[data.buf].buftype == ""
 
@@ -84,7 +86,7 @@ in {
               local filetype = vim.bo[data.buf].ft
 
               -- only files please
-              if not real_file and not no_name then
+              if not real_file and not directory and not no_name then
                 return
               end
 
@@ -93,6 +95,10 @@ in {
                 return
               end
 
+              -- cd if buffer is a directory
+              if directory then
+                vim.cmd.cd(data.file)
+              end
               -- open the tree but don't focus it
               require("nvim-tree.api").tree.toggle({ focus = false })
             end

modules/plugins/git/gitsigns/config.nix

@@ -7,6 +7,7 @@
   inherit (lib.modules) mkIf mkMerge;
   inherit (lib.nvim.binds) addDescriptionsToMappings mkSetExprBinding mkSetLuaBinding pushDownDefault;
   inherit (lib.nvim.dag) entryAnywhere;
+  inherit (lib.nvim.lua) toLuaObject;
 
   cfg = config.vim.git.gitsigns;
 
@@ -70,7 +71,7 @@ in {
         };
 
         pluginRC.gitsigns = entryAnywhere ''
-          require('gitsigns').setup{}
+          require('gitsigns').setup(${toLuaObject cfg.setupOpts})
         '';
       };
     }

modules/plugins/git/gitsigns/gitsigns.nix

@@ -6,6 +6,7 @@
   inherit (lib.options) mkEnableOption;
   inherit (lib.modules) mkRenamedOptionModule;
   inherit (lib.nvim.binds) mkMappingOption;
+  inherit (lib.nvim.types) mkPluginSetupOption;
 in {
   imports = [
     (mkRenamedOptionModule ["vim" "git" "gitsigns" "codeActions" "vim" "gitsigns" "codeActions"] ["vim" "git" "gitsigns" "codeActions" "enable"])
@@ -13,6 +14,7 @@ in {
 
   options.vim.git.gitsigns = {
     enable = mkEnableOption "gitsigns" // {default = config.vim.git.enable;};
+    setupOpts = mkPluginSetupOption "gitsigns" {};
 
     codeActions.enable = mkEnableOption "gitsigns codeactions through null-ls";
 

modules/plugins/languages/default.nix

@@ -14,6 +14,7 @@ in {
     ./hcl.nix
     ./kotlin.nix
     ./html.nix
+    ./haskell.nix
     ./java.nix
     ./lua.nix
     ./markdown.nix
@@ -36,6 +37,7 @@ in {
     ./csharp.nix
     ./julia.nix
     ./nu.nix
+    ./odin.nix
   ];
 
   options.vim.languages = {

modules/plugins/languages/haskell.nix

@@ -0,0 +1,104 @@
+{
+  config,
+  lib,
+  pkgs,
+  ...
+}: let
+  inherit (builtins) isList;
+  inherit (lib.types) either package listOf str;
+  inherit (lib.options) mkEnableOption mkOption;
+  inherit (lib.strings) optionalString;
+  inherit (lib.modules) mkIf mkMerge;
+  inherit (lib.nvim.types) mkGrammarOption;
+  inherit (lib.nvim.dag) entryAfter;
+  inherit (lib.nvim.lua) expToLua;
+  inherit (pkgs) haskellPackages;
+
+  cfg = config.vim.languages.haskell;
+in {
+  options.vim.languages.haskell = {
+    enable = mkEnableOption "Haskell support";
+
+    treesitter = {
+      enable = mkEnableOption "Treesitter support for Haskell" // {default = config.vim.languages.enableTreesitter;};
+      package = mkGrammarOption pkgs "haskell";
+    };
+
+    lsp = {
+      enable = mkEnableOption "LSP support for Haskell" // {default = config.vim.languages.enableLSP;};
+      package = mkOption {
+        description = "Haskell LSP package or command to run the Haskell LSP";
+        example = ''[ (lib.getExe pkgs.haskellPackages.haskell-language-server) "--debug" ]'';
+        default = haskellPackages.haskell-language-server;
+        type = either package (listOf str);
+      };
+    };
+
+    dap = {
+      enable = mkEnableOption "DAP support for Haskell" // {default = config.vim.languages.enableDAP;};
+      package = mkOption {
+        description = "Haskell DAP package or command to run the Haskell DAP";
+        default = haskellPackages.haskell-debug-adapter;
+        type = either package (listOf str);
+      };
+    };
+  };
+
+  config = mkIf cfg.enable (mkMerge [
+    (mkIf cfg.treesitter.enable {
+      vim.treesitter = {
+        enable = true;
+        grammars = [cfg.treesitter.package];
+      };
+    })
+
+    (mkIf (cfg.dap.enable || cfg.lsp.enable) {
+      vim = {
+        startPlugins = ["haskell-tools-nvim"];
+        luaConfigRC.haskell-tools-nvim =
+          entryAfter
+          ["lsp-setup"]
+          ''
+            vim.g.haskell_tools = {
+            ${optionalString cfg.lsp.enable ''
+              -- LSP
+              tools = {
+                hover = {
+                  enable = true,
+                },
+              },
+              hls = {
+                cmd = ${
+                if isList cfg.lsp.package
+                then expToLua cfg.lsp.package
+                else ''{"${cfg.lsp.package}/bin/haskell-language-server-wrapper"}''
+              },
+                on_attach = function(client, bufnr, ht)
+                  default_on_attach(client, bufnr, ht)
+                  local opts = { noremap = true, silent = true, buffer = bufnr }
+                  vim.keymap.set('n', '<localleader>cl', vim.lsp.codelens.run, opts)
+                  vim.keymap.set('n', '<localleader>hs', ht.hoogle.hoogle_signature, opts)
+                  vim.keymap.set('n', '<localleader>ea', ht.lsp.buf_eval_all, opts)
+                  vim.keymap.set('n', '<localleader>rr', ht.repl.toggle, opts)
+                  vim.keymap.set('n', '<localleader>rf', function()
+                    ht.repl.toggle(vim.api.nvim_buf_get_name(0))
+                  end, opts)
+                  vim.keymap.set('n', '<localleader>rq', ht.repl.quit, opts)
+                end,
+              },
+            ''}
+            ${optionalString cfg.dap.enable ''
+              dap = {
+                cmd = ${
+                if isList cfg.dap.package
+                then expToLua cfg.dap.package
+                else ''{"${cfg.dap.package}/bin/haskell-debug-adapter"}''
+              },
+              },
+            ''}
+            }
+          '';
+      };
+    })
+  ]);
+}

modules/plugins/languages/markdown.nix

@@ -4,13 +4,14 @@
   lib,
   ...
 }: let
-  inherit (builtins) attrNames concatLists;
+  inherit (builtins) attrNames;
   inherit (lib.modules) mkIf mkMerge;
   inherit (lib.options) mkEnableOption mkOption;
-  inherit (lib.lists) isList;
+  inherit (lib.lists) isList concatLists;
   inherit (lib.types) bool enum either package listOf str;
-  inherit (lib.nvim.lua) expToLua;
-  inherit (lib.nvim.types) mkGrammarOption;
+  inherit (lib.nvim.lua) expToLua toLuaObject;
+  inherit (lib.nvim.types) mkGrammarOption mkPluginSetupOption;
+  inherit (lib.nvim.dag) entryAnywhere;
 
   cfg = config.vim.languages.markdown;
   defaultServer = "marksman";
@@ -98,6 +99,29 @@ in {
         description = "Extra filetypes to format with the Markdown formatter";
       };
     };
+
+    extensions = {
+      render-markdown-nvim = {
+        enable =
+          mkEnableOption ""
+          // {
+            description = ''
+              [render-markdown.nvim]: https://github.com/MeanderingProgrammer/render-markdown.nvim
+
+              Inline Markdown rendering with [render-markdown.nvim]
+
+            '';
+          };
+
+        setupOpts = mkPluginSetupOption "render-markdown" {
+          auto_override_publish_diagnostics = mkOption {
+            description = "Automatically override the publish_diagnostics handler";
+            type = bool;
+            default = true;
+          };
+        };
+      };
+    };
   };
 
   config = mkIf cfg.enable (mkMerge [
@@ -115,5 +139,13 @@ in {
       vim.lsp.null-ls.enable = true;
       vim.lsp.null-ls.sources.markdown-format = formats.${cfg.format.type}.nullConfig;
     })
+
+    # Extensions
+    (mkIf cfg.extensions.render-markdown-nvim.enable {
+      vim.startPlugins = ["render-markdown-nvim"];
+      vim.pluginRC.render-markdown-nvim = entryAnywhere ''
+        require("render-markdown").setup(${toLuaObject cfg.extensions.render-markdown-nvim.setupOpts})
+      '';
+    })
   ]);
 }

modules/plugins/languages/odin.nix

@@ -0,0 +1,71 @@
+{
+  config,
+  pkgs,
+  lib,
+  ...
+}: let
+  inherit (builtins) attrNames;
+  inherit (lib.options) mkEnableOption mkOption;
+  inherit (lib.modules) mkIf mkMerge;
+  inherit (lib.lists) isList;
+  inherit (lib.types) either listOf package str enum;
+  inherit (lib.nvim.lua) expToLua;
+  inherit (lib.nvim.types) mkGrammarOption;
+
+  defaultServer = "ols";
+  servers = {
+    ols = {
+      package = pkgs.ols;
+      lspConfig = ''
+        lspconfig.ols.setup {
+          capabilities = capabilities,
+          on_attach = default_on_attach,
+          cmd = ${
+          if isList cfg.lsp.package
+          then expToLua cfg.lsp.package
+          else "{'${cfg.lsp.package}/bin/ols'}"
+        }
+        }
+      '';
+    };
+  };
+
+  cfg = config.vim.languages.odin;
+in {
+  options.vim.languages.odin = {
+    enable = mkEnableOption "Odin language support";
+
+    treesitter = {
+      enable = mkEnableOption "Odin treesitter" // {default = config.vim.languages.enableTreesitter;};
+      package = mkGrammarOption pkgs "odin";
+    };
+
+    lsp = {
+      enable = mkEnableOption "Odin LSP support" // {default = config.vim.languages.enableLSP;};
+
+      server = mkOption {
+        type = enum (attrNames servers);
+        default = defaultServer;
+        description = "Odin LSP server to use";
+      };
+
+      package = mkOption {
+        description = "Ols package, or the command to run as a list of strings";
+        type = either package (listOf str);
+        default = pkgs.ols;
+      };
+    };
+  };
+
+  config = mkIf cfg.enable (mkMerge [
+    (mkIf cfg.treesitter.enable {
+      vim.treesitter.enable = true;
+      vim.treesitter.grammars = [cfg.treesitter.package];
+    })
+
+    (mkIf cfg.lsp.enable {
+      vim.lsp.lspconfig.enable = true;
+      vim.lsp.lspconfig.sources.odin-lsp = servers.${cfg.lsp.server}.lspConfig;
+    })
+  ]);
+}

modules/plugins/languages/rust.nix

@@ -13,7 +13,7 @@
   inherit (lib.types) bool package str listOf either enum;
   inherit (lib.nvim.types) mkGrammarOption;
   inherit (lib.nvim.lua) expToLua;
-  inherit (lib.nvim.dag) entryAnywhere;
+  inherit (lib.nvim.dag) entryAfter entryAnywhere;
 
   cfg = config.vim.languages.rust;
 
@@ -127,7 +127,7 @@ in {
       vim = {
         startPlugins = ["rustaceanvim"];
 
-        luaConfigRC.rustaceanvim = entryAnywhere ''
+        pluginRC.rustaceanvim = entryAfter ["lsp-setup"] ''
           vim.g.rustaceanvim = {
           ${optionalString cfg.lsp.enable ''
             -- LSP

modules/plugins/languages/ts.nix

@@ -23,8 +23,11 @@
       package = pkgs.typescript-language-server;
       lspConfig = ''
         lspconfig.ts_ls.setup {
-          capabilities = capabilities;
-          on_attach = attach_keymaps,
+          capabilities = capabilities,
+          on_attach = function(client, bufnr)
+            attach_keymaps(client, bufnr);
+            client.server_capabilities.documentFormattingProvider = false;
+          end,
           cmd = ${
           if isList cfg.lsp.package
           then expToLua cfg.lsp.package
@@ -79,6 +82,7 @@
           ls_sources,
           null_ls.builtins.formatting.prettier.with({
             command = "${cfg.format.package}/bin/prettier",
+            filetypes = { "typescript" },
           })
         )
       '';

modules/plugins/languages/zig.nix

@@ -6,7 +6,7 @@
 }: let
   inherit (builtins) attrNames;
   inherit (lib.options) mkEnableOption mkOption;
-  inherit (lib.modules) mkIf mkMerge;
+  inherit (lib.modules) mkIf mkMerge mkDefault;
   inherit (lib.lists) isList;
   inherit (lib.types) either listOf package str enum;
   inherit (lib.nvim.lua) expToLua;
@@ -57,15 +57,25 @@ in {
       };
     };
   };
+
   config = mkIf cfg.enable (mkMerge [
     (mkIf cfg.treesitter.enable {
-      vim.treesitter.enable = true;
-      vim.treesitter.grammars = [cfg.treesitter.package];
+      vim.treesitter = {
+        enable = true;
+        grammars = [cfg.treesitter.package];
+      };
     })
 
     (mkIf cfg.lsp.enable {
-      vim.lsp.lspconfig.enable = true;
-      vim.lsp.lspconfig.sources.zig-lsp = servers.${cfg.lsp.server}.lspConfig;
+      vim = {
+        lsp.lspconfig = {
+          enable = true;
+          sources.zig-lsp = servers.${cfg.lsp.server}.lspConfig;
+        };
+
+        # nvf handles autosaving already
+        globals.zig_fmt_autosave = mkDefault 0;
+      };
     })
   ]);
 }

modules/plugins/runner/run-nvim/config.nix

@@ -20,17 +20,9 @@ in {
         cmd = "Run";
 
         keys = [
-          (mkKeymap "n" cfg.mappings.run "<cmd>Run<CR>" {desc = mappings.run.description;})
-          (mkKeymap "n" cfg.mappings.runOverride "<cmd>Run!<CR>" {desc = mappings.runOverride.description;})
-          (mkKeymap "n" cfg.mappings.runCommand ''
-              function()
-                local input = vim.fn.input("Run command: ")
-                if input ~= "" then require("run").run(input, false) end
-              end
-            '' {
-              desc = mappings.run.description;
-              lua = true;
-            })
+          (mkKeymap "n" cfg.mappings.run "<cmd>Run<cr>" {desc = mappings.run.description;})
+          (mkKeymap "n" cfg.mappings.runOverride "<cmd>Run!<cr>" {desc = mappings.runOverride.description;})
+          (mkKeymap "n" cfg.mappings.runCommand "<cmd>RunPrompt<cr>" {desc = mappings.run.description;})
         ];
       };
 

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

@@ -14,17 +14,9 @@ in {
       startPlugins = ["nvim-notify"];
 
       pluginRC.nvim-notify = entryAnywhere ''
-        require('notify').setup(${toLuaObject cfg.setupOpts})
-
-        -- required to fix offset_encoding errors
-        local notify = vim.notify
-        vim.notify = function(msg, ...)
-          if msg:match("warning: multiple different client offset_encodings") then
-            return
-          end
-
-          notify(msg, ...)
-        end
+        local notify = require("notify")
+        notify.setup(${toLuaObject cfg.setupOpts})
+        vim.notify = notify.notify
       '';
     };
   };

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

@@ -28,7 +28,7 @@ in {
       };
 
       stages = mkOption {
-        type = enum ["fade_in_slide_out" "fade_in" "slide_out" "none"];
+        type = enum ["fade_in_slide_out" "fade" "slide" "static"];
         default = "fade_in_slide_out";
         description = "The stages of the notification";
       };
@@ -41,7 +41,7 @@ in {
 
       background_colour = mkOption {
         type = str;
-        default = "#000000";
+        default = "NotifyBackground";
         description = "The background colour of the notification";
       };
 

modules/plugins/utility/default.nix

@@ -1,5 +1,6 @@
 {
   imports = [
+    ./outline
     ./binds
     ./ccc
     ./gestures

modules/plugins/utility/outline/aerial-nvim/aerial-nvim.nix

@@ -0,0 +1,14 @@
+{lib, ...}: let
+  inherit (lib.options) mkEnableOption;
+  inherit (lib.nvim.types) mkPluginSetupOption;
+  inherit (lib.nvim.binds) mkMappingOption;
+in {
+  options.vim.utility.outline.aerial-nvim = {
+    enable = mkEnableOption "Aerial.nvim";
+    setupOpts = mkPluginSetupOption "aerial.nvim" {};
+
+    mappings = {
+      toggle = mkMappingOption "Toggle aerial window" "gO";
+    };
+  };
+}

modules/plugins/utility/outline/aerial-nvim/config.nix

@@ -0,0 +1,42 @@
+{
+  options,
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib.modules) mkIf;
+  inherit (lib.nvim.binds) mkKeymap;
+
+  cfg = config.vim.utility.outline.aerial-nvim;
+  inherit (options.vim.utility.outline.aerial-nvim) mappings;
+in {
+  config = mkIf cfg.enable {
+    vim = {
+      lazy.plugins.aerial-nvim = {
+        package = "aerial-nvim";
+
+        setupModule = "aerial";
+        inherit (cfg) setupOpts;
+
+        cmd = [
+          "AerialClose"
+          "AerialCloseAll"
+          "AerialGo"
+          "AerialInfo"
+          "AerialNavClose"
+          "AerialNavOpen"
+          "AerialNavToggle"
+          "AerialNext"
+          "AerialOpen"
+          "AerialOpenAll"
+          "AerialPrev"
+          "AerialToggle"
+        ];
+
+        keys = [
+          (mkKeymap "n" cfg.mappings.toggle ":AerialToggle<CR>" {desc = mappings.toggle.description;})
+        ];
+      };
+    };
+  };
+}

modules/plugins/utility/outline/aerial-nvim/default.nix

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

modules/plugins/utility/outline/default.nix

@@ -0,0 +1,5 @@
+{
+  imports = [
+    ./aerial-nvim
+  ];
+}

modules/plugins/utility/preview/markdown-preview/config.nix

@@ -4,8 +4,8 @@
   lib,
   ...
 }: let
-  inherit (lib.strings) concatMapStringsSep;
   inherit (lib.modules) mkIf;
+
   cfg = config.vim.utility.preview.markdownPreview;
 in {
   config = mkIf cfg.enable {
@@ -15,7 +15,7 @@ in {
       mkdp_auto_start = cfg.autoStart;
       mkdp_auto_close = cfg.autoClose;
       mkdp_refresh_slow = cfg.lazyRefresh;
-      mkdp_filetypes = [(concatMapStringsSep ", " (x: "'" + x + "'") cfg.filetypes)];
+      mkdp_filetypes = cfg.filetypes;
       mkdp_command_for_global = cfg.alwaysAllowPreview;
       mkdp_open_to_the_world = cfg.broadcastServer;
       mkdp_open_ip = cfg.customIP;

modules/plugins/utility/surround/config.nix

@@ -4,51 +4,33 @@
   ...
 }: let
   inherit (lib.modules) mkIf;
-  inherit (lib.nvim.dag) entryAnywhere;
-  inherit (lib.nvim.lua) toLuaObject;
 
   cfg = config.vim.utility.surround;
   mkLznKey = mode: key: {
-    inherit key mode;
+    inherit mode key;
   };
 in {
   config = mkIf cfg.enable {
     vim = {
-      startPlugins = ["nvim-surround"];
-      pluginRC.surround = entryAnywhere "require('nvim-surround').setup(${toLuaObject cfg.setupOpts})";
-
       lazy.plugins.nvim-surround = {
         package = "nvim-surround";
+
         setupModule = "nvim-surround";
         inherit (cfg) setupOpts;
 
-        keys =
-          [
-            (mkLznKey ["i"] cfg.setupOpts.keymaps.insert)
-            (mkLznKey ["i"] cfg.setupOpts.keymaps.insert_line)
-            (mkLznKey ["x"] cfg.setupOpts.keymaps.visual)
-            (mkLznKey ["x"] cfg.setupOpts.keymaps.visual_line)
-            (mkLznKey ["n"] cfg.setupOpts.keymaps.normal)
-            (mkLznKey ["n"] cfg.setupOpts.keymaps.normal_cur)
-            (mkLznKey ["n"] cfg.setupOpts.keymaps.normal_line)
-            (mkLznKey ["n"] cfg.setupOpts.keymaps.normal_cur_line)
-            (mkLznKey ["n"] cfg.setupOpts.keymaps.delete)
-            (mkLznKey ["n"] cfg.setupOpts.keymaps.change)
-            (mkLznKey ["n"] cfg.setupOpts.keymaps.change_line)
-          ]
-          ++ map (mkLznKey ["n" "i" "v"]) [
-            "<Plug>(nvim-surround-insert)"
-            "<Plug>(nvim-surround-insert-line)"
-            "<Plug>(nvim-surround-normal)"
-            "<Plug>(nvim-surround-normal-cur)"
-            "<Plug>(nvim-surround-normal-line)"
-            "<Plug>(nvim-surround-normal-cur-line)"
-            "<Plug>(nvim-surround-visual)"
-            "<Plug>(nvim-surround-visual-line)"
-            "<Plug>(nvim-surround-delete)"
-            "<Plug>(nvim-surround-change)"
-            "<Plug>(nvim-surround-change-line)"
-          ];
+        keys = [
+          (mkLznKey "i" cfg.setupOpts.keymaps.insert)
+          (mkLznKey "i" cfg.setupOpts.keymaps.insert_line)
+          (mkLznKey "x" cfg.setupOpts.keymaps.visual)
+          (mkLznKey "x" cfg.setupOpts.keymaps.visual_line)
+          (mkLznKey "n" cfg.setupOpts.keymaps.normal)
+          (mkLznKey "n" cfg.setupOpts.keymaps.normal_cur)
+          (mkLznKey "n" cfg.setupOpts.keymaps.normal_line)
+          (mkLznKey "n" cfg.setupOpts.keymaps.normal_cur_line)
+          (mkLznKey "n" cfg.setupOpts.keymaps.delete)
+          (mkLznKey "n" cfg.setupOpts.keymaps.change)
+          (mkLznKey "n" cfg.setupOpts.keymaps.change_line)
+        ];
       };
     };
   };

modules/plugins/utility/wakatime/config.nix

@@ -1,18 +1,22 @@
 {
   config,
-  lib,
   pkgs,
+  lib,
   ...
 }: let
   inherit (lib.modules) mkIf;
+  inherit (lib.meta) getExe;
 
   cfg = config.vim.utility.vim-wakatime;
 in {
   config = mkIf cfg.enable {
-    vim.startPlugins = [pkgs.vimPlugins.vim-wakatime];
+    vim = {
+      startPlugins = [pkgs.vimPlugins.vim-wakatime];
 
-    vim.pluginRC.vim-wakatime = mkIf (cfg.cli-package != null) ''
-      vim.g.wakatime_CLIPath = "${cfg.cli-package}"
-    '';
+      # Wakatime configuration is stored as vim globals.
+      globals = {
+        "wakatime_CLIPath" = mkIf (cfg.cli-package != null) "${getExe cfg.cli-package}";
+      };
+    };
   };
 }

modules/plugins/utility/wakatime/default.nix

@@ -1,4 +1,4 @@
-_: {
+{
   imports = [
     ./config.nix
     ./vim-wakatime.nix

modules/plugins/utility/wakatime/vim-wakatime.nix

@@ -1,18 +1,24 @@
 {
-  lib,
   pkgs,
+  lib,
   ...
 }: let
   inherit (lib.options) mkEnableOption mkOption;
   inherit (lib.types) nullOr package;
 in {
   options.vim.utility.vim-wakatime = {
-    enable = mkEnableOption "vim-wakatime: live code statistics";
+    enable = mkEnableOption ''
+      automatic time tracking and metrics generated from your programming activity [vim-wakatime]
+    '';
 
     cli-package = mkOption {
       type = nullOr package;
-      default = pkgs.wakatime;
-      description = "The package that should be used for wakatime-cli. Set as null to use the default path in `$XDG_DATA_HOME`";
+      default = pkgs.wakatime-cli;
+      example = null;
+      description = ''
+        The package that should be used for wakatime-cli.
+        Set as null to use the default path in {env}`$XDG_DATA_HOME`
+      '';
     };
   };
 }