Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smiteshp/nvim-navbuddy
A simple popup display that provides breadcrumbs feature using LSP server
https://github.com/smiteshp/nvim-navbuddy
document-symbols language-server-protocol lsp lua neovim neovim-plugin nvim
Last synced: 5 days ago
JSON representation
A simple popup display that provides breadcrumbs feature using LSP server
- Host: GitHub
- URL: https://github.com/smiteshp/nvim-navbuddy
- Owner: SmiteshP
- License: apache-2.0
- Created: 2023-03-20T11:28:42.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-19T02:05:52.000Z (5 months ago)
- Last Synced: 2024-10-12T22:54:32.862Z (2 months ago)
- Topics: document-symbols, language-server-protocol, lsp, lua, neovim, neovim-plugin, nvim
- Language: Lua
- Homepage:
- Size: 131 KB
- Stars: 786
- Watchers: 6
- Forks: 30
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# πΊοΈ nvim-navbuddy
A simple popup display that provides breadcrumbs like navigation feature but
in keyboard centric manner inspired by ranger file manager.
https://user-images.githubusercontent.com/43147494/227758807-13a614ff-a09d-4be0-8f6b-ac22f814ce6f.mp4
## β‘οΈ Requirements
* Neovim >= 0.8.0
* [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig)
* [nvim-navic](https://github.com/SmiteshP/nvim-navic)
* [nui.nvim](https://github.com/MunifTanjim/nui.nvim)
## π¦ Installation
Install the plugin with your preferred package manager:
### [packer](https://github.com/wbthomason/packer.nvim)
```lua
use {
"SmiteshP/nvim-navbuddy",
requires = {
"neovim/nvim-lspconfig",
"SmiteshP/nvim-navic",
"MunifTanjim/nui.nvim",
"numToStr/Comment.nvim", -- Optional
"nvim-telescope/telescope.nvim" -- Optional
}
}
```
### [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug "neovim/nvim-lspconfig"
Plug "SmiteshP/nvim-navic"
Plug "MunifTanjim/nui.nvim"
Plug "numToStr/Comment.nvim", " Optional
Plug "nvim-telescope/telescope.nvim" " Optional
Plug "SmiteshP/nvim-navbuddy"
```
### Lazy Loading
If you want to lazy load navbuddy you need to load it before your Lsp related Stuff.
For Example with [Lazy](https://github.com/folke/lazy.nvim) and [lspconfig](https://github.com/neovim/nvim-lspconfig)
```lua
return {
"neovim/nvim-lspconfig",
dependencies = {
{
"SmiteshP/nvim-navbuddy",
dependencies = {
"SmiteshP/nvim-navic",
"MunifTanjim/nui.nvim"
},
opts = { lsp = { auto_attach = true } }
}
},
-- your lsp config or other stuff
}
```
## βοΈ Setup
nvim-navbuddy needs to be attached to lsp servers of the buffer to work. You can pass the
navbuddy's `attach` function as `on_attach` while setting up the lsp server. You can skip this
step if you have enabled `auto_attach` option in setup function.
Example:
```lua
local navbuddy = require("nvim-navbuddy")
require("lspconfig").clangd.setup {
on_attach = function(client, bufnr)
navbuddy.attach(client, bufnr)
end
}
```
## πͺ Customise
Use `setup` to override any of the default options
* `icons` : Indicate the type of symbol captured. Default icons assume you have nerd-fonts.
* `node_markers` : Indicate whether a node is a leaf or branch node. Default icons assume you have nerd-fonts.
* `window` : Set options related to window's "border", "size", "position".
* `use_default_mappings`: If set to false, only mappings set by user are set. Else default mappings are used for keys that are not set by user.
* `mappings` : Actions to be triggered for specified keybindings. For each keybinding it takes a table of format { callback = , description = "string"}. The callback function takes the "display" object as an argument.
* `lsp` :
* `auto_attach` : Enable to have Navbuddy automatically attach to every LSP for current buffer. Its disabled by default.
* `preference` : Table ranking lsp_servers. Lower the index, higher the priority of the server. If there are more than one server attached to a buffer, navbuddy will refer to this list to make a decision on which one to use. for example - In case a buffer is attached to clangd and ccls both and the preference list is `{ "clangd", "pyright" }`. Then clangd will be prefered.
* `source_buffer` :
* `follow_node` : Keep the current node in focus on the source buffer
* `highlight` : Highlight the currently focused node
* reorient: Reorient buffer after changing nodes. options are "smart", "top", "mid" or "none"
```lua
local navbuddy = require("nvim-navbuddy")
local actions = require("nvim-navbuddy.actions")
navbuddy.setup {
window = {
border = "single", -- "rounded", "double", "solid", "none"
-- or an array with eight chars building up the border in a clockwise fashion
-- starting with the top-left corner. eg: { "β", "β" ,"β", "β", "β", "β", "β", "β" }.
size = "60%", -- Or table format example: { height = "40%", width = "100%"}
position = "50%", -- Or table format example: { row = "100%", col = "0%"}
scrolloff = nil, -- scrolloff value within navbuddy window
sections = {
left = {
size = "20%",
border = nil, -- You can set border style for each section individually as well.
},
mid = {
size = "40%",
border = nil,
},
right = {
-- No size option for right most section. It fills to
-- remaining area.
border = nil,
preview = "leaf", -- Right section can show previews too.
-- Options: "leaf", "always" or "never"
}
},
},
node_markers = {
enabled = true,
icons = {
leaf = " ",
leaf_selected = " β ",
branch = " ο ",
},
},
icons = {
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 = "σ° ",
},
use_default_mappings = true, -- If set to false, only mappings set
-- by user are set. Else default
-- mappings are used for keys
-- that are not set by user
mappings = {
[""] = actions.close(), -- Close and cursor to original location
["q"] = actions.close(),
["j"] = actions.next_sibling(), -- down
["k"] = actions.previous_sibling(), -- up
["h"] = actions.parent(), -- Move to left panel
["l"] = actions.children(), -- Move to right panel
["0"] = actions.root(), -- Move to first panel
["v"] = actions.visual_name(), -- Visual selection of name
["V"] = actions.visual_scope(), -- Visual selection of scope
["y"] = actions.yank_name(), -- Yank the name to system clipboard "+
["Y"] = actions.yank_scope(), -- Yank the scope to system clipboard "+
["i"] = actions.insert_name(), -- Insert at start of name
["I"] = actions.insert_scope(), -- Insert at start of scope
["a"] = actions.append_name(), -- Insert at end of name
["A"] = actions.append_scope(), -- Insert at end of scope
["r"] = actions.rename(), -- Rename currently focused symbol
["d"] = actions.delete(), -- Delete scope
["f"] = actions.fold_create(), -- Create fold of current scope
["F"] = actions.fold_delete(), -- Delete fold of current scope
["c"] = actions.comment(), -- Comment out current scope
[""] = actions.select(), -- Goto selected symbol
["o"] = actions.select(),
["J"] = actions.move_down(), -- Move focused node down
["K"] = actions.move_up(), -- Move focused node up
["s"] = actions.toggle_preview(), -- Show preview of current node
[""] = actions.vsplit(), -- Open selected node in a vertical split
[""] = actions.hsplit(), -- Open selected node in a horizontal split
["t"] = actions.telescope({ -- Fuzzy finder at current level.
layout_config = { -- All options that can be
height = 0.60, -- passed to telescope.nvim's
width = 0.60, -- default can be passed here.
prompt_position = "top",
preview_width = 0.50
},
layout_strategy = "horizontal"
}),
["g?"] = actions.help(), -- Open mappings help window
},
lsp = {
auto_attach = false, -- If set to true, you don't need to manually use attach function
preference = nil, -- list of lsp server names in order of preference
},
source_buffer = {
follow_node = true, -- Keep the current node in focus on the source buffer
highlight = true, -- Highlight the currently focused node
reorient = "smart", -- "smart", "top", "mid" or "none"
scrolloff = nil -- scrolloff value when navbuddy is open
},
custom_hl_group = nil, -- "Visual" or any other hl group to use instead of inverted colors
}
```
## π Usage
`Navbuddy` command can be used to open navbuddy.
```
:Navbuddy
```
And alternatively lua function `open` can also be used to open navbuddy.
```
:lua require("nvim-navbuddy").open()
```