modules/lsp: add nvim-docs-view

A neovim plugin to display lsp hover documentation in a side panel.

modules/lsp/default.nix

@@ -16,5 +16,6 @@ _: {
     ./lightbulb
     ./lspkind
     ./lsplines
+    ./nvim-docs-view
   ];
 }

modules/lsp/nvim-docs-view/config.nix

@@ -0,0 +1,26 @@
+{
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib) mkIf nvim;
+  inherit (builtins) toString;
+
+  cfg = config.vim.lsp.nvim-docs-view;
+in {
+  config = mkIf cfg.enable {
+    vim = {
+      lsp.enable = true;
+      startPlugins = ["nvim-docs-view"];
+
+      luaConfigRC.nvim-docs-view = nvim.dag.entryAnywhere ''
+        require("docs-view").setup {
+          position = "${cfg.position}",
+          width = ${toString cfg.width},
+          height = ${toString cfg.height},
+          update_mode = "${cfg.updateMode}",
+        }
+      '';
+    };
+  };
+}

modules/lsp/nvim-docs-view/default.nix

@@ -0,0 +1,6 @@
+_: {
+  imports = [
+    ./config.nix
+    ./nvim-docs-view.nix
+  ];
+}

modules/lsp/nvim-docs-view/nvim-docs-view.nix

@@ -0,0 +1,41 @@
+{lib, ...}: let
+  inherit (lib) mkEnableOption mkOption types;
+in {
+  options.vim.lsp.nvim-docs-view = {
+    enable = mkEnableOption "nvim-docs-view, for displaying lsp hover documentation in a side panel.";
+
+    position = mkOption {
+      type = types.enum ["left" "right" "top" "bottom"];
+      default = "right";
+      description = ''
+        Where to open the docs view panel
+      '';
+    };
+
+    height = mkOption {
+      type = types.int;
+      default = 10;
+      description = ''
+        Height of the docs view panel if the position is set to either top or bottom
+      '';
+    };
+
+    width = mkOption {
+      type = types.int;
+      default = 60;
+      description = ''
+        Width of the docs view panel if the position is set to either left or right
+      '';
+    };
+
+    updateMode = mkOption {
+      type = types.enum ["auto" "manual"];
+      default = "auto";
+      description = ''
+        Determines the mechanism used to update the docs view panel content.
+        - If auto, the content will update upon cursor move.
+        - If manual, the content will only update once :DocsViewUpdate is called
+      '';
+    };
+  };
+}