telescope-project.nvim
telescope-project.nvim copied to clipboard
Published
20 hours ago •
nvim-telescope
nvim-telescope
telescope-project.nvim
An extension for telescope.nvim that allows you to switch between projects.
Demo
Requirements
- telescope.nvim (required)
-
telescope-file-browser.nvim (optional, only for
file_browseraction)
Setup
You can setup the extension by adding the following to your config:
require'telescope'.load_extension('project')
You may skip explicitly loading extensions (they will then be lazy-loaded), but tab completions will not be available right away.
Available functions:
Project
The projects picker:
require'telescope'.extensions.project.project{}
Default mappings (normal mode):
| Key | Description |
|---|---|
d |
delete currently selected project |
r |
rename currently selected project |
c |
create a project* |
s |
search inside files within your project |
b |
browse inside files within your project |
w |
change to the selected project's directory without opening it |
R |
find a recently opened file within your project |
f |
find a file within your project (same as <CR>) |
Default mappings (insert mode):
| Key | Description |
|---|---|
<c-d> |
delete currently selected project |
<c-v> |
rename currently selected project |
<c-a> |
create a project* |
<c-s> |
search inside files within your project |
<c-b> |
browse inside files within your project |
<c-l> |
change to the selected project's directory without opening it |
<c-r> |
find a recently opened file within your project |
<c-f> |
find a file within your project (same as <CR>) |
* defaults to your git root if used inside a git project, otherwise, it will use your current working directory
Workspace mappings (insert mode):
| Key | Description |
|---|---|
<c-w> |
change workspace |
Example key map config:
vim.api.nvim_set_keymap(
'n',
'<C-p>',
":lua require'telescope'.extensions.project.project{}<CR>",
{noremap = true, silent = true}
)
Available options:
| Keys | Description | Options |
|---|---|---|
display_type |
Show the title and the path of the project | 'full' or 'minimal' (default) |
Options can be added when requiring telescope-project, as shown below:
lua require'telescope'.extensions.project.project{ display_type = 'full' }
Available setup settings:
| Keys | Description | Options |
|---|---|---|
base_dirs |
Array of project base directory configurations | table (default: nil) |
hidden_files |
Show hidden files in selected project | bool (default: false) |
Setup settings can be added when requiring telescope, as shown below:
require('telescope').setup {
extensions = {
project = {
base_dirs = {
'~/dev/src',
{'~/dev/src2'},
{'~/dev/src3', max_depth = 4},
{path = '~/dev/src4'},
{path = '~/dev/src5', max_depth = 2},
},
hidden_files = true, -- default: false
theme = "dropdown"
}
}
}
Roadmap :blue_car:
- order projects by last opened :heavy_check_mark:
- add all (git-enabled) subdirectories automatically :heavy_check_mark:
- workspaces :construction:
nvim-telescope