utility/yanky-nvim: init

configuration.nix

@@ -175,6 +175,7 @@ isMaximal: {
       icon-picker.enable = isMaximal;
       surround.enable = isMaximal;
       diffview-nvim.enable = true;
+      yanky-nvim.enable = false;
       motion = {
         hop.enable = true;
         leap.enable = true;

docs/release-notes/rl-0.8.md

@@ -4,6 +4,7 @@
 
 [typst-preview.nvim]: https://github.com/chomosuke/typst-preview.nvim
 [render-markdown.nvim]: https://github.com/MeanderingProgrammer/render-markdown.nvim
+[yanky.nvim]: https://github.com/gbprod/yanky.nvim
 
 - Add [typst-preview.nvim] under
   `languages.typst.extensions.typst-preview-nvim`.
@@ -33,10 +34,13 @@
 
 - Add [](#opt-vim.lsp.lightbulb.autocmd.enable) for manually managing the
   previously managed lightbulb autocommand.
+
   - A warning will occur if [](#opt-vim.lsp.lightbulb.autocmd.enable) and
     `vim.lsp.lightbulb.setupOpts.autocmd.enabled` are both set at the same time.
     Pick only one.
 
+- Add [yanky.nvim] to available plugins, under `vim.utility.yanky-nvim`.
+
 [amadaluzia](https://github.com/amadaluzia):
 
 [haskell-tools.nvim]: https://github.com/MrcJkb/haskell-tools.nvim

flake.nix

@@ -590,6 +590,11 @@
       flake = false;
     };
 
+    plugin-yanky-nvim = {
+      url = "github:gbprod/yanky.nvim";
+      flake = false;
+    };
+
     # Note-taking
     plugin-obsidian-nvim = {
       url = "github:epwalsh/obsidian.nvim";

modules/plugins/utility/default.nix

@@ -1,19 +1,19 @@
 {
   imports = [
-    ./outline
     ./binds
     ./ccc
+    ./diffview
+    ./fzf-lua
     ./gestures
-    ./motion
-    ./new-file-template
-    ./telescope
     ./icon-picker
     ./images
+    ./motion
+    ./new-file-template
+    ./outline
+    ./preview
+    ./surround
     ./telescope
-    ./diffview
     ./wakatime
-    ./surround
-    ./preview
-    ./fzf-lua
+    ./yanky-nvim
   ];
 }

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.
+        '';
+      };
+    };
+  };
+}