treewide: begin restructuring the module tree

modules/plugins/dashboard/startify/startify.nix

@@ -0,0 +1,190 @@
+{
+  config,
+  lib,
+  ...
+}: let
+  inherit (lib.options) mkEnableOption mkOption;
+  inherit (lib.types) listOf attrs bool enum str oneOf int;
+in {
+  options.vim.dashboard.startify = {
+    enable = mkEnableOption "dashboard via vim-startify";
+
+    bookmarks = mkOption {
+      default = [];
+      description = ''List of book marks to disaply on start page'';
+      type = listOf attrs;
+      example = {"c" = "~/.vimrc";};
+    };
+
+    changeToDir = mkOption {
+      default = true;
+      description = "Should vim change to the directory of the file you open";
+      type = bool;
+    };
+
+    changeToVCRoot = mkOption {
+      default = false;
+      description = "Should vim change to the version control root when opening a file";
+      type = bool;
+    };
+
+    changeDirCmd = mkOption {
+      default = "lcd";
+      description = "Command to change the current window with. Can be cd, lcd or tcd";
+      type = enum ["cd" "lcd" "tcd"];
+    };
+
+    customHeader = mkOption {
+      default = [];
+      description = "Text to place in the header";
+      type = listOf str;
+    };
+
+    customFooter = mkOption {
+      default = [];
+      description = "Text to place in the footer";
+      type = listOf str;
+    };
+
+    lists = mkOption {
+      default = [
+        {
+          type = "files";
+          header = ["MRU"];
+        }
+        {
+          type = "dir";
+          header = ["MRU Current Directory"];
+        }
+        {
+          type = "sessions";
+          header = ["Sessions"];
+        }
+        {
+          type = "bookmarks";
+          header = ["Bookmarks"];
+        }
+        {
+          type = "commands";
+          header = ["Commands"];
+        }
+      ];
+      description = "Specify the lists and in what order they are displayed on startify.";
+      type = listOf attrs;
+    };
+
+    skipList = mkOption {
+      default = [];
+      description = "List of regex patterns to exclude from MRU lists";
+      type = listOf str;
+    };
+
+    updateOldFiles = mkOption {
+      default = false;
+      description = "Set if you want startify to always update and not just when neovim closes";
+      type = bool;
+    };
+
+    sessionAutoload = mkOption {
+      default = false;
+      description = "Make startify auto load Session.vim files from the current directory";
+      type = bool;
+    };
+
+    commands = mkOption {
+      default = [];
+      description = "Commands that are presented to the user on startify page";
+      type = listOf (oneOf [str attrs (listOf str)]);
+    };
+
+    filesNumber = mkOption {
+      default = 10;
+      description = "How many files to list";
+      type = int;
+    };
+
+    customIndices = mkOption {
+      default = [];
+      description = "Specify a list of default charecters to use instead of numbers";
+      type = listOf str;
+    };
+
+    disableOnStartup = mkOption {
+      default = false;
+      description = "Prevent startify from opening on startup but can be called with :Startify";
+      type = bool;
+    };
+
+    unsafe = mkOption {
+      default = false;
+      description = "Turns on unsafe mode for Startify. Stops resolving links, checking files are readable and filtering bookmark list";
+      type = bool;
+    };
+
+    paddingLeft = mkOption {
+      default = 3;
+      description = "Number of spaces used for left padding.";
+      type = int;
+    };
+
+    useEnv = mkOption {
+      default = false;
+      description = "Show environment variables in path if name is shorter than value";
+      type = bool;
+    };
+
+    sessionBeforeSave = mkOption {
+      default = [];
+      description = "Commands to run before saving a session";
+      type = listOf str;
+    };
+
+    sessionPersistence = mkOption {
+      default = false;
+      description = "Persist session before leaving vim or switching session";
+      type = bool;
+    };
+
+    sessionDeleteBuffers = mkOption {
+      default = true;
+      description = "Delete all buffers when loading or closing a session";
+      type = bool;
+    };
+
+    sessionDir = mkOption {
+      default = "~/.vim/session";
+      description = "Directory to save and load sessions from";
+      type = str;
+    };
+
+    skipListServer = mkOption {
+      default = [];
+      description = "List of vim servers to not load startify for";
+      type = listOf str;
+    };
+
+    sessionRemoveLines = mkOption {
+      default = [];
+      description = "Patterns to remove from session files";
+      type = listOf str;
+    };
+
+    sessionSavevars = mkOption {
+      default = [];
+      description = "List of variables to save into a session file.";
+      type = listOf str;
+    };
+
+    sessionSavecmds = mkOption {
+      default = [];
+      description = "List of commands to run when loading a session.";
+      type = listOf str;
+    };
+
+    sessionSort = mkOption {
+      default = false;
+      description = "Set if you want items sorted by date rather than alphabetically";
+      type = bool;
+    };
+  };
+}