neovim: add extended obsidian plugin module

outputs/pkgs/ook-vim/modules/default.nix

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

outputs/pkgs/ook-vim/modules/plugins/default.nix

@@ -0,0 +1,7 @@
+{
+  imports = [
+    ./gruvbox-material
+    ./telescope
+    ./obsidian
+  ];
+}

outputs/pkgs/ook-vim/modules/plugins/gruvbox-material/config.nix

@@ -0,0 +1,80 @@
+{
+  config,
+  lib,
+  inputs,
+  pkgs,
+  ...
+}: let
+  inherit (lib) mkOption mkIf boolToString;
+  inherit (lib.types) bool enum lines;
+  inherit (lib.nvim.dag) entryAfter;
+
+  cfg = config.vim.gruvbox-material;
+in {
+  options.vim.gruvbox-material = {
+    enable = mkOption {
+      type = bool;
+      description = "Enable gruvbox-material-theme";
+      default = false;
+    };
+    contrast = mkOption {
+      type = enum ["dark" "medium" "soft"];
+      description = "Set contrast, can be any of 'hard', 'medium', 'soft'";
+      default = "dark";
+    };
+    italics = mkOption {
+      type = bool;
+      description = "Enable italic comments";
+      default = true;
+    };
+    transparent = mkOption {
+      type = bool;
+      description = "Set background to transparent";
+      default = false;
+    };
+    floatForceBackground = mkOption {
+      type = bool;
+      description = "Force backgrounds on floats even when transparent = true";
+      default = false;
+    };
+    signsHighlight = mkOption {
+      type = bool;
+      description = "Enable sign highlighting";
+      default = true;
+    };
+    extraConfig = mkOption {
+      type = lines;
+      description = "Additional lua configuration after";
+    };
+  };
+
+  config = mkIf cfg.enable {
+    vim = {
+      startPlugins = [pkgs.vimPlugins.gruvbox-material-nvim];
+      luaConfigRC.theme =
+        entryAfter ["basic"]
+        /*
+        lua
+        */
+        ''
+          require('gruvbox-material').setup{
+            contrast = "${cfg.contrast}",
+            comments = {
+              italics = ${boolToString cfg.italics},
+            },
+            background = {
+              transparent = ${boolToString cfg.transparent},
+            },
+            float = {
+              force_background = ${boolToString cfg.floatForceBackground},
+              background_color = nil,
+            },
+            signs = {
+              highlight = ${boolToString cfg.signsHighlight},
+            },
+          }
+          ${cfg.extraConfig}
+        '';
+    };
+  };
+}

outputs/pkgs/ook-vim/modules/plugins/gruvbox-material/default.nix

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

outputs/pkgs/ook-vim/modules/plugins/obsidian/config.nix

@@ -0,0 +1,37 @@
+{
+  config,
+  lib,
+  options,
+  ...
+}: let
+  inherit (lib.modules) mkIf;
+  inherit (lib.nvim.dag) entryAnywhere;
+  inherit (lib.nvim.lua) toLuaObject;
+  inherit (lib.nvim.binds) mkKeymap pushDownDefault;
+  inherit (options.vim.notes.obsidianExtended) mappings;
+
+  cfg = config.vim.notes.obsidianExtended;
+  keys = cfg.mappings;
+in {
+  config = mkIf cfg.enable {
+    vim = {
+      startPlugins = [
+        "obsidian-nvim"
+        "vim-markdown"
+        "tabular"
+      ];
+
+      binds.whichKey.register = pushDownDefault {
+        "<leader>o" = "+Notes";
+      };
+
+      pluginRC.obsidian = entryAnywhere ''
+        require("obsidian").setup(${toLuaObject cfg.setupOpts})
+      '';
+      keymaps = [
+        (mkKeymap "n" keys.openNote "<cmd>ObsidianOpen<CR>" {desc = mappings.openNote.description;})
+        (mkKeymap "n" keys.findNote "<cmd>ObsidianQuickSwitch<CR>" {desc = mappings.findNote.description;})
+      ];
+    };
+  };
+}

outputs/pkgs/ook-vim/modules/plugins/obsidian/default.nix

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

outputs/pkgs/ook-vim/modules/plugins/obsidian/obsidian.nix

