refactor: deprecate util.path.is_descendant

Work on neovim#2079.

.github/ci/run_sanitizer.sh

@@ -15,7 +15,7 @@ if git diff --pickaxe-all -U0 -G "${SEARCH_PATTERN}" "${REF_BRANCH}" "${PR_BRANC
   exit 1
 fi
 
-SEARCH_PATTERN='(util\.path\.dirname|util\.path\.sanitize|util\.path\.exists|util\.path\.is_file|util\.path\.is_dir|util\.path\.join|util\.path\.iterate_parents|util\.find_mercurial_ancestor|util\.find_node_modules_ancestor|util\.find_package_json_ancestor|util\.find_git_ancestor)'
+SEARCH_PATTERN='(util\.path\.dirname|util\.path\.sanitize|util\.path\.exists|util\.path\.is_file|util\.path\.is_dir|util\.path\.join|util\.path\.iterate_parents|util\.path\.is_descendant|util\.find_mercurial_ancestor|util\.find_node_modules_ancestor|util\.find_package_json_ancestor|util\.find_git_ancestor)'
 
 if git diff --pickaxe-all -U0 -G "${SEARCH_PATTERN}" "${REF_BRANCH}" "${PR_BRANCH}" -- '*.lua' | grep -Ev '\.lua$' | grep -E "^\+.*${SEARCH_PATTERN}" ; then
   echo

lua/lspconfig/configs/intelephense.lua

@@ -1,5 +1,9 @@
 local util = require 'lspconfig.util'
 
+local function is_descendant(root, path)
+  return vim.startswith(vim.fs.normalize(path), vim.fs.normalize(root))
+end
+
 return {
   default_config = {
     cmd = { 'intelephense', '--stdio' },
@@ -9,7 +13,7 @@ return {
       local root = util.root_pattern('composer.json', '.git')(pattern)
 
       -- prefer cwd if root is a descendant
-      return util.path.is_descendant(cwd, root) and cwd or root
+      return is_descendant(cwd, root) and cwd or root
     end,
   },
   docs = {

lua/lspconfig/configs/phan.lua

@@ -1,5 +1,9 @@
 local util = require 'lspconfig.util'
 
+local function is_descendant(root, path)
+  return vim.startswith(vim.fs.normalize(path), vim.fs.normalize(root))
+end
+
 local cmd = {
   'phan',
   '-m',
@@ -23,7 +27,7 @@ return {
       local root = util.root_pattern('composer.json', '.git')(pattern)
 
       -- prefer cwd if root is a descendant
-      return util.path.is_descendant(cwd, root) and cwd or root
+      return is_descendant(cwd, root) and cwd or root
     end,
   },
   docs = {

lua/lspconfig/configs/phpactor.lua

@@ -1,5 +1,9 @@
 local util = require 'lspconfig.util'
 
+local function is_descendant(root, path)
+  return vim.startswith(vim.fs.normalize(path), vim.fs.normalize(root))
+end
+
 return {
   default_config = {
     cmd = { 'phpactor', 'language-server' },
@@ -9,7 +13,7 @@ return {
       local root = util.root_pattern('composer.json', '.git', '.phpactor.json', '.phpactor.yml')(pattern)
 
       -- prefer cwd if root is a descendant
-      return util.path.is_descendant(cwd, root) and cwd or root
+      return is_descendant(cwd, root) and cwd or root
     end,
   },
   docs = {

lua/lspconfig/configs/rust_analyzer.lua

@@ -15,6 +15,10 @@ local function reload_workspace(bufnr)
   end
 end
 
+local function is_descendant(root, path)
+  return vim.startswith(vim.fs.normalize(path), vim.fs.normalize(root))
+end
+
 local function is_library(fname)
   local user_home = vim.fs.normalize(vim.env.HOME)
   local cargo_home = os.getenv 'CARGO_HOME' or user_home .. '/.cargo'
@@ -25,7 +29,7 @@ local function is_library(fname)
   local toolchains = rustup_home .. '/toolchains'
 
   for _, item in ipairs { toolchains, registry, git_registry } do
-    if util.path.is_descendant(item, fname) then
+    if is_descendant(item, fname) then
       local clients = util.get_lsp_clients { name = 'rust_analyzer' }
       return #clients > 0 and clients[#clients].config.root_dir or nil
     end

lua/lspconfig/configs/smarty_ls.lua

@@ -1,5 +1,9 @@
 local util = require 'lspconfig.util'
 
+local function is_descendant(root, path)
+  return vim.startswith(vim.fs.normalize(path), vim.fs.normalize(root))
+end
+
 return {
   default_config = {
     cmd = { 'smarty-language-server', '--stdio' },
@@ -9,7 +13,7 @@ return {
       local root = util.root_pattern('composer.json', '.git')(pattern)
 
       -- prefer cwd if root is a descendant
-      return util.path.is_descendant(cwd, root) and cwd or root
+      return is_descendant(cwd, root) and cwd or root
     end,
     settings = {
       smarty = {

lua/lspconfig/util.lua

@@ -127,23 +127,8 @@ M.path = (function()
     end
   end
 
-  local function is_descendant(root, path)
-    if not path then
-      return false
-    end
-
-    local function cb(dir, _)
-      return dir == root
-    end
-
-    local dir, _ = traverse_parents(path, cb)
-
-    return dir == root
-  end
-
   return {
     traverse_parents = traverse_parents,
-    is_descendant = is_descendant,
   }
 end)()
 
@@ -348,6 +333,11 @@ M.path.path_separator = vim.fn.has('win32') == 1 and ';' or ':'
 --- @deprecated use `vim.fs.parents(path)` instead
 M.path.iterate_parents = vim.fs.parents
 
+--- @deprecated use `vim.startswith(vim.fs.normalize(path), vim.fs.normalize(root))` instead
+function M.path.is_descendant(root, path)
+  return vim.startswith(vim.fs.normalize(path), vim.fs.normalize(root))
+end
+
 --- @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])