fix: temp descriptions

modules/utility/telescope/telescope.nix

@@ -4,57 +4,147 @@
   ...
 }: let
   inherit (lib.options) mkEnableOption mkOption;
-  inherit (lib.types) int str listOf float bool;
+  inherit (lib.types) int str listOf float bool either enum submodule attrsOf;
   inherit (lib.nvim.binds) mkMappingOption;
-  inherit (lib.nvim.types) mkPluginSetupOption;
+  inherit (lib.nvim.types) mkPluginSetupOption luaInline;
-  mkOptOfType = type: default:
-    mkOption {
-      # TODO: description
-      description = "See plugin docs for more info";
-      inherit type default;
-    };
-
   setupOptions = {
     defaults = {
-      vimgrep_arguments = mkOptOfType (listOf str) [
+      vimgrep_arguments = mkOption {
-        "${pkgs.ripgrep}/bin/rg"
+        description = ''
-        "--color=never"
+          Defines the command that will be used for `live_grep` and `grep_string` pickers.
-        "--no-heading"
+          Make sure that color is set to `never` because telescope does not yet interpret color codes.
-        "--with-filename"
+        '';
-        "--line-number"
+        type = listOf str;
-        "--column"
+        default = [
-        "--smart-case"
+          "${pkgs.ripgrep}/bin/rg"
-        "--hidden"
+          "--color=never"
-        "--no-ignore"
+          "--no-heading"
-      ];
+          "--with-filename"
-      pickers.find_command = mkOptOfType (listOf str) ["${pkgs.fd}/bin/fd"];
+          "--line-number"
-      prompt_prefix = mkOptOfType str "     ";
+          "--column"
-      selection_caret = mkOptOfType str "  ";
+          "--smart-case"
-      entry_prefix = mkOptOfType str "  ";
+          "--hidden"
-      initial_mode = mkOptOfType str "insert";
+          "--no-ignore"
-      selection_strategy = mkOptOfType str "reset";
+        ];
-      sorting_strategy = mkOptOfType str "ascending";
-      layout_strategy = mkOptOfType str "horizontal";
-      layout_config = {
-        horizontal = {
-          prompt_position = mkOptOfType str "top";
-          preview_width = mkOptOfType float 0.55;
-          results_width = mkOptOfType float 0.8;
-        };
-        vertical = {
-          mirror = mkOptOfType bool false;
-        };
-        width = mkOptOfType float 0.8;
-        height = mkOptOfType float 0.8;
-        preview_cutoff = mkOptOfType int 120;
       };
-      file_ignore_patterns = mkOptOfType (listOf str) ["node_modules" ".git/" "dist/" "build/" "target/" "result/"];
+      pickers.find_command = mkOption {
-      color_devicons = mkOptOfType bool true;
+        description = "cmd to use for finding files";
-      path_display = mkOptOfType (listOf str) ["absolute"];
+        type = either (listOf str) luaInline;
-      set_env = {
+        default = ["${pkgs.fd}/bin/fd"];
-        COLORTERM = mkOptOfType str "truecolor";
+      };
+      prompt_prefix = mkOption {
+        description = "Shown in front of Telescope's prompt";
+        type = str;
+        default = "     ";
+      };
+      selection_caret = mkOption {
+        description = "Character(s) to show in front of the current selection";
+        type = str;
+        default = "  ";
+      };
+      entry_prefix = mkOption {
+        description = "Prefix in front of each result entry. Current selection not included.";
+        type = str;
+        default = "  ";
+      };
+      initial_mode = mkOption {
+        description = "Determines in which mode telescope starts.";
+        type = enum ["insert" "normal"];
+        default = "insert";
+      };
+      selection_strategy = mkOption {
+        description = "Determines how the cursor acts after each sort iteration.";
+        type = enum ["reset" "follow" "row" "closest" "none"];
+        default = "reset";
+      };
+      sorting_strategy = mkOption {
+        description = ''Determines the direction "better" results are sorted towards.'';
+        type = enum ["descending" "ascending"];
+        default = "ascending";
+      };
+      layout_strategy = mkOption {
+        description = "Determines the default layout of Telescope pickers. See `:help telescope.layout`.";
+        type = str;
+        default = "horizontal";
+      };
+      layout_config = mkOption {
+        description = ''
+          Determines the default configuration values for layout strategies.
+          See telescope.layout for details of the configurations options for
+          each strategy.
+        '';
+        default = {};
+        type = submodule {
+          options = {
+            horizontal = {
+              prompt_position = mkOption {
+                description = "";
+                type = str;
+                default = "top";
+              };
+              preview_width = mkOption {
+                description = "";
+                type = float;
+                default = 0.55;
+              };
+              results_width = mkOption {
+                description = "";
+                type = float;
+                default = 0.8;
+              };
+            };
+            vertical = {
+              mirror = mkOption {
+                description = "";
+                type = bool;
+                default = false;
+              };
+            };
+            width = mkOption {
+              description = "";
+              type = float;
+              default = 0.8;
+            };
+            height = mkOption {
+              description = "";
+              type = float;
+              default = 0.8;
+            };
+            preview_cutoff = mkOption {
+              description = "";
+              type = int;
+              default = 120;
+            };
+          };
+        };
+      };
+      file_ignore_patterns = mkOption {
+        description = "A table of lua regex that define the files that should be ignored.";
+        type = listOf str;
+        default = ["node_modules" ".git/" "dist/" "build/" "target/" "result/"];
+      };
+      color_devicons = mkOption {
+        description = "Boolean if devicons should be enabled or not.";
+        type = bool;
+        default = true;
+      };
+      path_display = mkOption {
+        description = "Determines how file paths are displayed.";
+        type = listOf (enum ["hidden" "tail" "absolute" "smart" "shorten" "truncate"]);
+        default = ["absolute"];
+      };
+      set_env = mkOption {
+        description = "Set an envrionment for term_previewer";
+        type = attrsOf str;
+        default = {
+          COLORTERM = "truecolor";
+        };
+      };
+      winblend = mkOption {
+        description = "pseudo-transparency of keymap hints floating window";
+        type = int;
+        default = 0;
       };
-      winblend = mkOptOfType int 0;
     };
   };
 in {