@@ -0,0 +1,90 @@
+{
+  lib,
+  config,
+  ...
+}: let
+  inherit (lib.options) mkOption mkEnableOption;
+  inherit (lib.types) str nullOr bool enum;
+  inherit (lib.nvim.binds) mkMappingOption;
+  inherit (lib.nvim.types) mkPluginSetupOption;
+in {
+  options.vim.notes.obsidianExtended = {
+    enable = mkEnableOption "Complementary neovim plugin for Obsidian editor";
+    setupOpts = mkPluginSetupOption "Obsidian.nvim" {
+      dir = mkOption {
+        type = str;
+        default = "~/my-vault";
+        description = "Location of Obsidian vault directory";
+      };
+      daily_notes = {
+        folder = mkOption {
+          type = nullOr str;
+          default = null;
+          description = "Directory in which daily notes should be created";
+        };
+        date_format = mkOption {
+          type = nullOr str;
+          default = null;
+          description = "Date format used for creating daily notes";
+        };
+      };
+      completion = {
+        nvim_cmp = mkOption {
+          # If using nvim-cmp, otherwise set to false
+          type = bool;
+          description = "If using nvim-cmp, otherwise set to false";
+          default = config.vim.autocomplete.nvim-cmp.enable;
+        };
+      };
+      new_notes_location = mkOption {
+        type = nullOr (enum ["current_dir" "notes_subdir"]);
+        default = null;
+        description = ''
+          Where to put new notes. Valid options are:
+          * "current_dir" - put notes in same directory as current buffer
+          * "notes_subdir" - put notes in the default notes subdirectory
+
+          default option: "current_dir"
+        '';
+      };
+      templates = {
+        folder = mkOption {
+          type = nullOr str;
+          default = null;
+          description = "Obsidian templates directory";
+        };
+        date_format = mkOption {
+          type = nullOr str;
+          default = null;
+          description = "Date format used for templates";
+        };
+        time_format = mkOption {
+          type = nullOr str;
+          default = null;
+          description = "Time format used for templates";
+        };
+      };
+      preferred_link_style = mkOption {
+        type = nullOr (enum ["wiki" "markdown"]);
+        default = null;
+        description = ''
+          Either "wiki" or "markdown"
+        '';
+      };
+      ui = {
+        enable = mkOption {
+          type = nullOr bool;
+          default = null;
+          description = ''
+            Set to false to disable all additional syntax features
+          '';
+        };
+        # TODO: add rest of ui options
+      };
+    };
+    mappings = {
+      openNote = mkMappingOption "Open note in obsidian" "<leader>oo";
+      findNote = mkMappingOption "Open finder in obsidian vault" "<leader>of";
+    };
+  };
+}

outputs/pkgs/ook-vim/modules/plugins/telescope/config.nix

@@ -0,0 +1,55 @@
+{
+  config,
+  lib,
+  inputs,
+  ...
+}: let
+  inherit (lib) mkIf mkOption;
+  inherit (lib.types) bool;
+  inherit (inputs.nvf.lib.nvim.dag) entryAfter;
+  cfg = config.vim.telescope;
+in {
+  options.vim.telescope = {
+    autostart = mkOption {
+      type = bool;
+      default = false;
+      description = "Auto start telescope when opening neovim unless opening a file";
+    };
+  };
+  config = mkIf cfg.autostart {
+    vim.luaConfigRC.telescope-autostart =
+      entryAfter ["pluginConfigs"]
+      #lua
+      ''
+        local find_files_hijack_netrw = vim.api.nvim_create_augroup("find_files_hijack_netrw", { clear = true })
+        -- clear FileExplorer appropriately to prevent netrw from launching on folders
+        -- netrw may or may not be loaded before telescope-find-files
+        -- conceptual credits to nvim-tree and telescope-file-browser
+        vim.api.nvim_create_autocmd("VimEnter", {
+            pattern = "*",
+            once = true,
+            callback = function()
+                pcall(vim.api.nvim_clear_autocmds, { group = "FileExplorer" })
+            end,
+        })
+        vim.api.nvim_create_autocmd("BufEnter", {
+            group = find_files_hijack_netrw,
+            pattern = "*",
+            callback = function()
+                vim.schedule(function()
+                    -- Early return if netrw or not a directory
+                    if vim.bo[0].filetype == "netrw" or vim.fn.isdirectory(vim.fn.expand("%:p")) == 0 then
+                        return
+                    end
+
+                    vim.api.nvim_buf_set_option(0, "bufhidden", "wipe")
+
+                    require("telescope.builtin").find_files({
+                        cwd = vim.fn.expand("%:p:h"),
+                    })
+                end)
+            end,
+        })
+      '';
+  };
+}

outputs/pkgs/ook-vim/modules/plugins/telescope/default.nix

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