Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jvgrootveld/telescope-zoxide
An extension for telescope.nvim that allows you operate zoxide within Neovim.
https://github.com/jvgrootveld/telescope-zoxide
lua neovim nvim nvim-plugin nvim-telescope zoxide
Last synced: 3 months ago
JSON representation
An extension for telescope.nvim that allows you operate zoxide within Neovim.
- Host: GitHub
- URL: https://github.com/jvgrootveld/telescope-zoxide
- Owner: jvgrootveld
- License: mit
- Created: 2021-03-27T15:59:56.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T06:28:20.000Z (5 months ago)
- Last Synced: 2024-08-28T07:47:10.703Z (5 months ago)
- Topics: lua, neovim, nvim, nvim-plugin, nvim-telescope, zoxide
- Language: Lua
- Homepage:
- Size: 22.5 KB
- Stars: 306
- Watchers: 2
- Forks: 17
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - jvgrootveld/telescope-zoxide - Telescope integration for [zoxide](https://github.com/ajeetdsouza/zoxide), a smart directory picker that tracks your usage. (Fuzzy Finder / PHP)
README
# Telescope Zoxide
An extension for [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) that allows you operate [zoxide](https://github.com/ajeetdsouza/zoxide) within Neovim.
## Requirements
[zoxide](https://github.com/ajeetdsouza/zoxide) is required to use this plugin.
## Installation
```vim
Plug 'nvim-lua/popup.nvim'
Plug 'nvim-lua/plenary.nvim'
Plug 'nvim-telescope/telescope.nvim'
Plug 'jvgrootveld/telescope-zoxide'
```
## Configuration
You can add, extend and update Telescope Zoxide config by using [Telescope's default configuration mechanism for extensions](https://github.com/nvim-telescope/telescope.nvim#telescope-setup-structure).
An example config:
```lua
-- Useful for easily creating commands
local z_utils = require("telescope._extensions.zoxide.utils")
require('telescope').setup{
-- (other Telescope configuration...)
extensions = {
zoxide = {
prompt_title = "[ Walking on the shoulders of TJ ]",
mappings = {
default = {
after_action = function(selection)
print("Update to (" .. selection.z_score .. ") " .. selection.path)
end
},
[""] = {
before_action = function(selection) print("before C-s") end,
action = function(selection)
vim.cmd.edit(selection.path)
end
},
-- Opens the selected entry in a new split
[""] = { action = z_utils.create_basic_command("split") },
},
}
}
}
```
You can add new mappings and extend default mappings.
_(Note: The mapping with the key 'default' is the mapping invoked on pressing ``)_.
Every keymapping must have an `action` function and supports the optional functions `before_action` and `after_action`.
Tip: If the action is a telescope picker, you should also set `keepinsert = true` to open it in insert mode. Else you can't directly type into the next telescope picker.
All action functions are called with the current `selection` object as parameter which contains the selected path and Zoxide score.
Tip: Make use of the supplied `z_utils.create_basic_command` helper function to easily invoke a vim command for the selected path.
## Loading the extension
You can then load the extension by adding the following after your call to telescope's own `setup()` function:
```lua
require("telescope").load_extension('zoxide')
```
Loading the extension will allow you to use the following functionality:
### List
With Telescope command:
```vim
:Telescope zoxide list
```
In Lua:
```lua
require("telescope").extensions.zoxide.list({picker_opts})
```
You can also bind the function to a key:
```lua
vim.keymap.set("n", "cd", require("telescope").extensions.zoxide.list)
```
## Full example
```lua
local t = require("telescope")
local z_utils = require("telescope._extensions.zoxide.utils")
-- Configure the extension
t.setup({
extensions = {
zoxide = {
prompt_title = "[ Walking on the shoulders of TJ ]",
mappings = {
default = {
after_action = function(selection)
print("Update to (" .. selection.z_score .. ") " .. selection.path)
end
},
[""] = {
before_action = function(selection) print("before C-s") end,
action = function(selection)
vim.cmd.edit(selection.path)
end
},
[""] = { action = z_utils.create_basic_command("split") },
},
},
},
})
-- Load the extension
t.load_extension('zoxide')
-- Add a mapping
vim.keymap.set("n", "cd", t.extensions.zoxide.list)
```
## Default config
```lua
{
prompt_title = "[ Zoxide List ]",
-- Zoxide list command with score
list_command = "zoxide query -ls",
mappings = {
default = {
action = function(selection)
vim.cmd.cd(selection.path)
end,
after_action = function(selection)
vim.notify("Directory changed to " .. selection.path)
end,
},
[""] = { action = z_utils.create_basic_command("split") },
[""] = { action = z_utils.create_basic_command("vsplit") },
[""] = { action = z_utils.create_basic_command("edit") },
[""] = {
keepinsert = true,
action = function(selection)
builtin.find_files({ cwd = selection.path })
end,
},
[""] = {
action = function(selection)
vim.cmd.tcd(selection.path)
end,
},
}
}
```
## Default mappings
| Action | Description | Command executed |
| ------- | ---------------------------------------------------- | ------------------------------------------------ |
| `` | Change current directory to selection | `cd ` |
| `` | Change current tab's directory to selection | `tcd ` |
| `` | Open selection in a split | `split ` |
| `` | Open selection in a vertical split | `vsplit ` |
| `` | Open selection in current window | `edit ` |
| `` | Open selection in telescope's `builtin.find_files` | `builtin.find_files({ cwd = selection.path })` |
## Extensions
### Open Selection in Telescope File Browser
This action requires installing the [Telescope file browser extension](https://github.com/nvim-telescope/telescope-file-browser.nvim). You can register this mapping by adding the following to your config:
```lua
{
mappings = {
[""] = {
keepinsert = true,
action = function(selection)
require("telescope").extensions.file_browser.file_browser({ cwd = selection.path })
end
},
}
}
```