Merge fbe0d142e4 into a1bac1d356

utility/aerial.nvim: init

.github/README.md

@@ -206,6 +206,16 @@ features.
 
 ## Credits
 
+### Co-Maintainers
+
+Alongside myself, nvf is developed by those talented folk:
+
+- [**@horriblename**](https://github.com/horriblename) - For actively
+  implementing planned features and quality of life updates.
+- [**@Diniamo**](https://github.com/Diniamo)
+  ([Liberapay](https://en.liberapay.com/diniamo/)) - For actively submitting
+  pull requests, issues and assistance with maintenance of nvf.
+
 ### Contributors
 
 [mnw]: https://github.com/gerg-l/mnw
@@ -213,21 +223,19 @@ features.
 nvf would not be what it is today without the awesome people below. Special,
 heart-felt thanks to
 
-- [@fufexan](https://github.com/fufexan) - For the transition to flake-parts and
+- [**@fufexan**](https://github.com/fufexan) - For the transition to flake-parts
-  invaluable Nix assistance.
+  and invaluable Nix assistance.
-- [@FlafyDev](https://github.com/FlafyDev) - For getting home-manager module to
+- [**@FlafyDev**](https://github.com/FlafyDev) - For getting Home-Manager module
-  work and Nix assistance.
+  to work and Nix assistance.
-- [@n3oney](https://github.com/n3oney) - For making custom keybinds finally
+- [**@n3oney**](https://github.com/n3oney) - For making custom keybinds finally
   possible, and other module additions.
-- [@horriblename](https://github.com/horriblename) - For actively implementing
+- [**@Yavko**](https://github.com/Yavko) - For the amazing **nvf** logo
-  planned features and quality of life updates.
+- [**@FrothyMarrow**](https://github.com/FrothyMarrow) - For seeing mistakes
-- [@Yavko](https://github.com/Yavko) - For the amazing **nvf** logo
+  that I could not.
-- [@FrothyMarrow](https://github.com/FrothyMarrow) - For seeing mistakes that I
+- [**@Gerg-l**](https://github.com/gerg-l) 🐸 - For the modern Neovim wrapper,
-  could not.
+  [mnw], and occasional code improvements.
-- [@Diniamo](https://github.com/Diniamo) - For actively submitting pull
+- [**@Soliprem**](https://github.com/soliprem) - Rigorously implementing missing
-  requests, issues and assistance with maintenance of nvf.
+  features and excellent work on new language modules.
-- [@Gerg-l](https://github.com/gerg-l) - For the modern Neovim wrapper, [mnw],
-  and occasional code improvements.
 
 and everyone who has submitted issues or pull requests!
 

docs/manual/installation/modules/home-manager.md

@@ -44,12 +44,15 @@ Followed by importing the home-manager module somewhere in your configuration.
   };
 
   outputs = { nixpkgs, home-manager, nvf, ... }: let
-  system = "x86_64-linux"; in {
+    system = "x86_64-linux";
+    pkgs = nixpkgs.legacyPackages.${system};
+  in {
     # ↓ this is your home output in the flake schema, expected by home-manager
-    "your-username@your-hostname" = home-manager.lib.homeManagerConfiguration
+    "your-username@your-hostname" = home-manager.lib.homeManagerConfiguration {
+      inherit pkgs;
       modules = [
         nvf.homeManagerModules.default # <- this imports the home-manager module that provides the options
-        ./home.nix # <- your home entrypoint
+        ./home.nix # <- your home entrypoint, `programs.nvf.*` may be defined here
       ];
     };
   };

docs/manual/installation/modules/nixos.md

@@ -42,13 +42,12 @@ Followed by importing the NixOS module somewhere in your configuration.
     nvf.url = "github:notashelf/nvf";
   };
 
-  outputs = { nixpkgs, nvf, ... }: let
+  outputs = { nixpkgs, nvf, ... }: {
-  system = "x86_64-linux"; in {
     # ↓ this is your host output in the flake schema
-    nixosConfigurations."yourUsername»" = nixpkgs.lib.nixosSystem {
+    nixosConfigurations."your-hostname" = nixpkgs.lib.nixosSystem {
       modules = [
         nvf.nixosModules.default # <- this imports the NixOS module that provides the options
-        ./configuration.nix # <- your host entrypoint
+        ./configuration.nix # <- your host entrypoint, `programs.nvf.*` may be defined here
       ];
     };
   };

docs/manual/manual.md

@@ -11,6 +11,7 @@ try-it-out.md
 default-configs.md
 installation.md
 configuring.md
+tips.md
 ```
 
 ```{=include=} chapters

docs/manual/tips.md

@@ -0,0 +1,6 @@
+# Helpful Tips {#ch-helpful-tips}
+
+```{=include=} chapters
+tips/debugging-nvf.md
+tips/offline-docs.md
+```

docs/manual/tips/debugging-nvf.md

@@ -0,0 +1,19 @@
+# Debugging nvf {#sec-debugging-nvf}
+
+There may be instances where the your Nix configuration evaluates to invalid
+Lua, or times when you will be asked to provide your built Lua configuration for
+easier debugging by nvf maintainers. nvf provides two helpful utilities out of
+the box.
+
+**nvf-print-config** and **nvf-print-config-path** will be bundled with nvf as
+lightweight utilities to help you view or share your built configuration when
+necessary.
+
+To view your configuration with syntax highlighting, you may use the
+[bat pager](https://github.com/sharkdp/bat).
+
+```bash
+nvf-print-config | bat --language=lua
+```
+
+Alternatively, `cat` or `less` may also be used.

docs/manual/tips/offline-docs.md

@@ -0,0 +1,11 @@
+# Offline Documentation {#sec-offline-documentation}
+
+[https://notashelf.github.io/nvf/options.html]: https://notashelf.github.io/nvf/options.html
+
+The manpages provided by nvf contains an offline version of the option search
+normally available at [https://notashelf.github.io/nvf/options.html]. You may
+use the `man 5 nvf` command to view option documentation from the comfort of
+your terminal.
+
+Note that this is only available for NixOS and Home-Manager module
+installations.

docs/release-notes/rl-0.8.md

@@ -13,6 +13,9 @@
 - Add [render-markdown.nvim] under
   `languages.markdown.extensions.render-markdown-nvim`
 
+- Implement [](#opt-vim.git.gitsigns.setupOpts) for user-specified setup table
+  in gitsigns configuration.
+
 [amadaluzia](https://github.com/amadaluzia):
 
 [haskell-tools.nvim]: https://github.com/MrcJkb/haskell-tools.nvim
@@ -25,3 +28,9 @@
 
 - Disable the built-in format-on-save feature of zls. Use `vim.lsp.formatOnSave`
   instead.
+
+[horriblename](https://github.com/horriblename):
+
+[aerial.nvim](https://github.com/stevearc/aerial.nvim)
+
+- Add [aerial.nvim]

flake.lock

@@ -156,6 +156,22 @@
         "type": "sourcehut"
       }
     },
+    "plugin-aerial-nvim": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1736064692,
+        "narHash": "sha256-7YQtkUTACTMfAGoqoFDPmRrqtw+ypxDbeLCTB3sy4Us=",
+        "owner": "stevearc",
+        "repo": "aerial.nvim",
+        "rev": "b3ec25ca8c347fafa976484a6cace162239112e1",
+        "type": "github"
+      },
+      "original": {
+        "owner": "stevearc",
+        "repo": "aerial.nvim",
+        "type": "github"
+      }
+    },
     "plugin-alpha-nvim": {
       "flake": false,
       "locked": {
@@ -2090,6 +2106,7 @@
         "nil": "nil",
         "nixpkgs": "nixpkgs",
         "nmd": "nmd",
+        "plugin-aerial-nvim": "plugin-aerial-nvim",
         "plugin-alpha-nvim": "plugin-alpha-nvim",
         "plugin-base16": "plugin-base16",
         "plugin-bufdelete-nvim": "plugin-bufdelete-nvim",

flake.nix

@@ -730,5 +730,10 @@
       url = "github:mrcjkb/haskell-tools.nvim";
       flake = false;
     };
+
+    plugin-aerial-nvim = {
+      url = "github:stevearc/aerial.nvim";
+      flake = false;
+    };
   };
 }

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 (options.vim.filetree.nvimTree) mappings;
-  inherit (self.options.vim.filetree.nvimTree) mappings;
 in {
   config = mkIf cfg.enable {
     vim = {

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/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/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) ''
+      # Wakatime configuration is stored as vim globals.
-      vim.g.wakatime_CLIPath = "${cfg.cli-package}"
+      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;
+      default = pkgs.wakatime-cli;
-      description = "The package that should be used for wakatime-cli. Set as null to use the default path in `$XDG_DATA_HOME`";
+      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`
+      '';
     };
   };
 }