From 01e35f98776623af5378f9562d33983e218ed36c Mon Sep 17 00:00:00 2001 From: Ching Pei Yang Date: Sat, 6 Apr 2024 18:07:53 +0000 Subject: [PATCH] fix: temp descriptions --- modules/utility/telescope/telescope.nix | 182 ++++++++++++++++++------ 1 file changed, 136 insertions(+), 46 deletions(-) diff --git a/modules/utility/telescope/telescope.nix b/modules/utility/telescope/telescope.nix index 27fa98a..bebe6c8 100644 --- a/modules/utility/telescope/telescope.nix +++ b/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; - mkOptOfType = type: default: - mkOption { - # TODO: description - description = "See plugin docs for more info"; - inherit type default; - }; - + inherit (lib.nvim.types) mkPluginSetupOption luaInline; setupOptions = { defaults = { - vimgrep_arguments = mkOptOfType (listOf str) [ - "${pkgs.ripgrep}/bin/rg" - "--color=never" - "--no-heading" - "--with-filename" - "--line-number" - "--column" - "--smart-case" - "--hidden" - "--no-ignore" - ]; - pickers.find_command = mkOptOfType (listOf str) ["${pkgs.fd}/bin/fd"]; - prompt_prefix = mkOptOfType str "  "; - selection_caret = mkOptOfType str " "; - entry_prefix = mkOptOfType str " "; - initial_mode = mkOptOfType str "insert"; - 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; + vimgrep_arguments = mkOption { + description = '' + Defines the command that will be used for `live_grep` and `grep_string` pickers. + Make sure that color is set to `never` because telescope does not yet interpret color codes. + ''; + type = listOf str; + default = [ + "${pkgs.ripgrep}/bin/rg" + "--color=never" + "--no-heading" + "--with-filename" + "--line-number" + "--column" + "--smart-case" + "--hidden" + "--no-ignore" + ]; }; - file_ignore_patterns = mkOptOfType (listOf str) ["node_modules" ".git/" "dist/" "build/" "target/" "result/"]; - color_devicons = mkOptOfType bool true; - path_display = mkOptOfType (listOf str) ["absolute"]; - set_env = { - COLORTERM = mkOptOfType str "truecolor"; + pickers.find_command = mkOption { + description = "cmd to use for finding files"; + type = either (listOf str) luaInline; + default = ["${pkgs.fd}/bin/fd"]; + }; + 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 {