plugins/markview: v25 migration

Co-Authored-By: Matt Sturgeon <[email protected]>
nix-community · Mar 4, 2025 · d67e596 · d67e596
1 parent e11bcc8
commit d67e596
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 93 deletions.
diff --git a/plugins/by-name/markview/default.nix b/plugins/by-name/markview/default.nix
@@ -21,78 +21,80 @@ lib.nixvim.plugins.mkNeovimPlugin {
   '';
 
   settingsOptions = {
-    buf_ignore = defaultNullOpts.mkListOf types.str [ "nofile" ] ''
-      Buftypes to disable markview-nvim.
-    '';
+    preview = {
+      enable = defaultNullOpts.mkBool true ''
+        Enable preview functionality.
+      '';
 
-    modes =
-      defaultNullOpts.mkListOf types.str
-        [
-          "n"
-          "no"
-        ]
-        ''
-          Modes where preview is enabled.
-        '';
+      enable_hybrid_mode = defaultNullOpts.mkBool true ''
+        Enable hybrid mode functionality.
+      '';
 
-    hybrid_modes = defaultNullOpts.mkListOf types.str null ''
-      Modes where hybrid mode is enabled.
-    '';
+      buf_ignore = defaultNullOpts.mkListOf types.str [ "nofile" ] ''
+        Buftypes to disable markview-nvim.
+      '';
 
-    callback = {
-      on_enable = defaultNullOpts.mkLuaFn' {
-        pluginDefault = # Lua
+      modes =
+        defaultNullOpts.mkListOf types.str
+          [
+            "n"
+            "no"
+            "c"
+          ]
           ''
-            function(buf, win)
-              vim.wo[window].conceallevel = 2;
-              vim.wo[window].concealcursor = "nc";
-            end
+            Modes where preview is enabled.
           '';
-        description = ''
-          Action to perform when markview is enabled.
-        '';
-      };
 
-      on_disable = defaultNullOpts.mkLuaFn' {
-        pluginDefault = # Lua
-          ''
-            function(buf, win)
-                vim.wo[window].conceallevel = 0;
-                vim.wo[window].concealcursor = "";
-            end
-          '';
-        description = ''
-          Action to perform when markview is disabled.
-        '';
-      };
+      hybrid_modes = defaultNullOpts.mkListOf types.str null ''
+        Modes where hybrid mode is enabled.
+      '';
 
-      on_mode_change = defaultNullOpts.mkLuaFn' {
-        pluginDefault = # Lua
-          ''
-            function(buf, win, mode)
-              if vim.list_contains(markview.configuration.modes, mode) then
-                vim.wo[window].conceallevel = 2;
-              else
-                vim.wo[window].conceallevel = 0;
-              end
-            end
-          '';
-        description = ''
-          Action to perform when mode is changed, while the plugin is enabled.
-        '';
-      };
+      icon_provider = defaultNullOpts.mkEnum [ "devicons" "internal" "mini" ] "internal" ''
+        Provider for icons.
+        Available options:
+          - "devicons": Use nvim-web-devicons
+          - "internal": Use internal icons (default)
+          - "mini": Use mini.icons
+      '';
     };
   };
 
   settingsExample = {
-    buf_ignore = [ ];
-    modes = [
-      "n"
-      "x"
-    ];
-    hybrid_modes = [
-      "i"
-      "r"
-    ];
+    preview = {
+      buf_ignore = [ ];
+      modes = [
+        "n"
+        "x"
+      ];
+      hybrid_modes = [
+        "i"
+        "r"
+      ];
+    };
+  };
+
+  extraConfig = cfg: {
+    # v25 migration warning added 2025-03-04
+    warnings = lib.nixvim.mkWarnings "plugins.markview" (
+      lib.map
+        (name: {
+          when = cfg.settings ? ${name};
+          message = ''
+            v25 had a complete spec redesign. `${name}` had been moved to `preview.${
+              if name == "callback" then "callbacks" else name
+            }`.
+            See https://github.com/OXY2DEV/markview.nvim/blob/v25.0.0/doc/migration.txt#L155
+          '';
+        })
+        [
+          "buf_ignore"
+          "callback"
+          "callbacks"
+          "debounce"
+          "filetypes"
+          "hybrid_modes"
+          "modes"
+        ]
+    );
   };
 }
diff --git a/tests/test-sources/plugins/by-name/markview/default.nix b/tests/test-sources/plugins/by-name/markview/default.nix
@@ -8,37 +8,20 @@
       enable = true;
 
       settings = {
-        buf_ignore = [ "nofile" ];
-        modes = [
-          "n"
-          "no"
-        ];
-        hybrid_modes = [ ];
-        callback = {
-          on_enable = # Lua
-            ''
-              function(buf, win)
-                vim.wo[window].conceallevel = 2;
-                vim.wo[window].concealcursor = "nc";
-              end
-            '';
-          on_disable = # Lua
-            ''
-              function(buf, win)
-                  vim.wo[window].conceallevel = 0;
-                  vim.wo[window].concealcursor = "";
-              end
-            '';
-          on_mode_change = # Lua
-            ''
-              function(buf, win, mode)
-                if vim.list_contains(markview.configuration.modes, mode) then
-                  vim.wo[window].conceallevel = 2;
-                else
-                  vim.wo[window].conceallevel = 0;
-                end
-              end
-            '';
+        preview = {
+          enable = true;
+          buf_ignore = [ ];
+          icon_provider = "internal";
+          filetypes = [ ];
+          hybrid_modes = [ ];
+          ignore_previews = [ ];
+          max_buf_lines = 1000;
+          modes = [ ];
+          render_distance = [
+            200
+            200
+          ];
+          splitview_winopts = { };
         };
       };
     };