An extension for telescope.nvim that allows you to switch between projects.
- telescope.nvim (required)
- telescope-file-browser.nvim (optional, only for
file_browseraction)
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.
The projects picker:
require'telescope'.extensions.project.project{}| 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>) |
o |
change current cd scope |
| 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>) |
<c-o> |
change current cd scope |
* defaults to your git root if used inside a git project, otherwise, it will use your current working directory
| 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}
)| 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' }| 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) |
order_by |
Order projects by asc, desc, recent |
string (default: recent) |
sync_with_nvim_tree |
Sync projects with nvim tree plugin | bool (default: false) |
search_by |
Telescope finder search by field (title/path) | string or table (default: title). Can also be a table {"title", "path"} to search by both title and path |
on_project_selected |
Custom handler when project is selected | function(prompt_bufnr) (default: find project files) |
cd_scope |
Array of cd scopes: tab, window, global |
table (default: {"tab", "window"}) |
| Setup settings can be added when requiring telescope, as shown below: |
require('telescope').setup {
local project_actions = require("telescope._extensions.project.actions")
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",
order_by = "asc",
search_by = "title",
sync_with_nvim_tree = true, -- default false
-- default for on_project_selected = find project files
on_project_selected = function(prompt_bufnr)
-- Do anything you want in here. For example:
project_actions.change_working_directory(prompt_bufnr, false)
require("harpoon.ui").nav_file(1)
end
}
}
}- order projects by last opened ✔️
- add all (git-enabled) subdirectories automatically ✔️
- workspaces 🚧
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent