mirror of
				https://github.com/neovim/neovim.git
				synced 2025-11-04 09:44:31 +00:00 
			
		
		
		
	Problem:
  vim._watch.watchdirs has terrible performance.
Solution:
  - On linux use fswatch as a watcher backend if available.
  - Add File watcher section to health:vim.lsp. Warn if watchfunc is
    libuv-poll.
		
	
		
			
				
	
	
		
			82 lines
		
	
	
		
			2.3 KiB
		
	
	
	
		
			Lua
		
	
	
	
	
	
			
		
		
	
	
			82 lines
		
	
	
		
			2.3 KiB
		
	
	
	
		
			Lua
		
	
	
	
	
	
local M = {}
 | 
						|
 | 
						|
local report_info = vim.health.info
 | 
						|
local report_warn = vim.health.warn
 | 
						|
 | 
						|
local function check_log()
 | 
						|
  local log = vim.lsp.log
 | 
						|
  local current_log_level = log.get_level()
 | 
						|
  local log_level_string = log.levels[current_log_level] ---@type string
 | 
						|
  report_info(string.format('LSP log level : %s', log_level_string))
 | 
						|
 | 
						|
  if current_log_level < log.levels.WARN then
 | 
						|
    report_warn(
 | 
						|
      string.format(
 | 
						|
        'Log level %s will cause degraded performance and high disk usage',
 | 
						|
        log_level_string
 | 
						|
      )
 | 
						|
    )
 | 
						|
  end
 | 
						|
 | 
						|
  local log_path = vim.lsp.get_log_path()
 | 
						|
  report_info(string.format('Log path: %s', log_path))
 | 
						|
 | 
						|
  local log_file = vim.uv.fs_stat(log_path)
 | 
						|
  local log_size = log_file and log_file.size or 0
 | 
						|
 | 
						|
  local report_fn = (log_size / 1000000 > 100 and report_warn or report_info)
 | 
						|
  report_fn(string.format('Log size: %d KB', log_size / 1000))
 | 
						|
end
 | 
						|
 | 
						|
local function check_active_clients()
 | 
						|
  vim.health.start('vim.lsp: Active Clients')
 | 
						|
  local clients = vim.lsp.get_clients()
 | 
						|
  if next(clients) then
 | 
						|
    for _, client in pairs(clients) do
 | 
						|
      local attached_to = table.concat(vim.tbl_keys(client.attached_buffers or {}), ',')
 | 
						|
      report_info(
 | 
						|
        string.format(
 | 
						|
          '%s (id=%s, root_dir=%s, attached_to=[%s])',
 | 
						|
          client.name,
 | 
						|
          client.id,
 | 
						|
          vim.fn.fnamemodify(client.root_dir, ':~'),
 | 
						|
          attached_to
 | 
						|
        )
 | 
						|
      )
 | 
						|
    end
 | 
						|
  else
 | 
						|
    report_info('No active clients')
 | 
						|
  end
 | 
						|
end
 | 
						|
 | 
						|
local function check_watcher()
 | 
						|
  vim.health.start('vim.lsp: File watcher')
 | 
						|
  local watchfunc = vim.lsp._watchfiles._watchfunc
 | 
						|
  assert(watchfunc)
 | 
						|
  local watchfunc_name --- @type string
 | 
						|
  if watchfunc == vim._watch.watch then
 | 
						|
    watchfunc_name = 'libuv-watch'
 | 
						|
  elseif watchfunc == vim._watch.watchdirs then
 | 
						|
    watchfunc_name = 'libuv-watchdirs'
 | 
						|
  elseif watchfunc == vim._watch.fswatch then
 | 
						|
    watchfunc_name = 'fswatch'
 | 
						|
  else
 | 
						|
    local nm = debug.getinfo(watchfunc, 'S').source
 | 
						|
    watchfunc_name = string.format('Custom (%s)', nm)
 | 
						|
  end
 | 
						|
 | 
						|
  report_info('File watch backend: ' .. watchfunc_name)
 | 
						|
  if watchfunc_name == 'libuv-watchdirs' then
 | 
						|
    report_warn('libuv-watchdirs has known performance issues. Consider installing fswatch.')
 | 
						|
  end
 | 
						|
end
 | 
						|
 | 
						|
--- Performs a healthcheck for LSP
 | 
						|
function M.check()
 | 
						|
  check_log()
 | 
						|
  check_active_clients()
 | 
						|
  check_watcher()
 | 
						|
end
 | 
						|
 | 
						|
return M
 |