fix(docs): make default configs more understandable #17

Author: Bassam Data

README.md

@@ -213,181 +213,223 @@ You can check the [configuration documentation](https://github.com/bassamsdata/n
   <summary>Here's the full setup with defaults:</summary>
 
 ```lua
-M.config = {
-  AllowKinds = {
-    default = {
-      "Function",
-      "Method",
-      "Class",
-      "Module",
-      "Property",
-      "Variable",
-      -- "Constant",
-      -- "Enum",
-      -- "Interface",
-      -- "Field",
-      -- "Struct",
-    },
-    go = {
-      "Function",
-      "Method",
-      "Struct", -- For struct definitions
-      "Field", -- For struct fields
-      "Interface",
-      "Constant",
-      -- "Variable",
-      "Property",
-      -- "TypeParameter", -- For type parameters if using generics
-    },
-    lua = { "Function", "Method", "Table", "Module" },
-    python = { "Function", "Class", "Method" },
-    -- Filetype specific
-    yaml = { "Object", "Array" },
-    json = { "Module" },
-    toml = { "Object" },
-    markdown = { "String" },
-  },
-  BlockList = {
-    default = {},
-    -- Filetype-specific
-    lua = {
-      "^vim%.", -- anonymous functions passed to nvim api
-      "%.%.%. :", -- vim.iter functions
-      ":gsub", -- lua string.gsub
-      "^callback$", -- nvim autocmds
-      "^filter$",
-      "^map$", -- nvim keymaps
-    },
-    -- another example:
-    -- python = { "^__" }, -- ignore __init__ functions
-  },
-  display = {
-    mode = "text", -- "icon" or "raw"
-    padding = 2,
-  },
-  kindText = {
-    Function = "function",
-    Method = "method",
-    Class = "class",
-    Module = "module",
-    Constructor = "constructor",
-    Interface = "interface",
-    Property = "property",
-    Field = "field",
-    Enum = "enum",
-    Constant = "constant",
-    Variable = "variable",
-  },
-  kindIcons = {
-    File = "󰈙",
-    Module = "󰏗",
-    Namespace = "󰌗",
-    Package = "󰏖",
-    Class = "󰌗",
-    Method = "󰆧",
-    Property = "󰜢",
-    Field = "󰜢",
-    Constructor = "󰆧",
-    Enum = "󰒻",
-    Interface = "󰕘",
-    Function = "󰊕",
-    Variable = "󰀫",
-    Constant = "󰏿",
-    String = "󰀬",
-    Number = "󰎠",
-    Boolean = "󰨙",
-    Array = "󰅪",
-    Object = "󰅩",
-    Key = "󰌋",
-    Null = "󰟢",
-    EnumMember = "󰒻",
-    Struct = "󰌗",
-    Event = "󰉁",
-    Operator = "󰆕",
-    TypeParameter = "󰊄",
-  },
-  preview = {
-    highlight_on_move = true, -- Whether to highlight symbols as you move through them
-    -- TODO: still needs implmenting, keep it always now
-    highlight_mode = "always", -- "always" | "select" (only highlight when selecting)
-  },
-  icon = "󱠦", -- 󱠦 -  -  -- 󰚟
-  highlight = "NamuPreview",
-  highlights = {
-    parent = "NamuParent",
-    nested = "NamuNested",
-    style = "NamuStyle",
-  },
-  kinds = {
-    prefix_kind_colors = true,
-    enable_highlights = true,
-    highlights = {
-      PrefixSymbol = "NamuPrefixSymbol",
-      Function = "NamuSymbolFunction",
-      Method = "NamuSymbolMethod",
-      Class = "NamuSymbolClass",
-      Interface = "NamuSymbolInterface",
-      Variable = "NamuSymbolVariable",
-      Constant = "NamuSymbolConstant",
-      Property = "NamuSymbolProperty",
-      Field = "NamuSymbolField",
-      Enum = "NamuSymbolEnum",
-      Module = "NamuSymbolModule",
-    },
-  },
-  window = {
-    auto_size = true,
-    min_width = 30,
-    padding = 4,
-    border = "rounded",
-    show_footer = true,
-    footer_pos = "right",
-  },
-  debug = false, -- Debug flag for both namu and selecta
-  focus_current_symbol = true, -- Add this option to control the feature
-  auto_select = false,
-  row_position = "top10", -- options: "center"|"top10",
-  initially_hidden = false,
-  multiselect = {
-    enabled = true,
-    indicator = "●", -- or "✓"
-    keymaps = {
-      toggle = "<Tab>",
-      untoggle = "<S-Tab>",
-      select_all = "<C-a>",
-      clear_all = "<C-l>",
-    },
-    max_items = nil, -- No limit by default
-  },
-  actions = {
-    close_on_yank = false, -- Whether to close picker after yanking
-    close_on_delete = true, -- Whether to close picker after deleting
-  },
-  custom_keymaps = {
-    yank = {
-      keys = { "<C-y>" },
-      desc = "Yank symbol text",
-    },
-    delete = {
-      keys = { "<C-d>" },
-    },
-    vertical_split = {
-      keys = { "<C-v>" },
-      desc = "Open in vertical split",
-    },
-    horizontal_split = {
-      keys = { "<C-h>" },
-      desc = "Open in horizontal split",
-    },
-    codecompanion = {
-      keys = "<C-o>",
-      desc = "Add symbol to CodeCompanion",
-    },
-    avante = {
-      keys = "<C-t>",
-      desc = "Add symbol to Avante",
-    },
-  },
+{ -- Those are the default options
+  "bassamsdata/namu.nvim",
+  config = function()
+    require("namu").setup({
+      -- Enable symbols navigator which is the default
+      namu_symbols = {
+        enable = true,
+        ---@type NamuConfig
+        options = {
+          AllowKinds = {
+            default = {
+              "Function",
+              "Method",
+              "Class",
+              "Module",
+              "Property",
+              "Variable",
+              -- "Constant",
+              -- "Enum",
+              -- "Interface",
+              -- "Field",
+              -- "Struct",
+            },
+            go = {
+              "Function",
+              "Method",
+              "Struct", -- For struct definitions
+              "Field", -- For struct fields
+              "Interface",
+              "Constant",
+              -- "Variable",
+              "Property",
+              -- "TypeParameter", -- For type parameters if using generics
+            },
+            lua = { "Function", "Method", "Table", "Module" },
+            python = { "Function", "Class", "Method" },
+            -- Filetype specific
+            yaml = { "Object", "Array" },
+            json = { "Module" },
+            toml = { "Object" },
+            markdown = { "String" },
+          },
+          BlockList = {
+            default = {},
+            -- Filetype-specific
+            lua = {
+              "^vim%.", -- anonymous functions passed to nvim api
+              "%.%.%. :", -- vim.iter functions
+              ":gsub", -- lua string.gsub
+              "^callback$", -- nvim autocmds
+              "^filter$",
+              "^map$", -- nvim keymaps
+            },
+            -- another example:
+            -- python = { "^__" }, -- ignore __init__ functions
+          },
+          display = {
+            mode = "icon", -- "icon" or "raw"
+            padding = 2,
+          },
+          -- This is a preset that let's set window without really get into the hassle of tuning window options
+          -- top10 meaning top 10% of the window
+          row_position = "top10", -- options: "center"|"top10"|"top10_right"|"center_right"|"bottom",
+          preview = {
+            highlight_on_move = true, -- Whether to highlight symbols as you move through them
+            -- still needs implmenting, keep it always now
+            highlight_mode = "always", -- "always" | "select" (only highlight when selecting)
+          },
+          window = {
+            auto_size = true,
+            min_height = 1,
+            min_width = 20,
+            max_width = 120,
+            max_height = 30,
+            padding = 2,
+            border = "rounded",
+            title_pos = "left",
+            show_footer = true,
+            footer_pos = "right",
+            relative = "editor",
+            style = "minimal",
+            width_ratio = 0.6,
+            height_ratio = 0.6,
+            title_prefix = "󱠦 ",
+          },
+          debug = false,
+          focus_current_symbol = true,
+          auto_select = false,
+          initially_hidden = false,
+          multiselect = {
+            enabled = true,
+            indicator = "✓", -- or "✓"●
+            keymaps = {
+              toggle = "<Tab>",
+              untoggle = "<S-Tab>",
+              select_all = "<C-a>",
+              clear_all = "<C-l>",
+            },
+            max_items = nil, -- No limit by default
+          },
+          actions = {
+            close_on_yank = false, -- Whether to close picker after yanking
+            close_on_delete = true, -- Whether to close picker after deleting
+          },
+          movement = {-- Support multiple keys
+            next = { "<C-n>", "<DOWN>" },
+            previous = { "<C-p>", "<UP>" },
+            close = { "<ESC>" }, -- "<C-c>" can be added as well
+            select = { "<CR>" },
+            delete_word = {}, -- it can assign "<C-w>"
+            clear_line = {}, -- it can be "<C-u>"
+          },
+          custom_keymaps = {
+            yank = {
+              keys = { "<C-y>" },
+              desc = "Yank symbol text",
+            },
+            delete = {
+              keys = { "<C-d>" },
+              desc = "Delete symbol text",
+            },
+            vertical_split = {
+              keys = { "<C-v>" },
+              desc = "Open in vertical split",
+            },
+            horizontal_split = {
+              keys = { "<C-h>" },
+              desc = "Open in horizontal split",
+            },
+            codecompanion = {
+              keys = "<C-o>",
+              desc = "Add symbol to CodeCompanion",
+            },
+            avante = {
+              keys = "<C-t>",
+              desc = "Add symbol to Avante",
+            },
+          },
+          icon = "󱠦", -- 󱠦 -  -  -- 󰚟
+          kindText = {
+            Function = "function",
+            Class = "class",
+            Module = "module",
+            Constructor = "constructor",
+            Interface = "interface",
+            Property = "property",
+            Field = "field",
+            Enum = "enum",
+            Constant = "constant",
+            Variable = "variable",
+          },
+          kindIcons = {
+            File = "󰈙",
+            Module = "󰏗",
+            Namespace = "󰌗",
+            Package = "󰏖",
+            Class = "󰌗",
+            Method = "󰆧",
+            Property = "󰜢",
+            Field = "󰜢",
+            Constructor = "󰆧",
+            Enum = "󰒻",
+            Interface = "󰕘",
+            Function = "󰊕",
+            Variable = "󰀫",
+            Constant = "󰏿",
+            String = "󰀬",
+            Number = "󰎠",
+            Boolean = "󰨙",
+            Array = "󰅪",
+            Object = "󰅩",
+            Key = "󰌋",
+            Null = "󰟢",
+            EnumMember = "󰒻",
+            Struct = "󰌗",
+            Event = "󰉁",
+            Operator = "󰆕",
+            TypeParameter = "󰊄",
+          },
+          highlight = "NamuPreview",
+          highlights = {
+            parent = "NamuParent",
+            nested = "NamuNested",
+            style = "NamuStyle",
+          },
+          kinds = {
+            prefix_kind_colors = true,
+            enable_highlights = true,
+            highlights = {
+              PrefixSymbol = "NamuPrefixSymbol",
+              Function = "NamuSymbolFunction",
+              Method = "NamuSymbolMethod",
+              Class = "NamuSymbolClass",
+              Interface = "NamuSymbolInterface",
+              Variable = "NamuSymbolVariable",
+              Constant = "NamuSymbolConstant",
+              Property = "NamuSymbolProperty",
+              Field = "NamuSymbolField",
+              Enum = "NamuSymbolEnum",
+              Module = "NamuSymbolModule",
+            },
+          },
+        }
+      }
+      colorscheme = {
+        enable = false,
+        options = {
+          -- NOTE: if you activate persist, then please remove any vim.cmd("colorscheme ...") in your config, no needed anymore
+          persist = true, -- very efficient mechanism to Remember selected colorscheme
+          write_shada = false, -- If you open multiple nvim instances, then probably you need to enable this
+          excluded_schemes = {}, -- exclude any colorscheme from the list
+          -- it accept the same row_position and movement keys as the one in namy symbols
+        },
+      },
+      ui_select = { enable = false }, -- vim.ui.select() wrapper
+    })
+  end,
 }
 ```