plugins/persistence: convert to mkNeovimPlugin and fix settings

Restrict no nonnegative numbers

Co-authored-by: Gaétan Lepage <33058747+GaetanLepage@users.noreply.github.com>

chore: include optionsRenamedToSettings in TODO

Merge imports

Co-authored-by: Gaétan Lepage <33058747+GaetanLepage@users.noreply.github.com>

plugins/by-name/persistence/default.nix

@@ -1,79 +1,57 @@
-{
-  lib,
-  helpers,
-  config,
-  pkgs,
-  ...
-}:
-with lib;
-{
-  options.plugins.persistence = lib.nixvim.plugins.neovim.extraOptionsOptions // {
-    enable = mkEnableOption "persistence.nvim";
+{ lib, ... }:
+let
+  inherit (lib.nixvim) defaultNullOpts literalLua;
+in
+lib.nixvim.plugins.mkNeovimPlugin {
+  name = "persistence";
+  packPathName = "persistence.nvim";
+  package = "persistence-nvim";
+  description = "A simple lua plugin for automated session management.";
 
-    package = lib.mkPackageOption pkgs "persistence.nvim" {
-      default = [
-        "vimPlugins"
-        "persistence-nvim"
+  maintainers = [ lib.maintainers.jolars ];
+
+  # TODO: introduced 2025-01-08: remove after 25.05
+  optionsRenamedToSettings = [
+    "dir"
   ];
-    };
-
-    dir = helpers.defaultNullOpts.mkStr {
-      __raw = ''vim.fn.expand(vim.fn.stdpath("state") .. "/sessions/")'';
-    } "directory where session files are saved";
-
-    options =
+  imports =
     let
-        # https://neovim.io/doc/user/options.html#'sessionoptions'
-        sessionOpts = [
-          "blank"
-          "buffers"
-          "curdir"
-          "folds"
-          "globals"
-          "help"
-          "localoptions"
-          "options"
-          "skiprtp"
-          "resize"
-          "sesdir"
-          "tabpages"
-          "terminal"
-          "winpos"
-          "winsize"
+      basePluginPath = [
+        "plugins"
+        "persistence"
       ];
     in
-      helpers.defaultNullOpts.mkListOf (types.enum sessionOpts) [
-        "buffers"
-        "curdir"
-        "tabpages"
-        "winsize"
-        "skiprtp"
-      ] "sessionoptions used for saving";
-
-    preSave = helpers.defaultNullOpts.mkLuaFn "nil" "a function to call before saving the session";
-
-    saveEmpty = helpers.defaultNullOpts.mkBool false ''
-      don't save if there are no open file buffers
-    '';
-  };
-
-  config =
-    let
-      cfg = config.plugins.persistence;
-    in
-    mkIf cfg.enable {
-      extraPlugins = [ cfg.package ];
-
-      extraConfigLua =
-        let
-          opts = {
-            inherit (cfg) dir options;
-            pre_save = cfg.preSave;
-            save_empty = cfg.saveEmpty;
-          };
-        in
+    map
+      (
+        option:
+        lib.mkRemovedOptionModule (basePluginPath ++ [ option ]) ''
+          This option has been deprecated upstream. The plugin now provides
+          user events to hook into instead.
         ''
-          require('persistence').setup(${lib.nixvim.toLuaObject opts})
+      )
+      [
+        "options"
+        "preSave"
+        "saveEmpty"
+      ];
+
+  settingsOptions = {
+    branch = defaultNullOpts.mkBool true ''
+      Use git branch to save session.
     '';
+
+    dir = defaultNullOpts.mkStr (literalLua "vim.fn.expand(vim.fn.stdpath('state') .. '/sessions/')") ''
+      Directory where session files are saved.
+    '';
+
+    need = defaultNullOpts.mkUnsignedInt 1 ''
+      Minimum number of file buffers that need to be open to save. Set to
+      0 to always save.
+    '';
+  };
+
+  settingsExample = {
+    need = 0;
+    branch = false;
   };
 }

tests/test-sources/plugins/by-name/persistence/default.nix

@@ -7,15 +7,11 @@
     plugins.persistence = {
       enable = true;
 
+      settings = {
+        branch = true;
         dir.__raw = ''vim.fn.expand(vim.fn.stdpath("state") .. "/sessions/")'';
-      options = [
-        "buffers"
-        "curdir"
-        "tabpages"
-        "winsize"
-      ];
-      preSave = null;
-      saveEmpty = false;
+        need = 1;
+      };
     };
   };
 }