https://github.com/ahmedkhalf/lsp-rooter.nvim
lsp-rooter.nvim is a neovim plugin written in lua to change the current working directory to the project's root directory automagically using nvim native lsp.
https://github.com/ahmedkhalf/lsp-rooter.nvim
Last synced: 11 days ago
JSON representation
lsp-rooter.nvim is a neovim plugin written in lua to change the current working directory to the project's root directory automagically using nvim native lsp.
- Host: GitHub
- URL: https://github.com/ahmedkhalf/lsp-rooter.nvim
- Owner: ahmedkhalf
- License: other
- Archived: true
- Created: 2021-05-20T12:17:35.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-13T20:23:38.000Z (almost 4 years ago)
- Last Synced: 2024-11-16T18:34:24.905Z (6 months ago)
- Language: Lua
- Homepage:
- Size: 26.4 KB
- Stars: 75
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
### ⚠️ WARNING ⚠️ This plugin is now deprecated, please use [project.nvim](https://github.com/ahmedkhalf/project.nvim) instead.
# 🌳 lsp-rooter.nvim
**Lsp Rooter** is a neovim plugin written in lua to change the current working directory to the project's root directory automagically using nvim native lsp.
## ✨ Features
- Automagically cd to project directory using nvim lsp
- Dependency free, does not rely on `lspconfig`
- Nvim-tree.lua support/integration
## ⚡️ Requirements
- Neovim >= 0.5.0
## 📦 Installation
Install the plugin with your preferred package manager:
### [vim-plug](https://github.com/junegunn/vim-plug)
```vim
" Vim Script
Plug 'ahmedkhalf/lsp-rooter.nvim'
lua << EOF
require("lsp-rooter").setup {
-- your configuration comes here
-- or leave it empty to use the default settings
-- refer to the configuration section below
}
EOF
```
### [packer](https://github.com/wbthomason/packer.nvim)
```lua
-- Lua
use {
"ahmedkhalf/lsp-rooter.nvim",
config = function()
require("lsp-rooter").setup {
-- your configuration comes here
-- or leave it empty to use the default settings
-- refer to the configuration section below
}
end
}
```
## ⚙️ Configuration
**Lsp Rooter** comes with the following defaults:
```lua
{
-- Table of lsp clients to ignore by name
-- eg: {"efm", ...}
ignore_lsp = {},
}
```
## 🚀 Usage
**Lsp Rooter** works automatically
## 🗒️ TODO
- Support non-LSP projects ([#2](https://github.com/ahmedkhalf/lsp-rooter.nvim/issues/2))
- Add manual control using `:rooter`
## 🤝 Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
---
```
# This project is libre, and licenced under the terms of the
# DO WHAT THE FUCK YOU WANT TO PUBLIC LICENCE, version 3.1,
# as published by dtf, July 2019. See the COPYING file or
# https://ph.dtf.wtf/u/wtfplv31 for more details.
```