utility/yanky-nvim: init

modules/plugins/utility/yanky-nvim/config.nix

@@ -0,0 +1,32 @@
+{
+  config,
+  pkgs,
+  lib,
+  ...
+}: let
+  inherit (lib.modules) mkIf;
+  inherit (lib.lists) optionals concatLists;
+  inherit (lib.nvim.lua) toLuaObject;
+  inherit (lib.nvim.dag) entryAnywhere;
+
+  cfg = config.vim.utility.yanky-nvim;
+  usingSqlite = cfg.setupOpts.ring.storage == "sqlite";
+in {
+  config = mkIf cfg.enable {
+    vim = {
+      # TODO: this could probably be lazyloaded. I'm not yet sure which event is
+      # ideal, so it's loaded normally for now.
+      startPlugins = concatLists [
+        ["yanky-nvim"]
+
+        # If using the sqlite backend, sqlite-lua must be loaded
+        # alongside yanky.
+        (optionals usingSqlite [pkgs.vimPlugins.sqlite-lua])
+      ];
+
+      pluginRC.yanky-nvim = entryAnywhere ''
+        require("yanky").setup(${toLuaObject cfg.setupOpts});
+      '';
+    };
+  };
+}

modules/plugins/utility/yanky-nvim/default.nix

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

modules/plugins/utility/yanky-nvim/yanky-nvim.nix

@@ -0,0 +1,28 @@
+{lib, ...}: let
+  inherit (lib.options) mkEnableOption mkOption;
+  inherit (lib.types) enum;
+in {
+  options.vim.utility.yanky-nvim = {
+    enable = mkEnableOption ''
+      improved Yank and Put functionalities for Neovim  [yanky-nvim]
+    '';
+
+    setupOpts = {
+      ring.storage = mkOption {
+        type = enum ["shada" "sqlite" "memory"];
+        default = "shada";
+        example = "sqlite";
+        description = ''
+          storage mode for ring values.
+
+          - shada: this will save pesistantly using Neovim ShaDa feature.
+            This means that history will be persisted between each session of Neovim.
+          - memory: each Neovim instance will have his own history and it will be
+            lost between sessions.
+          - sqlite: more reliable than `shada`, requires `sqlite.lua` as a dependency.
+            nvf will add this dependency to `PATH` automatically.
+        '';
+      };
+    };
+  };
+}