docs: how to get package.json parent dir #3506

neovim · Dec 14, 2024 · 3cb6c05 · 3cb6c05
1 parent 4761665
commit 3cb6c05
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/doc/lspconfig.txt b/doc/lspconfig.txt
@@ -298,7 +298,7 @@ below returns a function that takes as its argument the current buffer path.
   containing a `.git` directory. >
    root_dir = util.find_git_ancestor
 - Locate the first parent dir containing a "node_modules" dir: >lua
-  vim.fs.find('node_modules', { path = root_dir, upward = true })[1]
+  vim.fs.dirname(vim.fs.find('node_modules', { path = root_dir, upward = true })[1])
 <
   If you have Nvim 0.10 or newer then >lua
   vim.fs.root(root_dir, "node_modules")
@@ -308,7 +308,7 @@ below returns a function that takes as its argument the current buffer path.
     be removed.
 
 - Locate the first parent dir containing a "package.json" dir: >lua
-  vim.fs.find('package.json', { path = root_dir, upward = true })[1]
+  vim.fs.dirname(vim.fs.find('package.json', { path = root_dir, upward = true })[1])
 <
   If you have Nvim 0.10 or newer then >lua
   vim.fs.root(root_dir, "package.json")

diff --git a/lua/lspconfig/util.lua b/lua/lspconfig/util.lua
@@ -378,17 +378,17 @@ function M.path.exists(filename)
   return stat and stat.type or false
 end
 
---- @deprecated use `vim.fs.find('.hg', { path = startpath, upward = true })[1]` instead
+--- @deprecated use `vim.fs.dirname(vim.fs.find('.hg', { path = startpath, upward = true })[1])` instead
 function M.find_mercurial_ancestor(startpath)
   return vim.fs.dirname(vim.fs.find('.hg', { path = startpath, upward = true })[1])
 end
 
---- @deprecated use `vim.fs.find('node_modules', { path = startpath, upward = true })[1]` instead
+--- @deprecated use `vim.fs.dirname(vim.fs.find('node_modules', { path = startpath, upward = true })[1])` instead
 function M.find_node_modules_ancestor(startpath)
   return vim.fs.dirname(vim.fs.find('node_modules', { path = startpath, upward = true })[1])
 end
 
---- @deprecated use `vim.fs.find('package.json', { path = startpath, upward = true })[1]` instead
+--- @deprecated use `vim.fs.dirname(vim.fs.find('package.json', { path = startpath, upward = true })[1])` instead
 function M.find_package_json_ancestor(startpath)
   return vim.fs.dirname(vim.fs.find('package.json', { path = startpath, upward = true })[1])
 end