# ⚠ NOTE: THIS IS A FORK This is a fork of the original symbols-outline.nvim which merges some selected PRs from the original repo, plus some other improvements due to personal preferences. It does not attempt to be an up-to-date successor of the original repo, nor does it attempt to ensure everyone's use-cases are satisfied by providing an overall better experience. It is merely a fork which I maintain for my personal use-cases which incorporates some selected PRs. ## Maintenance status This fork is NOT guaranteed to be completely bug-free, nor as stable as the original. However, since I use this plugin myself, it is guaranteed that selected issues that I encounter myself would be fixed (to the best of my ability). I do not merge PRs from the original repo that I don't personally need. - **DO use this fork if**: - You want to use features available in this fork, which are not included upstream (listed below) - You MIGHT want some up-to-date fixes to problems (that I also face) but is OK with some things not being looked after well (things I don't personally use) - **Do NOT use this fork if**: - You want a stable plugin - You don't need the extra features in this fork ## Features Below is a list of features I've included in this fork which, at the time of writing, has not been included upstream (in the original repo). I try my best to keep this list up to date. Features/Changes: - Feat: Toggling folds (and added default keymaps for it) (simrat39/symbols-outline.nvim#194) - Feat: Control focus between outline and code window. - New commands: SymbolsOutline`Focus,FocusOutline,FocusCode` (see [commands](#commands)) - Fixed issues: - simrat39/symbols-outline.nvim#143 - simrat39/symbols-outline.nvim#174 - simrat39/symbols-outline.nvim#207 - Feat: when `auto_close=true` only auto close if `goto_location` is used (where focus changed), and not for `focus_location` (simrat39/symbols-outline.nvim#119) - Feat: Cursorline option for the outline window - MAJOR: Removed hover floating window from `toggle_preview`. - Instead, you can set `open_hover_on_preview=true` (true by default) so that the `hover_symbol` action can be triggered when `toggle_preview`is triggered. - The preview window's size changed to half of neovim height (rather than a third). This is planned to be configurable. - The preview window is positioned to be vertically center-aligned (rather than fixed to the top). This is planned to be configurable. - Feat: Added function and command to show provider and outline window status, somewhat like `:LspInfo`. - BREAKING: Marker icons used for guides can now be customized. `show_guides` deprecated in favor of `guides.enabled`. Fixes: - Fix symbol preview (simrat39/symbols-outline.nvim#176) - Fix `SymbolsOutlineClose` crashing when already closed: simrat39/symbols-outline.nvim#163 - Support Nerd fonts v3.0: simrat39/symbols-outline.nvim#225 - Fix newlines in symbols crash: simrat39/symbols-outline.nvim#204 (simrat39/symbols-outline.nvim#184) - Fix `code_actions`: simrat39/symbols-outline.nvim#168 (simrat39/symbols-outline.nvim#123) - Fix fold all operation too slow: simrat39/symbols-outline.nvim#223 (simrat39/symbols-outline.nvim#224) ### PRs Key: ``` ✅ = Either merged superseded 📼 = Planned for merge ``` - Open handler checks if view is not already open (#235 by eyalz800) - auto_jump config param (#229 by stickperson) - ✅ Update nerd fonts to 3.0 (#225 by anstadnik) - ✅ fix(folding): optimize fold/unfold all (#223 by wjdwndud0114) - ✅ Support markdown setext-style headers (#222 by msr1k) - ✅ fix(icons): replace obsolete icons (#219 by loichyan) **Superseded by #225** - ✅ Support ccls symbols (#218 by rqdmap) - ✅ fix: replace newlines with spaces in writer (#204 by tbung) - ✅ Make close_outline idempotent (#200 by showermat) **Superseded by #163** - Distinguish between public and private function display in Elixir (#187 by scottming) - ✅ Fix some options (#180 by cljoly) - fix: Invalid buffer id error (#177 by snowair) - ✅ fix(code_actions): use the builtin code_action (#168 by zjp-CN) - ✅ fix: plugin crashes when SymbolOutlineClose used (#163 by beauwilliams) - feat: Add window_bg_highlight to config (#137 by Zane-) - 📼 Added preview width and relative size (#130 by Freyskeyd) - 📼 Improve preview, hover windows configurability and looks (#128 by toppair) - ✅ Do not close outline when focus_location occurs (#119 by M1Sports20) - feat: instant_preview (#116 by axieax) - check if code_win is nill (#110 by i3Cheese) - Floating window (Draft) (#101 by druskus20) ### TODO Key: ``` - [ ] : Planned - [/] : WIP - : Idea ``` Items will be moved to above list when complete. - Folds - `[ ]` Org-like shift+tab behavior: Open folds level-by-level - `[ ]` Optionally not opening all child nodes when opening parent node - Fold siblings and siblings of parent on startup - Navigation - Go to parent - Cycle siblings - `[ ]` simrat39/symbols-outline.nvim#75: Handling of the outline window when attached buffer is closed. Maybe it should continue working, so that pressing enter can open a split to the correct location, and pressing `q` can properly close the buffer. - Preview / Hover - `[/]` Configurable winhighlight options for preview window (like nvim-cmp) (simrat39/symbols-outline#128) - `[/]` Configurable width and height (simrat39/symbols-outline#130) ### Related plugins - nvim-navic - nvim-navbuddy - dropdown.nvim - treesitter (inspect/edit) --- # symbols-outline.nvim **A tree like view for symbols in Neovim using the Language Server Protocol. Supports all your favourite languages.** ![demo](https://github.com/simrat39/rust-tools-demos/raw/master/symbols-demo.gif) ## Prerequisites - `neovim 0.7+` - Properly configured Neovim LSP client ## Installation Use `hedyhli/symbols-outline.nvim` if you wish to use this fork. Packer: ```lua use 'simrat39/symbols-outline.nvim' ``` Lazy: ```lua { "simrat39/symbols-outline.nvim", config = function() -- Example mapping to toggle outline vim.keymap.set("n", "tt", "SymbolsOutline", { desc = "SymbolsOutline" }) require("symbols-outline").setup { -- Your setup opts here (leave empty to use defaults) } end, }, ``` Lazy with lazy-loading: ```lua { "simrat39/symbols-outline.nvim", cmd = { "SymbolsOutline", "SymbolsOutlineOpen" }, keys = { -- Example mapping to toggle outline { "tt", "SymbolsOutline", desc = "Toggle outline window" }, }, opts = { -- Your setup opts here }, }, ``` This allows Lazy.nvim to lazy load the plugin on commands `SymbolsOutline`, `SymbolsOutlineOpen`, and your keybindings. ## Setup Call the setup function with your configuration options. Note that a call to `.setup()` is *required* for this plugin to work (simrat39/symbols-outline.nvim#213). ```lua require("symbols-outline").setup({}) ``` ## Configuration ### Terminology - **Provider**: Source of the items in the outline view. Could be LSP, CoC, etc. - **Node**: An item in the outline view - **Fold**: Collapse a collapsible node - **Location**: Where in the source file a node is from - **Preview**: Peek the location of a node in code using a floating window - **Hover**: Cursor currently on the line of a node - **Hover symbol**: Displaying a floating window to show symbol information provided by provider. - **Focus**: Which window the cursor is in ### Options Pass a table to the setup call with your configuration options. Default values are shown: ```lua local opts = { -- Where to open the split window: right/left position = 'right', -- Whether width is relative to existing windows relative_width = true, -- Percentage or integer of columns width = 25, -- Whether to highlight the currently hovered symbol (high cpu usage) highlight_hovered_item = true, -- Options for outline guides guides = { enabled = true, markers = { bottom = '└', middle = '├', vertical = '│', horizontal = '─', }, }, -- Automatically open preview of code on hover auto_preview = false, -- Automatically open hover_symbol when opening toggle_preview (see keymaps). -- If you disable this you can still open hover_symbol using your keymap -- below. open_hover_on_preview = true, -- Border option for floating preview window. -- Options include: single/double/rounded/solid/shadow or an array of border -- characters. -- See :help nvim_open_win() and search for "border" option. border = 'single', -- Behaviour changed in this fork: -- Auto close the outline window if goto_location is triggered and not for -- focus_location auto_close = false, -- Vim options for the outline window show_numbers = false, show_relative_numbers = false, show_cursorline = true, -- Show extra details with the symbols (lsp dependent) show_symbol_details = true, -- Highlight group for the preview background preview_bg_highlight = 'Pmenu', -- Depth past which nodes will be folded by default autofold_depth = nil, -- Automatically unfold hovered symbol auto_unfold_hover = true, fold_markers = { '', 'ï‘Œ' }, -- Whether to wrap long lines, or let them flow off the window wrap = false, -- Only in this fork: -- Whether to focus on the outline window when it is opened. -- Set to false to remain focus on your previous buffer when opening -- symbols-outline. focus_on_open = true, -- Pseudo-transparency of the preview window winblend = 0 -- These keymaps can be a string or a table for multiple keys keymaps = { show_help = '?', close = {"", "q"}, -- Jump to symbol under cursor. -- It can auto close the outline window when triggered, see -- 'auto_close' option above. goto_location = "", -- Jump to symbol under cursor but keep focus on outline window focus_location = "o", hover_symbol = "", -- Preview symbol under cursor toggle_preview = "K", rename_symbol = "r", code_actions = "a", -- These fold actions are collapsing tree nodes, not code folding fold = "h", fold_toggle = '', -- Only in this fork -- Toggle folds for all nodes. -- If at least one node is folded, this action will fold all nodes. -- If all nodes are folded, this action will unfold all nodes. fold_toggle_all = '', -- Only in this fork unfold = "l", fold_all = "W", unfold_all = "E", fold_reset = "R", }, -- Lsp clients to ignore lsp_blacklist = {}, -- Symbols to ignore. -- Possible values: lua/symbols-outline/symbols.lua symbol_blacklist = {}, symbols = { -- Changed in this fork File = { icon = "󰈔", hl = "@text.uri" }, Module = { icon = "󰆧", hl = "@namespace" }, Namespace = { icon = "ó°…Ș", hl = "@namespace" }, Package = { icon = "󰏗", hl = "@namespace" }, Class = { icon = "𝓒", hl = "@type" }, Method = { icon = "ƒ", hl = "@method" }, Property = { icon = "", hl = "@method" }, Field = { icon = "󰆹", hl = "@field" }, Constructor = { icon = "", hl = "@constructor" }, Enum = { icon = "ℰ", hl = "@type" }, Interface = { icon = "󰜰", hl = "@type" }, Function = { icon = "", hl = "@function" }, Variable = { icon = "", hl = "@constant" }, Constant = { icon = "", hl = "@constant" }, String = { icon = "𝓐", hl = "@string" }, Number = { icon = "#", hl = "@number" }, Boolean = { icon = "⊹", hl = "@boolean" }, Array = { icon = "ó°…Ș", hl = "@constant" }, Object = { icon = "⊿", hl = "@type" }, Key = { icon = "🔐", hl = "@type" }, Null = { icon = "NULL", hl = "@type" }, EnumMember = { icon = "", hl = "@field" }, Struct = { icon = "𝓱", hl = "@type" }, Event = { icon = "đŸ—Č", hl = "@type" }, Operator = { icon = "+", hl = "@operator" }, TypeParameter = { icon = "𝙏", hl = "@parameter" }, Component = { icon = "󰅮", hl = "@function" }, Fragment = { icon = "󰅮", hl = "@constant" }, -- ccls TypeAlias = { icon = ' ', hl = '@type' }, Parameter = { icon = 'îȘ’ ', hl = '@parameter' }, StaticMethod = { icon = 'îȘŒ ', hl = '@function' }, Macro = { icon = ' ', hl = '@macro' }, }, } ``` ## Commands - **:SymbolsOutline[!]** Toggle symbols outline. With bang (`!`) the cursor focus stays in your original window after opening the outline window. Set `focus_on_win = true` to always use this behaviour. - **:SymbolsOutlineOpen[!]** Open symbols outline. With bang (`!`) the cursor focus stays in your original window after opening the outline window. Set `focus_on_win = true` to always use this behaviour. - **:SymbolsOutlineClose** Close symbols outline - **:SymbolsOutlineFocus** Toggle focus on symbols outline - **:SymbolsOutlineFocusOutline** Focus on symbols outline - **:SymbolsOutlineFocusCode** Focus on source window - **:SymbolsOutlineStatus** Display current provider and outline window status in the messages area. ### Lua API ```lua require'symbols-outline' ``` - setup(opts) - **toggle_outline(opts)** Toggle opening/closing of outline window. If `opts.bang` is true, keep focus on previous window. - **open_outline(opts)** Open the outline window. If `opts.bang` is true, keep focus on previous window. - **close_outline()** Close the outline window. - **focus_toggle()** Toggle cursor focus between code and outline window. - **focus_outline()** Focus cursor on the outline window. - **focus_code()** Focus cursor on the window which the outline is derived from. - **is_open()** Return whether the outline window is open. - **show_status()** Display current provider and outline window status in the messages area. ## Default keymaps | Key | Action | | ---------- | -------------------------------------------------- | | Escape | Close outline | | ? | Show help message | | Enter | Go to symbol location in code | | o | Go to symbol location in code without losing focus | | Ctrl+Space | Hover current symbol | | K | Toggles the current symbol preview | | r | Rename symbol | | a | Code actions | | h | fold symbol | | Tab | toggle fold under cursor | | Shift+Tab | toggle all folds | | l | Unfold symbol | | W | Fold all symbols | | E | Unfold all symbols | | R | Reset all folding | ## Highlights | Highlight | Purpose | | ----------------------- | -------------------------------------- | | FocusedSymbol | Highlight of the focused symbol | | Pmenu | Highlight of the preview popup windows | | SymbolsOutlineConnector | Highlight of the table connectors | | Comment | Highlight of the info virtual text | ## Recipes Behaviour you may want to achieve and the combination of configuration options to achieve it. **Unfold all others except currently hovered item** ```lua autofold_depth = 1, auto_unfold_hover = true, ``` image Any other recipes you think others may also find useful? Feel free to open a PR.