mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-21 17:21:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(fs): add vim.fs.root (#28477)

Browse Source 
vim.fs.root() is a function for finding a project root relative to a
buffer using one or more "root markers". This is useful for LSP and
could be useful for other "projects" designs, as well as for any plugins
which work with a "projects" concept.
This commit is contained in:
Gregory Anders
2024-04-24 21:43:46 -05:00
committed by GitHub
parent 16513b3033
commit 38b9c322c9
6 changed files with 123 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
runtime/lua/vim/lsp.lua
View File

@@ -210,7 +210,7 @@ end
--- vim.lsp.start({
--- name = 'my-server-name',
--- cmd = {'name-of-language-server-executable'},
--- root_dir = vim.fs.dirname(vim.fs.find({'pyproject.toml', 'setup.py'}, { upward = true })[1]),
--- root_dir = vim.fs.root(0, {'pyproject.toml', 'setup.py'}),
--- })
--- ```
---
@@ -219,9 +219,9 @@ end
--- - `name` arbitrary name for the LSP client. Should be unique per language server.
--- - `cmd` command string[] or function, described at |vim.lsp.start_client()|.
--- - `root_dir` path to the project root. By default this is used to decide if an existing client
--- should be re-used. The example above uses |vim.fs.find()| and |vim.fs.dirname()| to detect the
--- root by traversing the file system upwards starting from the current directory until either
--- a `pyproject.toml` or `setup.py` file is found.
--- should be re-used. The example above uses |vim.fs.root()| and |vim.fs.dirname()| to detect
--- the root by traversing the file system upwards starting from the current directory until
--- either a `pyproject.toml` or `setup.py` file is found.
--- - `workspace_folders` list of `{ uri:string, name: string }` tables specifying the project root
--- folders used by the language server. If `nil` the property is derived from `root_dir` for
--- convenience.